|
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
public class AbstractReadBuffer.AbstractBufferInput
This is an implementation of the BufferInput interface that delegates its work back to its ReadBuffer.
This implementation extends InputStream, but only so that it can be passed to anything that takes an InputStream.
Constructor Summary | |
---|---|
AbstractReadBuffer.AbstractBufferInput()
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. |
void |
close()
Close the InputStream and release any system resources associated with it. |
protected String |
convertUTF(int of,
int cb)
Convert a UTF-8 encoded section of the binary stream into a String. |
ReadBuffer |
getBuffer()
Get the ReadBuffer object that this BufferInput is reading from. |
protected char[] |
getCharBuf(int cchMax)
Obtain a temp buffer used to avoid allocations when building Strings from UTF binary data. |
protected int |
getMarkInternal()
Obtain the offset of the stream mark. |
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 reset()
method) to the current position. |
boolean |
markSupported()
Determine if this InputStream supports the mark(int) and
reset() methods. |
int |
read()
Read the next byte of data from the InputStream. |
int |
read(byte[] ab)
Read some number of bytes from the input stream and store them into the passed array ab . |
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 . |
boolean |
readBoolean()
Read a boolean value. |
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. |
void |
readFully(byte[] ab)
Read ab.length bytes and store them in
ab . |
void |
readFully(byte[] ab,
int of,
int cb)
Read cb bytes and store them in ab
starting at offset of . |
int |
readInt()
Read an int value. |
String |
readLine()
Reads the next "line" of text. |
long |
readLong()
Read a long value. |
int |
readPackedInt()
Read an int value using a variable-length storage-format. |
long |
readPackedLong()
Read a long value using a variable-length storage-format. |
String |
readSafeUTF()
Read a variable-length encoded UTF packed String. |
short |
readShort()
Read a short value. |
int |
readUnsignedByte()
Read an unsigned byte value. |
int |
readUnsignedShort()
Read an unsigned short value. |
String |
readUTF()
Reads a String value. |
protected String |
readUTF(int cb)
Reads the specified-lenth UTF data and converts it to a String value. |
void |
reset()
Rewind this stream to the position at the time the mark(int)
method was last called on this InputStream. |
protected void |
setMarkInternal(int of)
Update the internal stream mark. |
void |
setOffset(int of)
Specify the offset of the next byte to read from the underlying ReadBuffer. |
protected void |
setOffsetInternal(int of)
Update the internal stream offset. |
long |
skip(long cb)
Skips over up to the specified number of bytes of data from this InputStream. |
int |
skipBytes(int cb)
Skips over up to the specified number of bytes of data. |
Constructor Detail |
---|
public AbstractReadBuffer.AbstractBufferInput()
Method 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 InputStream
-1
if the end of
the stream has been reached
IOException
- if an I/O error occurspublic int read(byte[] ab) throws IOException
ab
. 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 InputStream
ab
- the array to store the bytes which are read from the
stream
-1
if no bytes were read from the stream
because the end of the stream had been reached
NullPointerException
- if the passed array is null
IOException
- 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 InputStream
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 reached
NullPointerException
- if the passed array is null
IndexOutOfBoundsException
- if of
or
cb
is negative, or of+cb
is
greater than the length of the ab
IOException
- if an I/O error occurspublic long skip(long cb) throws IOException
skip
in interface InputStreaming
skip
in class InputStream
cb
- the maximum number of bytes to skip over
IOException
- if an I/O error occurspublic 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 InputStream
IOException
- if an I/O error occurspublic void close() throws IOException
BufferInput implementations do not pass this call down onto an underlying stream, if any.
close
in interface InputStreaming
close
in interface ReadBuffer.BufferInput
close
in interface Closeable
close
in class InputStream
IOException
- if an I/O error occurspublic void mark(int cbReadLimit)
reset()
method) to the current position. The caller passes in the maximum
number of bytes that it expects to read before calling the
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 InputStream
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
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 InputStream
IOException
- if an I/O error occurs, for example if this
has not been marked or if the mark has been
invalidatedpublic boolean markSupported()
mark(int)
and
reset()
methods.
BufferInput implementations must support the mark(int)
and reset()
methods, so this method always returns
true
.
markSupported
in interface InputStreaming
markSupported
in interface ReadBuffer.BufferInput
markSupported
in class InputStream
true
if this InputStream supports the mark
and reset method; false
otherwisepublic void readFully(byte[] ab) throws IOException
ab.length
bytes and store them in
ab
.
This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.
readFully
in interface DataInput
ab
- the array to store the bytes which are read from the
stream
NullPointerException
- if the passed array is null
EOFException
- if the stream is exhausted before the
number
of bytes indicated by the array length could be read
IOException
- if an I/O error occurspublic void readFully(byte[] ab, int of, int cb) throws IOException
cb
bytes and store them in ab
starting at offset of
.
This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.
readFully
in interface DataInput
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
NullPointerException
- if the passed array is null
IndexOutOfBoundsException
- if of
or
cb
is negative, or of+cb
is
greater than the length of the ab
EOFException
- if the stream is exhausted before the
number of bytes indicated by the array length could be
read
IOException
- if an I/O error occurspublic int skipBytes(int cb) throws IOException
skipBytes
in interface DataInput
cb
- the maximum number of bytes to skip over
IOException
- if an I/O error occurspublic boolean readBoolean() throws IOException
This method is the counterpart for the
DataOutput.writeBoolean(boolean)
method.
readBoolean
in interface DataInput
true
or false
EOFException
- if the value could not be read because no
more data remains to be read
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
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 int readUnsignedByte() throws IOException
This method is the counterpart for the
DataOutput.writeByte(int)
method when it is used with
unsigned 8-bit values.
readUnsignedByte
in interface DataInput
int
value in the range 0x00 to 0xFF
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
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
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
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
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
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
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
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 String readLine() throws IOException
This method does not have a counterpart in the
DataOutput
interface. Furthermore, this method is
defined as operating on bytes and not on characters, and thus it
should be selected for use only after careful consideration, as if
it were deprecated.
readLine
in interface DataInput
IOException
- if an I/O error occurs.public String readUTF() throws IOException
This method is the counterpart for the
DataOutput.writeUTF(java.lang.String)
method.
readUTF
in interface DataInput
UTFDataFormatException
- if the bytes that were
read were not
a valid UTF-8 encoded string
EOFException
- if the value could not be read because no
more data remains to be read
IOException
- if an I/O error occurspublic ReadBuffer getBuffer()
getBuffer
in interface ReadBuffer.BufferInput
public String readSafeUTF() throws IOException
readSafeUTF
in interface ReadBuffer.BufferInput
IOException
- if an I/O error occurspublic int readPackedInt() throws IOException
readPackedInt
in interface ReadBuffer.BufferInput
IOException
- if an I/O error occurspublic long readPackedLong() throws IOException
readPackedLong
in interface ReadBuffer.BufferInput
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
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
public void setOffset(int of)
setOffset
in interface ReadBuffer.BufferInput
of
- the offset of the next byte to read from the ReadBufferprotected void setOffsetInternal(int of)
of
- the new offsetprotected int getMarkInternal()
protected void setMarkInternal(int of)
of
- the offset of the new markprotected char[] getCharBuf(int cchMax)
cchMax
- the length that the String will not exceed
protected String readUTF(int cb) throws IOException
cb
- the number of bytes that the UTF data takes up in the
stream; a value less than zero indicates a null value
UTFDataFormatException
- if the bytes that were
read were not
a valid UTF-8 encoded string
EOFException
- if the value could not be read because no
more data remains to be read
IOException
- if an I/O error occursprotected String convertUTF(int of, int cb) throws IOException
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 |