|
Oracle® Coherence Java API Reference Release 12.1.2.0.3 E26043-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public static interface ReadBuffer.BufferInput
The BufferInput interface represents a DataInputStream on top of a ReadBuffer.
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. |
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. |
java.lang.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) . |
java.lang.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. |
java.lang.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. |
Methods inherited from interface com.oracle.common.io.InputStreaming |
---|
read, read, read, reset, skip |
Method Detail |
---|
int available() throws java.io.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
java.io.IOException
- if an I/O error occursvoid close() throws java.io.IOException
BufferInput implementations do not pass this call down onto an underlying stream, if any.
close
in interface com.oracle.common.io.InputStreaming
java.io.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 java.io.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 java.io.DataInput
ab
- the array to store the bytes which are read from the streamjava.lang.NullPointerException
- if the passed array is nulljava.io.EOFException
- if the stream is exhausted before the number of bytes indicated by the array length could be readjava.io.IOException
- if an I/O error occursvoid readFully(byte[] ab, int of, int cb) throws java.io.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 java.io.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 readjava.lang.NullPointerException
- if the passed array is nulljava.lang.IndexOutOfBoundsException
- if of
or cb
is negative, or of+cb
is greater than the length of the ab
java.io.EOFException
- if the stream is exhausted before the number of bytes indicated by the array length could be readjava.io.IOException
- if an I/O error occursint skipBytes(int cb) throws java.io.IOException
skipBytes
in interface java.io.DataInput
cb
- the maximum number of bytes to skip overjava.io.IOException
- if an I/O error occursboolean readBoolean() throws java.io.IOException
This method is the counterpart for the DataOutput.writeBoolean(boolean)
method.
readBoolean
in interface java.io.DataInput
true
or false
java.io.EOFException
- if the value could not be read because no more data remains to be readjava.io.IOException
- if an I/O error occursbyte readByte() throws java.io.IOException
This method is the counterpart for the DataOutput.writeByte(int)
method.
readByte
in interface java.io.DataInput
byte
valuejava.io.EOFException
- if the value could not be read because no more data remains to be readjava.io.IOException
- if an I/O error occursint readUnsignedByte() throws java.io.IOException
This method is the counterpart for the DataOutput.writeByte(int)
method when it is used with unsigned 8-bit values.
readUnsignedByte
in interface java.io.DataInput
int
value in the range 0x00 to 0xFFjava.io.EOFException
- if the value could not be read because no more data remains to be readjava.io.IOException
- if an I/O error occursshort readShort() throws java.io.IOException
This method is the counterpart for the DataOutput.writeShort(int)
method.
readShort
in interface java.io.DataInput
short
valuejava.io.EOFException
- if the value could not be read because no more data remains to be readjava.io.IOException
- if an I/O error occursint readUnsignedShort() throws java.io.IOException
This method is the counterpart for the DataOutput.writeShort(int)
method when it is used with unsigned 16-bit values.
readUnsignedShort
in interface java.io.DataInput
int
value in the range of 0x0000 to 0xFFFFjava.io.EOFException
- if the value could not be read because no more data remains to be readjava.io.IOException
- if an I/O error occurschar readChar() throws java.io.IOException
This method is the counterpart for the DataOutput.writeChar(int)
method.
readChar
in interface java.io.DataInput
char
valuejava.io.EOFException
- if the value could not be read because no more data remains to be readjava.io.IOException
- if an I/O error occursint readInt() throws java.io.IOException
This method is the counterpart for the DataOutput.writeInt(int)
method.
readInt
in interface java.io.DataInput
int
valuejava.io.EOFException
- if the value could not be read because no more data remains to be readjava.io.IOException
- if an I/O error occurslong readLong() throws java.io.IOException
This method is the counterpart for the DataOutput.writeLong(long)
method.
readLong
in interface java.io.DataInput
long
valuejava.io.EOFException
- if the value could not be read because no more data remains to be readjava.io.IOException
- if an I/O error occursfloat readFloat() throws java.io.IOException
This method is the counterpart for the DataOutput.writeFloat(float)
method.
readFloat
in interface java.io.DataInput
float
valuejava.io.EOFException
- if the value could not be read because no more data remains to be readjava.io.IOException
- if an I/O error occursdouble readDouble() throws java.io.IOException
This method is the counterpart for the DataOutput.writeDouble(double)
method.
readDouble
in interface java.io.DataInput
double
valuejava.io.EOFException
- if the value could not be read because no more data remains to be readjava.io.IOException
- if an I/O error occursjava.lang.String readLine() throws java.io.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 java.io.DataInput
java.io.IOException
- if an I/O error occurs.java.lang.String readUTF() throws java.io.IOException
This method is the counterpart for the DataOutput.writeUTF(java.lang.String)
method.
readUTF
in interface java.io.DataInput
java.io.UTFDataFormatException
- if the bytes that were read were not a valid UTF-8 encoded stringjava.io.EOFException
- if the value could not be read because no more data remains to be readjava.io.IOException
- if an I/O error occursReadBuffer getBuffer()
java.lang.String readSafeUTF() throws java.io.IOException
java.io.IOException
- if an I/O error occursint readPackedInt() throws java.io.IOException
WriteBuffer.BufferOutput.writePackedInt(int)
.java.io.IOException
- if an I/O error occurslong readPackedLong() throws java.io.IOException
WriteBuffer.BufferOutput.writePackedLong(long)
.java.io.IOException
- if an I/O error occursReadBuffer readBuffer(int cb) throws java.io.IOException
cb
bytes and return them as a ReadBuffer object.cb
- the number of bytes to readcb
bytes read from the BufferInputjava.io.EOFException
- if the stream is exhausted before the number of bytes indicated could be readjava.io.IOException
- if an I/O error occursint getOffset()
void setOffset(int of)
of
- the offset of the next byte to read from the ReadBufferjava.lang.IndexOutOfBoundsException
- if of < 0
or of > getBuffer().length()
|
Oracle® Coherence Java API Reference Release 12.1.2.0.3 E26043-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |