public static interface ReadBuffer.BufferInput extends InputStreaming, DataInput
Modifier and Type | Method and Description |
---|---|
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.
|
ReadBuffer |
getBuffer()
Get the ReadBuffer object that this BufferInput is reading from.
|
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. |
boolean |
markSupported()
Determine if this InputStream supports the
mark(int) and InputStreaming.reset() methods. |
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 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.
|
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.
|
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.
|
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 com.oracle.common.io.InputStreaming
IOException
- if an I/O error occursvoid close() throws IOException
BufferInput implementations do not pass this call down onto an underlying stream, if any.
close
in interface com.oracle.common.io.InputStreaming
IOException
- if an I/O error occursvoid 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.
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 com.oracle.common.io.InputStreaming
cbReadLimit
- the maximum number of bytes that caller expects the InputStream to be able to read before the mark position becomes invalidboolean markSupported()
mark(int)
and InputStreaming.reset()
methods.
BufferInput implementations must support the mark(int)
and InputStreaming.reset()
methods, so this method always returns true
.
markSupported
in interface com.oracle.common.io.InputStreaming
true
if this InputStream supports the mark and reset method; false
otherwisevoid 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 streamNullPointerException
- if the passed array is nullEOFException
- if the stream is exhausted before the number of bytes indicated by the array length could be readIOException
- if an I/O error occursvoid 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 readNullPointerException
- if the passed array is nullIndexOutOfBoundsException
- 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 readIOException
- if an I/O error occursint skipBytes(int cb) throws IOException
skipBytes
in interface DataInput
cb
- the maximum number of bytes to skip overIOException
- if an I/O error occursboolean 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 readIOException
- if an I/O error occursbyte readByte() throws IOException
This method is the counterpart for the DataOutput.writeByte(int)
method.
readByte
in interface DataInput
byte
valueEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occursint 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 0xFFEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occursshort readShort() throws IOException
This method is the counterpart for the DataOutput.writeShort(int)
method.
readShort
in interface DataInput
short
valueEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occursint 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 0xFFFFEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occurschar readChar() throws IOException
This method is the counterpart for the DataOutput.writeChar(int)
method.
readChar
in interface DataInput
char
valueEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occursint readInt() throws IOException
This method is the counterpart for the DataOutput.writeInt(int)
method.
readInt
in interface DataInput
int
valueEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occurslong readLong() throws IOException
This method is the counterpart for the DataOutput.writeLong(long)
method.
readLong
in interface DataInput
long
valueEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occursfloat readFloat() throws IOException
This method is the counterpart for the DataOutput.writeFloat(float)
method.
readFloat
in interface DataInput
float
valueEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occursdouble readDouble() throws IOException
This method is the counterpart for the DataOutput.writeDouble(double)
method.
readDouble
in interface DataInput
double
valueEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occursString 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 (which it has been in java.io.DataInputStream).
readLine
in interface DataInput
IOException
- if an I/O error occurs.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 stringEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occursReadBuffer getBuffer()
String readSafeUTF() throws IOException
IOException
- if an I/O error occursint readPackedInt() throws IOException
WriteBuffer.BufferOutput.writePackedInt(int)
.IOException
- if an I/O error occurslong readPackedLong() throws IOException
WriteBuffer.BufferOutput.writePackedLong(long)
.IOException
- if an I/O error occursReadBuffer readBuffer(int cb) throws IOException
cb
bytes and return them as a ReadBuffer object.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 occursint getOffset()
void setOffset(int of)
of
- the offset of the next byte to read from the ReadBufferIndexOutOfBoundsException
- if of < 0
or of > getBuffer().length()