|
CoherenceTM v3.3 Copyright© 2000-2007 by Oracle Corporation |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.io.InputStream
com.tangosol.io.AbstractReadBuffer.AbstractBufferInput
com.tangosol.io.nio.ByteBufferReadBuffer.ByteBufferInput
public 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 | |
---|---|
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. |
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 readlimit)
Marks the current read position in the InputStream in order to support the stream to be later "rewound" (using the AbstractReadBuffer.AbstractBufferInput.reset()
method) to the current position. |
int |
read()
Read the next byte of data from the InputStream. |
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 . |
ReadBuffer |
readBuffer(int cb)
Read cb bytes and return them as a ReadBuffer object. |
byte |
readByte()
Read a byte value. |
char |
readChar()
Read a char value. |
double |
readDouble()
Read a double value. |
float |
readFloat()
Read a float value. |
int |
readInt()
Read an int value. |
long |
readLong()
Read a long value. |
short |
readShort()
Read a short value. |
int |
readUnsignedShort()
Read an unsigned short value. |
void |
reset()
Rewind this stream to the position at the time the AbstractReadBuffer.AbstractBufferInput.mark(int)
method was last called on this InputStream. |
void |
setOffsetInternal(int of)
Update the internal stream offset. |
Methods inherited from class com.tangosol.io.AbstractReadBuffer.AbstractBufferInput |
---|
close, getBuffer, getCharBuf, getMarkInternal, markSupported, read, readBoolean, readFully, readFully, readLine, readPackedInt, readPackedLong, readSafeUTF, readUnsignedByte, readUTF, readUTF, setMarkInternal, setOffset, skip, skipBytes |
Methods inherited from interface com.tangosol.io.ReadBuffer.BufferInput |
---|
close, getBuffer, markSupported, readPackedInt, readPackedLong, readSafeUTF, setOffset |
Methods inherited from interface com.tangosol.io.InputStreaming |
---|
read, skip |
Methods inherited from interface java.io.DataInput |
---|
readBoolean, readFully, readFully, readLine, readUnsignedByte, readUTF, skipBytes |
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 reached
IOException
- 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 reached
IOException
- if an I/O error occurspublic void mark(int readlimit)
AbstractReadBuffer.AbstractBufferInput.reset()
method) to the current position. The caller passes in the maximum
number of bytes that it expects to read before calling the
AbstractReadBuffer.AbstractBufferInput.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.
BufferInput implementations ignore the cbReadLimit
;
they must support an unlimited read limit, since they appear to the
user as an input stream on top of a fully realized read buffer.
mark
in interface InputStreaming
mark
in interface ReadBuffer.BufferInput
mark
in class AbstractReadBuffer.AbstractBufferInput
readlimit
- 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
AbstractReadBuffer.AbstractBufferInput.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
BufferInput implementations must implement this method to return the extent of the buffer that has not yet been read; in other words, the entire un-read portion of the buffer must be available.
available
in interface InputStreaming
available
in interface ReadBuffer.BufferInput
available
in class AbstractReadBuffer.AbstractBufferInput
IOException
- if an I/O error occurspublic byte readByte() throws IOException
This method is the counterpart for the
DataOutput.writeByte(int)
method.
readByte
in interface DataInput
readByte
in class AbstractReadBuffer.AbstractBufferInput
byte
value
EOFException
- if the value could not be read because no
more data remains to be read
IOException
- if an I/O error occurspublic short readShort() throws IOException
This method is the counterpart for the
DataOutput.writeShort(int)
method.
readShort
in interface DataInput
readShort
in class AbstractReadBuffer.AbstractBufferInput
short
value
EOFException
- if the value could not be read because no
more data remains to be read
IOException
- 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 DataInput
readUnsignedShort
in class AbstractReadBuffer.AbstractBufferInput
int
value in the range of 0x0000 to 0xFFFF
EOFException
- if the value could not be read because no
more data remains to be read
IOException
- if an I/O error occurspublic char readChar() throws IOException
This method is the counterpart for the
DataOutput.writeChar(int)
method.
readChar
in interface DataInput
readChar
in class AbstractReadBuffer.AbstractBufferInput
char
value
EOFException
- if the value could not be read because no
more data remains to be read
IOException
- if an I/O error occurspublic int readInt() throws IOException
This method is the counterpart for the
DataOutput.writeInt(int)
method.
readInt
in interface DataInput
readInt
in class AbstractReadBuffer.AbstractBufferInput
int
value
EOFException
- if the value could not be read because no
more data remains to be read
IOException
- if an I/O error occurspublic long readLong() throws IOException
This method is the counterpart for the
DataOutput.writeLong(long)
method.
readLong
in interface DataInput
readLong
in class AbstractReadBuffer.AbstractBufferInput
long
value
EOFException
- if the value could not be read because no
more data remains to be read
IOException
- if an I/O error occurspublic float readFloat() throws IOException
This method is the counterpart for the
DataOutput.writeFloat(float)
method.
readFloat
in interface DataInput
readFloat
in class AbstractReadBuffer.AbstractBufferInput
float
value
EOFException
- if the value could not be read because no
more data remains to be read
IOException
- if an I/O error occurspublic double readDouble() throws IOException
This method is the counterpart for the
DataOutput.writeDouble(double)
method.
readDouble
in interface DataInput
readDouble
in class AbstractReadBuffer.AbstractBufferInput
double
value
EOFException
- if the value could not be read because no
more data remains to be read
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 read
cb
bytes read
from the BufferInput
EOFException
- if the stream is exhausted before
the number of bytes indicated could be read
IOException
- 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 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 stream
IOException
|
CoherenceTM v3.3 Copyright© 2000-2007 by Oracle Corporation |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |