|
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.nio.ByteBufferReadBuffer.ByteBufferInput
public final class ByteBufferReadBuffer.ByteBufferInput
This is a simple implementation of the BufferInput interface on top of a ByteBuffer.
Field Summary | |
---|---|
protected ByteBuffer |
m_buf The ByteBuffer object from which data is read. |
Constructor Summary | |
---|---|
ByteBufferReadBuffer.ByteBufferInput(ByteBuffer buf) Default constructor. |
Method Summary | |
---|---|
protected void |
adjustOffsetInternal(int cb) Adjust the internal stream offset. |
int |
available() Returns the number of bytes that can be read (or skipped over) from this input stream without causing a blocking I/O condition to occur. This method reflects the assumed implementation of various buffering InputStreams, which can guarantee non-blocking reads up to the extent of their buffers, but beyond that the read operations will have to read from some underlying (and potentially blocking) source. |
protected String |
convertUTF(int of, int cb) Convert a UTF-8 encoded section of the binary stream into a String. |
ByteBuffer |
getByteBuffer() Obtain the ByteBuffer that this ReadBuffer is based on. |
int |
getOffset() Determine the current offset of this BufferInput within the underlying ReadBuffer. |
void |
mark(int cbReadLimit) Marks the current read position in the InputStream in order to support the stream to be later "rewound" (using the InputStreaming.reset() method) to the current position. The caller passes in the maximum number of bytes that it expects to read before calling the InputStreaming.reset() method, thus indicating the upper bounds of the responsibility of the stream to be able to buffer what it has read in order to support this functionality. |
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[] abDest, int ofDest, int cbDest) 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. |
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 |
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 |
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 |
setOffsetInternal(int of) Update the internal stream offset. |
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. |
Methods inherited from class com.tangosol.io.AbstractReadBuffer.AbstractBufferInput |
---|
close, getBuffer, getCharBuf, getMarkInternal, markSupported, read, readBoolean, readBuffer, readFully, readFully, readLine, readPackedInt, readPackedLong, readSafeUTF, readUnsignedByte, readUTF, readUTF, setMarkInternal, setOffset, skip |
Methods inherited from interface com.tangosol.io.ReadBuffer.BufferInput |
---|
close, getBuffer, markSupported, readBoolean, readBuffer, readFully, readFully, readLine, readPackedInt, readPackedLong, readSafeUTF, readUnsignedByte, readUTF, setOffset |
Methods inherited from interface com.tangosol.io.InputStreaming |
---|
read, skip |
Field Detail |
---|
protected ByteBuffer m_buf
Constructor Detail |
---|
public ByteBufferReadBuffer.ByteBufferInput(ByteBuffer buf)
Method Detail |
---|
public ByteBuffer getByteBuffer()
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[] abDest, int ofDest, int cbDest) 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
abDest
- the array to store the bytes which are read from the streamofDest
- the offset into the array that the read bytes will be storedcbDest
- 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 mark(int cbReadLimit)
InputStreaming.reset()
method) to the current position. The caller passes in the maximum number of bytes that it expects to read before calling the InputStreaming.reset()
method, thus indicating the upper bounds of the responsibility of the stream to be able to buffer what it has read in order to support this functionality.mark
in interface InputStreaming
mark
in interface ReadBuffer.BufferInput
mark
in class AbstractReadBuffer.AbstractBufferInput
cbReadLimit
- the maximum number of bytes that caller expects the InputStream to be able to read before the mark position becomes invalidpublic 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 available() throws IOException
available
in interface InputStreaming
available
in interface ReadBuffer.BufferInput
available
in class AbstractReadBuffer.AbstractBufferInput
IOException
- if an I/O error occurspublic 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 int getOffset()
getOffset
in interface ReadBuffer.BufferInput
getOffset
in class AbstractReadBuffer.AbstractBufferInput
public void setOffsetInternal(int of)
setOffsetInternal
in class AbstractReadBuffer.AbstractBufferInput
of
- the new offsetprotected void adjustOffsetInternal(int cb)
adjustOffsetInternal
in class AbstractReadBuffer.AbstractBufferInput
cb
- the number of bytes that were writtenprotected String convertUTF(int of, int cb) throws IOException
convertUTF
in class AbstractReadBuffer.AbstractBufferInput
of
- the offset within the streamcb
- the length in bytes within the streamIOException
|
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 |