|
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 |
public interface PofReader
The PofReader interface provides the capability of reading a set of non-primitive Java types ("user types") from a POF stream as an ordered sequence of indexed properties.
See PofWriter
for a complete description of the POF user type serialization format.
PofContext
, PofWriter
Method Summary | |
---|---|
PofReader |
createNestedPofReader(int iProp) Obtain a PofReader that can be used to read a set of properties from a single property of the current user type. |
PofContext |
getPofContext() Return the PofContext object used by this PofReader to deserialize user types from a POF stream. |
int |
getUserTypeId() Determine the user type that is currently being parsed. |
int |
getVersionId() Determine the version identifier of the user type that is currently being parsed. |
java.math.BigDecimal |
readBigDecimal(int iProp) Read a BigDecimal from the POF stream. |
java.math.BigInteger |
readBigInteger(int iProp) Read a BigInteger from the POF stream. |
Binary |
readBinary(int iProp) Read a Binary from the POF stream. |
boolean |
readBoolean(int iProp) Read a boolean property from the POF stream. |
boolean[] |
readBooleanArray(int iProp) Read a boolean[] property from the POF stream. |
byte |
readByte(int iProp) Read a byte property from the POF stream. |
byte[] |
readByteArray(int iProp) Read a byte[] property from the POF stream. |
char |
readChar(int iProp) Read a char property from the POF stream. |
char[] |
readCharArray(int iProp) Read a char[] property from the POF stream. |
java.util.Collection |
readCollection(int iProp, java.util.Collection coll) Read a Collection of object values from the POF stream. |
java.util.Date |
readDate(int iProp) Read a java.util.Date from the POF stream. |
double |
readDouble(int iProp) Read a double property from the POF stream. |
double[] |
readDoubleArray(int iProp) Read a double[] property from the POF stream. |
float |
readFloat(int iProp) Read a float property from the POF stream. |
float[] |
readFloatArray(int iProp) Read a float[] property from the POF stream. |
int |
readInt(int iProp) Read a int property from the POF stream. |
int[] |
readIntArray(int iProp) Read a int[] property from the POF stream. |
long |
readLong(int iProp) Read a long property from the POF stream. |
long[] |
readLongArray(int iProp) Read a long[] property from the POF stream. |
LongArray |
readLongArray(int iProp, LongArray array) Read a LongArray of object values. |
java.util.Map |
readMap(int iProp, java.util.Map map) Read a Map of key/value pairs from the POF stream. |
java.lang.Object |
readObject(int iProp) Read a property of any type, including a user type, from the POF stream. |
java.lang.Object[] |
readObjectArray(int iProp, java.lang.Object[] ao) Read an array of object values. |
RawDate |
readRawDate(int iProp) Read a RawDate from the POF stream. |
RawDateTime |
readRawDateTime(int iProp) Read a RawDateTime from the POF stream. |
RawDayTimeInterval |
readRawDayTimeInterval(int iProp) Read a RawDayTimeInterval from the POF stream. |
RawQuad |
readRawQuad(int iProp) Read a RawQuad from the POF stream. |
RawTime |
readRawTime(int iProp) Read a RawTime from the POF stream. |
RawTimeInterval |
readRawTimeInterval(int iProp) Read a RawTimeInterval from the POF stream. |
RawYearMonthInterval |
readRawYearMonthInterval(int iProp) Read a RawYearMonthInterval from the POF stream. |
Binary |
readRemainder() Read all remaining indexed properties of the current user type from the POF stream. |
short |
readShort(int iProp) Read a short property from the POF stream. |
short[] |
readShortArray(int iProp) Read a short[] property from the POF stream. |
java.lang.String |
readString(int iProp) Read a String from the POF stream. |
void |
registerIdentity(java.lang.Object o) Register an identity for a newly created user type instance. |
void |
setPofContext(PofContext ctx) Configure the PofContext object used by this PofReader to deserialize user types from a POF stream. |
Method Detail |
---|
boolean readBoolean(int iProp) throws java.io.IOException
iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursbyte readByte(int iProp) throws java.io.IOException
iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occurschar readChar(int iProp) throws java.io.IOException
iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursshort readShort(int iProp) throws java.io.IOException
iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursint readInt(int iProp) throws java.io.IOException
iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occurslong readLong(int iProp) throws java.io.IOException
iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursfloat readFloat(int iProp) throws java.io.IOException
iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursdouble readDouble(int iProp) throws java.io.IOException
iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursboolean[] readBooleanArray(int iProp) throws java.io.IOException
iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursbyte[] readByteArray(int iProp) throws java.io.IOException
iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occurschar[] readCharArray(int iProp) throws java.io.IOException
iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursshort[] readShortArray(int iProp) throws java.io.IOException
iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursint[] readIntArray(int iProp) throws java.io.IOException
iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occurslong[] readLongArray(int iProp) throws java.io.IOException
iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursfloat[] readFloatArray(int iProp) throws java.io.IOException
iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursdouble[] readDoubleArray(int iProp) throws java.io.IOException
iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursjava.math.BigInteger readBigInteger(int iProp) throws java.io.IOException
iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursRawQuad readRawQuad(int iProp) throws java.io.IOException
iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursjava.math.BigDecimal readBigDecimal(int iProp) throws java.io.IOException
iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursBinary readBinary(int iProp) throws java.io.IOException
iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursjava.lang.String readString(int iProp) throws java.io.IOException
iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursjava.util.Date readDate(int iProp) throws java.io.IOException
iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursRawDate readRawDate(int iProp) throws java.io.IOException
RawDate
class contains the raw date information that was carried in the POF stream.iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursRawTime readRawTime(int iProp) throws java.io.IOException
RawTime
class contains the raw time information that was carried in the POF stream, including raw timezone information.iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursRawDateTime readRawDateTime(int iProp) throws java.io.IOException
RawDateTime
class contains the raw date and time information that was carried in the POF stream, including raw timezone information.iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursRawYearMonthInterval readRawYearMonthInterval(int iProp) throws java.io.IOException
RawYearMonthInterval
class contains the raw year-month interval information that was carried in the POF stream.iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursRawTimeInterval readRawTimeInterval(int iProp) throws java.io.IOException
RawTimeInterval
class contains the raw time interval information that was carried in the POF stream.iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursRawDayTimeInterval readRawDayTimeInterval(int iProp) throws java.io.IOException
RawDayTimeInterval
class contains the raw year-month interval information that was carried in the POF stream.iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursjava.lang.Object readObject(int iProp) throws java.io.IOException
iProp
- the property index to readjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursjava.lang.Object[] readObjectArray(int iProp, java.lang.Object[] ao) throws java.io.IOException
iProp
- the property index to readao
- the optional array to use to store the values, or to use as a typed template for creating an array to store the values, following the documentation for Collection.toArray()
java.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursLongArray readLongArray(int iProp, LongArray array) throws java.io.IOException
iProp
- the property index to readarray
- the optional LongArray object to use to store the valuesjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursjava.util.Collection readCollection(int iProp, java.util.Collection coll) throws java.io.IOException
iProp
- the property index to readcoll
- the optional Collection to use to store the valuesjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursjava.util.Map readMap(int iProp, java.util.Map map) throws java.io.IOException
iProp
- the property index to readmap
- the optional Map to initializejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.io.IOException
- if an I/O error occursPofContext getPofContext()
void setPofContext(PofContext ctx)
Note: this is an advanced method that should be used with care. For example, if this method is being used to switch to another PofContext mid-POF stream, it is important to eventually restore the original PofContext. For example:
PofContext ctxOrig = reader.getPofContext(); try { // switch to another PofContext PofContext ctxNew = ...; reader.setContext(ctxNew); // read POF data using the reader } finally { // restore the original PofContext reader.setPofContext(ctxOrig); }
ctx
- the new PofContext; must not be nullint getUserTypeId()
int getVersionId()
java.lang.IllegalStateException
- if no user type is being parsedvoid registerIdentity(java.lang.Object o)
If identity/reference types are enabled, an identity is used to uniquely identify a user type instance within a POF stream. The identity immediately proceeds the instance value in the POF stream and can be used later in the stream to reference the instance.
PofSerializer implementations must call this method with the user type instance instantiated during deserialization prior to reading any properties of the instance which are user type instances themselves.
o
- the object to register the identity forPofSerializer.deserialize(PofReader)
PofReader createNestedPofReader(int iProp) throws java.io.IOException
iProp
- the property index to read fromjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property read from the POF streamjava.lang.IllegalStateException
- if no user type is being parsedjava.io.IOException
- if an I/O error occursBinary readRemainder() throws java.io.IOException
Subsequent calls to the various readXYZ methods of this interface will fail after this method is called.
java.lang.IllegalStateException
- if no user type is being parsedjava.io.IOException
- if an I/O error occurs
|
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 |