|
Oracle® Coherence Java API Reference Release 3.7.1.0 E22843-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.pof.PofInputStream
public class PofInputStream
An ObjectInput implementation suitable for reading Externalizable and ExternalizableLite objects from a POF stream, although without support for schema evolution and other advanced POF features.
Constructor Summary | |
---|---|
PofInputStream(PofReader in) Construct a PofInputStream that will read its information from an underlying PofReader . |
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. |
PofReader |
getPofReader() Obtain the underlying PofReader. |
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 |
nextIndex() Determine the next property index to read from. |
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. |
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. |
java.lang.Object |
readObject() Read and return an object. |
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 |
reset() Rewind this stream to the position at the time the mark(int) method was last called on this InputStream. |
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 PofInputStream(PofReader in)
PofReader
.
in
- the PofReader
to read fromMethod Detail |
---|
public int read() throws java.io.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 interface java.io.ObjectInput
read
in class java.io.InputStream
-1
if the end of the stream has been reachedjava.io.IOException
- if an I/O error occurspublic int read(byte[] ab) throws java.io.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 interface java.io.ObjectInput
read
in class java.io.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 reachedjava.lang.NullPointerException
- if the passed array is nulljava.io.IOException
- if an I/O error occurspublic int read(byte[] ab, int of, int cb) throws java.io.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 interface java.io.ObjectInput
read
in class java.io.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 reachedjava.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.IOException
- if an I/O error occurspublic long skip(long cb) throws java.io.IOException
skip
in interface InputStreaming
skip
in interface java.io.ObjectInput
skip
in class java.io.InputStream
cb
- the maximum number of bytes to skip overjava.io.IOException
- if an I/O error occurspublic int available() throws java.io.IOException
available
in interface InputStreaming
available
in interface java.io.ObjectInput
available
in class java.io.InputStream
java.io.IOException
- if an I/O error occurspublic void close() throws java.io.IOException
close
in interface InputStreaming
close
in interface java.io.Closeable
close
in interface java.io.ObjectInput
close
in class java.io.InputStream
java.io.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.mark
in interface InputStreaming
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
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 java.io.InputStream
java.io.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.markSupported
in interface InputStreaming
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 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 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 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 occurspublic int 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 occurspublic boolean 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 occurspublic byte 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 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 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 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 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 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 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 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 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 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.
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 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 java.lang.Object readObject() throws java.io.IOException
readObject
in interface java.io.ObjectInput
java.io.IOException
- if an I/O error occurspublic PofReader getPofReader()
public int nextIndex()
|
Oracle® Coherence Java API Reference Release 3.7.1.0 E22843-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |