|
Oracle® Coherence Java API Reference Release 3.6.0.0 E15725-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
java.io.InputStream
com.tangosol.io.AbstractReadBuffer.AbstractBufferInput
com.tangosol.io.MultiBufferReadBuffer.MultiBufferInput
public final class MultiBufferReadBuffer.MultiBufferInput
An implementation of the BufferInput interface that is backed by a series of the underlying ReadBuffer BufferInput objects.
Field Summary | |
---|---|
protected boolean |
m_fDestructive True if the BufferInput set to self-destruct. |
Constructor Summary | |
---|---|
MultiBufferReadBuffer.MultiBufferInput() Default constructor. |
|
MultiBufferReadBuffer.MultiBufferInput(boolean fDestructive) Default constructor. |
Method Summary | |
---|---|
protected ReadBuffer.BufferInput |
getIn() Obtain the underlying BufferOutput. |
int |
read() Read the next byte of data from the InputStream. The value byte is returned as an int in the range 0 to 255 . If the end of the stream has been reached, the value -1 is returned.
This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. |
int |
read(byte[] ab, int of, int cb) Read up to cb bytes from the input stream and store them into the passed array ab starting at offset of . The number of bytes actually read is returned.
This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. |
ReadBuffer |
readBuffer(int cb) Read cb bytes and return them as a ReadBuffer object. |
byte |
readByte() Read a byte value. This method is the counterpart for the |
char |
readChar() Read a char value. This method is the counterpart for the |
double |
readDouble() Read a double value. This method is the counterpart for the |
float |
readFloat() Read a float value. This method is the counterpart for the |
int |
readInt() Read an int value. This method is the counterpart for the |
long |
readLong() Read a long value. This method is the counterpart for the |
int |
readPackedInt() Read an int value using a variable-length storage format as described by WriteBuffer.BufferOutput.writePackedInt(int) . |
long |
readPackedLong() Read a long value using a variable-length storage format as described by WriteBuffer.BufferOutput.writePackedLong(long) . |
String |
readSafeUTF() Read a variable-length encoded UTF packed String. The major differences between this implementation and DataInput is that this supports null String values and is not limited to 64KB UTF-encoded values. |
short |
readShort() Read a short value. This method is the counterpart for the |
int |
readUnsignedShort() Read an unsigned short value. This method is the counterpart for the |
String |
readUTF() Reads a String value. This method is the counterpart for the |
void |
reset() Rewind this stream to the position at the time the InputStreaming.mark(int) method was last called on this InputStream. If the InputStream cannot fulfill this contract, it should throw an IOException. |
void |
setOffset(int of) Specify the offset of the next byte to read from the underlying ReadBuffer. |
int |
skipBytes(int cb) Skips over up to the specified number of bytes of data. The number of bytes actually skipped over may be fewer than the number specified to skip, and may even be zero; this can be caused by an end-of-file condition, but can also occur even when there is data remaining to be read. As a result, the caller should check the return value from this method, which indicates the actual number of bytes skipped. |
protected void |
sync() After traversing an underlying WriteBuffer boundary, or otherwise changing the offset significantly, sync between this BufferOutput's absolute position and an underlying BufferOutput's relative position. |
Methods inherited from class com.tangosol.io.AbstractReadBuffer.AbstractBufferInput |
---|
adjustOffsetInternal, available, close, convertUTF, getBuffer, getCharBuf, getMarkInternal, getOffset, mark, markSupported, read, readBoolean, readFully, readFully, readLine, readUnsignedByte, readUTF, setMarkInternal, setOffsetInternal, skip |
Field Detail |
---|
protected boolean m_fDestructive
Constructor Detail |
---|
public MultiBufferReadBuffer.MultiBufferInput()
public MultiBufferReadBuffer.MultiBufferInput(boolean fDestructive)
fDestructive
- true iff the stream should self-destruct as it is advancedMethod Detail |
---|
public int read() throws IOException
int
in the range 0
to 255
. If the end of the stream has been reached, the value -1
is returned.
This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.
read
in interface InputStreaming
read
in class AbstractReadBuffer.AbstractBufferInput
-1
if the end of the stream has been reachedIOException
- if an I/O error occurspublic int read(byte[] ab, int of, int cb) throws IOException
cb
bytes from the input stream and store them into the passed array ab
starting at offset of
. The number of bytes actually read is returned.
This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.
read
in interface InputStreaming
read
in class AbstractReadBuffer.AbstractBufferInput
ab
- the array to store the bytes which are read from the streamof
- the offset into the array that the read bytes will be storedcb
- the maximum number of bytes to read-1
if no bytes were read from the stream because the end of the stream had been reachedIOException
- if an I/O error occurspublic void reset() throws IOException
InputStreaming.mark(int)
method was last called on this InputStream. If the InputStream cannot fulfill this contract, it should throw an IOException.reset
in interface InputStreaming
reset
in class AbstractReadBuffer.AbstractBufferInput
IOException
- if an I/O error occurs, for example if this has not been marked or if the mark has been invalidatedpublic int skipBytes(int cb) throws IOException
skipBytes
in interface ReadBuffer.BufferInput
skipBytes
in interface DataInput
skipBytes
in class AbstractReadBuffer.AbstractBufferInput
cb
- the maximum number of bytes to skip overIOException
- if an I/O error occurspublic byte readByte() throws IOException
This method is the counterpart for the DataOutput.writeByte(int)
method.
readByte
in interface ReadBuffer.BufferInput
readByte
in interface DataInput
readByte
in class AbstractReadBuffer.AbstractBufferInput
byte
valueEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occurspublic short readShort() throws IOException
This method is the counterpart for the DataOutput.writeShort(int)
method.
readShort
in interface ReadBuffer.BufferInput
readShort
in interface DataInput
readShort
in class AbstractReadBuffer.AbstractBufferInput
short
valueEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occurspublic int readUnsignedShort() throws IOException
This method is the counterpart for the DataOutput.writeShort(int)
method when it is used with unsigned 16-bit values.
readUnsignedShort
in interface ReadBuffer.BufferInput
readUnsignedShort
in interface DataInput
readUnsignedShort
in class AbstractReadBuffer.AbstractBufferInput
int
value in the range of 0x0000 to 0xFFFFEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occurspublic char readChar() throws IOException
This method is the counterpart for the DataOutput.writeChar(int)
method.
readChar
in interface ReadBuffer.BufferInput
readChar
in interface DataInput
readChar
in class AbstractReadBuffer.AbstractBufferInput
char
valueEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occurspublic int readInt() throws IOException
This method is the counterpart for the DataOutput.writeInt(int)
method.
readInt
in interface ReadBuffer.BufferInput
readInt
in interface DataInput
readInt
in class AbstractReadBuffer.AbstractBufferInput
int
valueEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occurspublic long readLong() throws IOException
This method is the counterpart for the DataOutput.writeLong(long)
method.
readLong
in interface ReadBuffer.BufferInput
readLong
in interface DataInput
readLong
in class AbstractReadBuffer.AbstractBufferInput
long
valueEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occurspublic float readFloat() throws IOException
This method is the counterpart for the DataOutput.writeFloat(float)
method.
readFloat
in interface ReadBuffer.BufferInput
readFloat
in interface DataInput
readFloat
in class AbstractReadBuffer.AbstractBufferInput
float
valueEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occurspublic double readDouble() throws IOException
This method is the counterpart for the DataOutput.writeDouble(double)
method.
readDouble
in interface ReadBuffer.BufferInput
readDouble
in interface DataInput
readDouble
in class AbstractReadBuffer.AbstractBufferInput
double
valueEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occurspublic String readUTF() throws IOException
This method is the counterpart for the DataOutput.writeUTF(java.lang.String)
method.
readUTF
in interface ReadBuffer.BufferInput
readUTF
in interface DataInput
readUTF
in class AbstractReadBuffer.AbstractBufferInput
UTFDataFormatException
- if the bytes that were read were not a valid UTF-8 encoded stringEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occurspublic String readSafeUTF() throws IOException
readSafeUTF
in interface ReadBuffer.BufferInput
readSafeUTF
in class AbstractReadBuffer.AbstractBufferInput
IOException
- if an I/O error occurspublic int readPackedInt() throws IOException
WriteBuffer.BufferOutput.writePackedInt(int)
.readPackedInt
in interface ReadBuffer.BufferInput
readPackedInt
in class AbstractReadBuffer.AbstractBufferInput
IOException
- if an I/O error occurspublic long readPackedLong() throws IOException
WriteBuffer.BufferOutput.writePackedLong(long)
.readPackedLong
in interface ReadBuffer.BufferInput
readPackedLong
in class AbstractReadBuffer.AbstractBufferInput
IOException
- if an I/O error occurspublic ReadBuffer readBuffer(int cb) throws IOException
cb
bytes and return them as a ReadBuffer object.readBuffer
in interface ReadBuffer.BufferInput
readBuffer
in class AbstractReadBuffer.AbstractBufferInput
cb
- the number of bytes to readcb
bytes read from the BufferInputEOFException
- if the stream is exhausted before the number of bytes indicated could be readIOException
- if an I/O error occurspublic void setOffset(int of)
setOffset
in interface ReadBuffer.BufferInput
setOffset
in class AbstractReadBuffer.AbstractBufferInput
of
- the offset of the next byte to read from the ReadBufferprotected ReadBuffer.BufferInput getIn()
protected void sync()
|
Oracle® Coherence Java API Reference Release 3.6.0.0 E15725-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |