|
Oracle® Fusion Middleware Java API Reference for Oracle Coherence 12c (12.1.3.0.0) E47890-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
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 | |
---|---|
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. |
void |
close() Close the InputStream and release any system resources associated with it. |
protected java.lang.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 InputStreaming.reset() method) to the current position. |
boolean |
markSupported() Determine if this InputStream supports the ReadBuffer.BufferInput.mark(int) and InputStreaming.reset() methods. |
int |
read() |
int |
read(byte[] ab) |
int |
read(byte[] ab, int of, int cb) |
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. |
protected java.lang.String |
readUTF(int cb) Reads the specified-length UTF data and converts it to a String value. |
void |
reset() |
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) |
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 java.io.IOException
read
in interface com.oracle.common.io.InputStreaming
read
in class java.io.InputStream
java.io.IOException
public int read(byte[] ab) throws java.io.IOException
read
in interface com.oracle.common.io.InputStreaming
read
in class java.io.InputStream
java.io.IOException
public int read(byte[] ab, int of, int cb) throws java.io.IOException
read
in interface com.oracle.common.io.InputStreaming
read
in class java.io.InputStream
java.io.IOException
public long skip(long cb) throws java.io.IOException
skip
in interface com.oracle.common.io.InputStreaming
skip
in class java.io.InputStream
java.io.IOException
public 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
available
in interface ReadBuffer.BufferInput
available
in class java.io.InputStream
java.io.IOException
- if an I/O error occurspublic void 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
close
in interface ReadBuffer.BufferInput
close
in interface java.io.Closeable
close
in class java.io.InputStream
java.io.IOException
- 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.
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
mark
in interface ReadBuffer.BufferInput
mark
in class java.io.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 java.io.IOException
reset
in interface com.oracle.common.io.InputStreaming
reset
in class java.io.InputStream
java.io.IOException
public boolean markSupported()
ReadBuffer.BufferInput.mark(int)
and InputStreaming.reset()
methods.
BufferInput implementations must support the ReadBuffer.BufferInput.mark(int)
and InputStreaming.reset()
methods, so this method always returns true
.
markSupported
in interface com.oracle.common.io.InputStreaming
markSupported
in interface ReadBuffer.BufferInput
markSupported
in class java.io.InputStream
true
if this InputStream supports the mark and reset method; false
otherwisepublic void 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 ReadBuffer.BufferInput
readFully
in interface java.io.DataInput
ab
- the array to store the bytes which are read from the streamjava.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 occurspublic void 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 ReadBuffer.BufferInput
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.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 occurspublic int skipBytes(int cb) throws java.io.IOException
skipBytes
in interface ReadBuffer.BufferInput
skipBytes
in interface java.io.DataInput
cb
- the maximum number of bytes to skip overjava.io.IOException
- if an I/O error occurspublic boolean readBoolean() throws java.io.IOException
This method is the counterpart for the DataOutput.writeBoolean(boolean)
method.
readBoolean
in interface ReadBuffer.BufferInput
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 occurspublic byte readByte() throws java.io.IOException
This method is the counterpart for the DataOutput.writeByte(int)
method.
readByte
in interface ReadBuffer.BufferInput
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 occurspublic int 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 ReadBuffer.BufferInput
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 occurspublic short readShort() throws java.io.IOException
This method is the counterpart for the DataOutput.writeShort(int)
method.
readShort
in interface ReadBuffer.BufferInput
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 occurspublic int 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 ReadBuffer.BufferInput
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 occurspublic char readChar() throws java.io.IOException
This method is the counterpart for the DataOutput.writeChar(int)
method.
readChar
in interface ReadBuffer.BufferInput
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 occurspublic int readInt() throws java.io.IOException
This method is the counterpart for the DataOutput.writeInt(int)
method.
readInt
in interface ReadBuffer.BufferInput
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 occurspublic long readLong() throws java.io.IOException
This method is the counterpart for the DataOutput.writeLong(long)
method.
readLong
in interface ReadBuffer.BufferInput
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 occurspublic float readFloat() throws java.io.IOException
This method is the counterpart for the DataOutput.writeFloat(float)
method.
readFloat
in interface ReadBuffer.BufferInput
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 occurspublic double readDouble() throws java.io.IOException
This method is the counterpart for the DataOutput.writeDouble(double)
method.
readDouble
in interface ReadBuffer.BufferInput
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 occurspublic java.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 ReadBuffer.BufferInput
readLine
in interface java.io.DataInput
java.io.IOException
- if an I/O error occurs.public java.lang.String readUTF() throws java.io.IOException
This method is the counterpart for the DataOutput.writeUTF(java.lang.String)
method.
readUTF
in interface ReadBuffer.BufferInput
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 occurspublic ReadBuffer getBuffer()
getBuffer
in interface ReadBuffer.BufferInput
public java.lang.String readSafeUTF() throws java.io.IOException
readSafeUTF
in interface ReadBuffer.BufferInput
java.io.IOException
- if an I/O error occurspublic int readPackedInt() throws java.io.IOException
WriteBuffer.BufferOutput.writePackedInt(int)
.readPackedInt
in interface ReadBuffer.BufferInput
java.io.IOException
- if an I/O error occurspublic long readPackedLong() throws java.io.IOException
WriteBuffer.BufferOutput.writePackedLong(long)
.readPackedLong
in interface ReadBuffer.BufferInput
java.io.IOException
- if an I/O error occurspublic ReadBuffer readBuffer(int cb) throws java.io.IOException
cb
bytes and return them as a ReadBuffer object.readBuffer
in interface ReadBuffer.BufferInput
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 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 void adjustOffsetInternal(int cb)
cb
- the number of bytes that were writtenprotected 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 exceedprotected java.lang.String readUTF(int cb) throws java.io.IOException
cb
- the number of bytes that the UTF data takes up in the stream; a value less than zero indicates a null valuejava.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 occursprotected java.lang.String convertUTF(int of, int cb) throws java.io.IOException
of
- the offset within the streamcb
- the length in bytes within the streamjava.io.IOException
- if an I/O or conversion exception occurs, such as UTFDataFormatException
|
Oracle® Fusion Middleware Java API Reference for Oracle Coherence 12c (12.1.3.0.0) E47890-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |