|
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 PofWriter
The PofWriter interface provides the capability of writing a set of non-primitive Java types ("user types") to a POF stream as an ordered sequence of indexed properties.
The serialized format of a POF user type is as follows:
The type identifier is an integer value greater than or equal to zero that identifies the non-primitive Java type. The type identifier has no explicit or self-describing meaning within the POF stream itself; in other words, the type identifier does not contain the actual class definition. Instead, the PofWriter and corresponding PofReader
share a PofContext
which contains the necessary meta-data, including type identifier to Java type mappings.
The version identifier is used to support both backwards and forwards compatibility of serialized POF user types. Versioning of user types allows the addition of new properties to a user type, but not the replacement or removal of properties that existed in a previous version of the user type.
When a version v1 of a user type written by a PofWriter is read by a PofReader that supports version v2 of the same user type, the PofReader returns default values for the additional properties of the User Type that exist in v2 but do not exist in v1. Conversely, when a version v2 of a user type written by a PofWriter is read by a PofReader that supports version v1 of the same user type, the instance of user type v1 must store those additional opaque properties for later encoding. The PofReader enables the user type to store off the opaque properties in binary form (see PofReader.readRemainder()
). When the user type is re-encoded, it must be done so using the version identifier v2, since it is including the unaltered v2 properties. The opaque properties are subsequently included in the POF stream using the writeRemainder(com.tangosol.util.Binary)
method.
Following the version identifier is an ordered sequence of index/value pairs, each of which is composed of a property index encoded as non-negative integer value whose value is greater than the previous property index, and a property value encoded as a POF value. The user type is finally terminated with an illegal property index of -1.
Note: To read a property that was written using a PofWriter method, the corresponding read method on PofReader
must be used. For example, if a property was written using writeByteArray(int, byte[])
, PofReader.readByteArray(int)
must be used to read the property.
PofContext
, PofReader
Method Summary | |
---|---|
PofWriter |
createNestedPofWriter(int iProp) Obtain a PofWriter that can be used to write a set of properties into a single property of the current user type. |
PofContext |
getPofContext() Return the PofContext object used by this PofWriter to serialize user types to a POF stream. |
int |
getUserTypeId() Determine the user type that is currently being written. |
int |
getVersionId() Determine the version identifier of the user type that is currently being written. |
void |
setPofContext(PofContext ctx) Configure the PofContext object used by this PofWriter to serialize user types to a POF stream. |
void |
setVersionId(int nVersionId) Set the version identifier of the user type that is currently being written. |
void |
writeBigDecimal(int iProp, java.math.BigDecimal dec) Write a BigDecimal property to the POF stream. |
void |
writeBigInteger(int iProp, java.math.BigInteger n) Write a BigInteger property to the POF stream. |
void |
writeBinary(int iProp, Binary bin) Write a Binary property to the POF stream. |
void |
writeBoolean(int iProp, boolean f) Write a boolean property to the POF stream. |
void |
writeBooleanArray(int iProp, boolean[] af) Write a boolean[] property to the POF stream. |
void |
writeByte(int iProp, byte b) Write a byte property to the POF stream. |
void |
writeByteArray(int iProp, byte[] ab) Write a byte[] property to the POF stream. |
void |
writeChar(int iProp, char ch) Write a char property to the POF stream. |
void |
writeCharArray(int iProp, char[] ach) Write a char[] property to the POF stream. |
void |
writeCollection(int iProp, java.util.Collection coll) Write a Collection property to the POF stream. |
void |
writeCollection(int iProp, java.util.Collection coll, java.lang.Class clz) Write a uniform Collection property to the POF stream. |
void |
writeDate(int iProp, java.util.Date dt) Write a Date property to the POF stream in ISO8601 format. |
void |
writeDateTime(int iProp, java.util.Date dt) Write a Date property to the POF stream in ISO8601 format. |
void |
writeDateTime(int iProp, java.sql.Timestamp dt) Write a Timestamp property to the POF stream in ISO8601 format. |
void |
writeDateTimeWithZone(int iProp, java.util.Date dt) Write a Date property to the POF stream in ISO8601 format. |
void |
writeDateTimeWithZone(int iProp, java.sql.Timestamp dt) Write a Timestamp property to the POF stream in ISO8601 format. |
void |
writeDouble(int iProp, double dfl) Write a double property to the POF stream. |
void |
writeDoubleArray(int iProp, double[] adfl) Write a double[] property to the POF stream. |
void |
writeFloat(int iProp, float fl) Write a float property to the POF stream. |
void |
writeFloatArray(int iProp, float[] afl) Write a float[] property to the POF stream. |
void |
writeInt(int iProp, int n) Write a int property to the POF stream. |
void |
writeIntArray(int iProp, int[] an) Write a int[] property to the POF stream. |
void |
writeLong(int iProp, long n) Write a long property to the POF stream. |
void |
writeLongArray(int iProp, long[] an) Write a long[] property to the POF stream. |
void |
writeLongArray(int iProp, LongArray la) Write a LongArray property to the POF stream. |
void |
writeLongArray(int iProp, LongArray la, java.lang.Class clz) Write a uniform LongArray property to the POF stream. |
void |
writeMap(int iProp, java.util.Map map) Write a Map property to the POF stream. |
void |
writeMap(int iProp, java.util.Map map, java.lang.Class clzKey) Write a uniform key Map property to the POF stream. |
void |
writeMap(int iProp, java.util.Map map, java.lang.Class clzKey, java.lang.Class clzValue) Write a uniform Map property to the POF stream. |
void |
writeObject(int iProp, java.lang.Object o) Write an Object property to the POF stream. |
void |
writeObjectArray(int iProp, java.lang.Object[] ao) Write an Object[] property to the POF stream. |
void |
writeObjectArray(int iProp, java.lang.Object[] ao, java.lang.Class clz) Write a uniform Object[] property to the POF stream. |
void |
writeRawDate(int iProp, RawDate date) Write a RawDate property to the POF stream. |
void |
writeRawDateTime(int iProp, RawDateTime dt) Write a RawDateTime property to the POF stream. |
void |
writeRawDayTimeInterval(int iProp, RawDayTimeInterval interval) Write a RawDayTimeInterval property to the POF stream. |
void |
writeRawQuad(int iProp, RawQuad qfl) Write a RawQuad property to the POF stream. |
void |
writeRawTime(int iProp, RawTime time) Write a RawTime property to the POF stream. |
void |
writeRawTimeInterval(int iProp, RawTimeInterval interval) Write a RawTimeInterval property to the POF stream. |
void |
writeRawYearMonthInterval(int iProp, RawYearMonthInterval interval) Write a RawYearMonthInterval property to the POF stream. |
void |
writeRemainder(Binary binProps) Write the remaining properties to the POF stream, terminating the writing of the currrent user type. |
void |
writeShort(int iProp, short n) Write a short property to the POF stream. |
void |
writeShortArray(int iProp, short[] an) Write a short[] property to the POF stream. |
void |
writeString(int iProp, java.lang.String s) Write a String property to the POF stream. |
void |
writeTime(int iProp, java.util.Date dt) Write a Date property to the POF stream in ISO8601 format. |
void |
writeTime(int iProp, java.sql.Timestamp dt) Write a Timestamp property to the POF stream in ISO8601 format. |
void |
writeTimeWithZone(int iProp, java.util.Date dt) Write a Date property to the POF stream in ISO8601 format. |
void |
writeTimeWithZone(int iProp, java.sql.Timestamp dt) Write a Timestamp property to the POF stream in ISO8601 format. |
Method Detail |
---|
void writeBoolean(int iProp, boolean f) throws java.io.IOException
iProp
- the property indexf
- the boolean property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeByte(int iProp, byte b) throws java.io.IOException
iProp
- the property indexb
- the byte property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeChar(int iProp, char ch) throws java.io.IOException
iProp
- the property indexch
- the char property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeShort(int iProp, short n) throws java.io.IOException
iProp
- the property indexn
- the short property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeInt(int iProp, int n) throws java.io.IOException
iProp
- the property indexn
- the int property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeLong(int iProp, long n) throws java.io.IOException
iProp
- the property indexn
- the long property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeFloat(int iProp, float fl) throws java.io.IOException
iProp
- the property indexfl
- the float property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeDouble(int iProp, double dfl) throws java.io.IOException
iProp
- the property indexdfl
- the double property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeBooleanArray(int iProp, boolean[] af) throws java.io.IOException
iProp
- the property indexaf
- the boolean[] property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeByteArray(int iProp, byte[] ab) throws java.io.IOException
iProp
- the property indexab
- the byte[] property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeCharArray(int iProp, char[] ach) throws java.io.IOException
iProp
- the property indexach
- the char[] property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeShortArray(int iProp, short[] an) throws java.io.IOException
iProp
- the property indexan
- the short[] property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeIntArray(int iProp, int[] an) throws java.io.IOException
iProp
- the property indexan
- the int[] property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeLongArray(int iProp, long[] an) throws java.io.IOException
iProp
- the property indexan
- the long[] property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeFloatArray(int iProp, float[] afl) throws java.io.IOException
iProp
- the property indexafl
- the float[] property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeDoubleArray(int iProp, double[] adfl) throws java.io.IOException
iProp
- the property indexadfl
- the double[] property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeBigInteger(int iProp, java.math.BigInteger n) throws java.io.IOException
iProp
- the property indexn
- the BigInteger property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.lang.IllegalStateException
- if the given BigInteger does not fit into 128 bitsjava.io.IOException
- if an I/O error occursvoid writeRawQuad(int iProp, RawQuad qfl) throws java.io.IOException
iProp
- the property indexqfl
- the RawQuad property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeBigDecimal(int iProp, java.math.BigDecimal dec) throws java.io.IOException
iProp
- the property indexdec
- the BigDecimal property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.lang.IllegalStateException
- if the signed unscaled form of the given BigDecimal does not fit into 128 bitsjava.io.IOException
- if an I/O error occursvoid writeBinary(int iProp, Binary bin) throws java.io.IOException
Binary
property to the POF stream.iProp
- the property indexbin
- the Binary property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeString(int iProp, java.lang.String s) throws java.io.IOException
iProp
- the property indexs
- the String property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeDate(int iProp, java.util.Date dt) throws java.io.IOException
This method encodes the year, month and day information of the specified Date object. No time or timezone information is encoded.
iProp
- the property indexdt
- the Date property value to write in ISO8601 formatjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeDateTime(int iProp, java.util.Date dt) throws java.io.IOException
This method encodes the year, month, day, hour, minute, second and millisecond information of the specified Date object. No timezone information is encoded.
iProp
- the property indexdt
- the Date property value to write in ISO8601 formatjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeDateTime(int iProp, java.sql.Timestamp dt) throws java.io.IOException
This method encodes the year, month, day, hour, minute, second, millisecond and nanosecond information of the specified Timestamp object. No timezone information is encoded.
iProp
- the property indexdt
- the Timestamp property value to write in ISO8601 formatjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeDateTimeWithZone(int iProp, java.util.Date dt) throws java.io.IOException
This method encodes the year, month, day, hour, minute, second, millisecond and timezone information of the specified Date object.
iProp
- the property indexdt
- the Date property value to write in ISO8601 formatjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeDateTimeWithZone(int iProp, java.sql.Timestamp dt) throws java.io.IOException
This method encodes the year, month, day, hour, minute, second, millisecond, nanosecond and timezone information of the specified Timestamp object.
iProp
- the property indexdt
- the Timestamp property value to write in ISO8601 formatjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeTime(int iProp, java.util.Date dt) throws java.io.IOException
This method encodes the hour, minute, second and millisecond information of the specified Date object. No year, month, day or timezone information is encoded.
iProp
- the property indexdt
- the Date property value to write in ISO8601 formatjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeTime(int iProp, java.sql.Timestamp dt) throws java.io.IOException
This method encodes the hour, minute, second, millisecond and nanosecond information of the specified Timestamp object.
iProp
- the property indexdt
- the Timestamp property value to write in ISO8601 formatjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeTimeWithZone(int iProp, java.util.Date dt) throws java.io.IOException
This method encodes the hour, minute, second, millisecond and timezone information of the specified Date object. No year, month or day information is encoded.
iProp
- the property indexdt
- the Date property value to write in ISO8601 formatjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeTimeWithZone(int iProp, java.sql.Timestamp dt) throws java.io.IOException
This method encodes the hour, minute, second, millisecond, nanosecond and timezone information of the specified Timestamp object. No year, month or day information is encoded.
iProp
- the property indexdt
- the Timestamp property value to write in ISO8601 formatjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeRawDate(int iProp, RawDate date) throws java.io.IOException
iProp
- the property indexdate
- the RawDate property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeRawTime(int iProp, RawTime time) throws java.io.IOException
iProp
- the property indextime
- the RawTime property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeRawDateTime(int iProp, RawDateTime dt) throws java.io.IOException
iProp
- the property indexdt
- the RawDateTime property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeRawYearMonthInterval(int iProp, RawYearMonthInterval interval) throws java.io.IOException
iProp
- the property indexinterval
- the RawYearMonthInterval property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeRawTimeInterval(int iProp, RawTimeInterval interval) throws java.io.IOException
iProp
- the property indexinterval
- the RawTimeInterval property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeRawDayTimeInterval(int iProp, RawDayTimeInterval interval) throws java.io.IOException
iProp
- the property indexinterval
- the RawDayTimeInterval property value to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.io.IOException
- if an I/O error occursvoid writeObject(int iProp, java.lang.Object o) throws java.io.IOException
The given object must be an instance of one of the following:
RawQuad
Binary
RawDate
RawTime
RawDateTime
RawYearMonthInterval
RawTimeInterval
RawDayTimeInterval
LongArray
PortableObject
Otherwise, a PofSerializer
for the object must be obtainable from the PofContext
associated with this PofWriter.
iProp
- the property indexo
- the Object property to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF stream; or if the given property cannot be encoded into a POF streamjava.io.IOException
- if an I/O error occursvoid writeObjectArray(int iProp, java.lang.Object[] ao) throws java.io.IOException
Each element of the given array must be an instance (or an array of instances) of one of the following:
RawQuad
Binary
RawDate
RawTime
RawDateTime
RawYearMonthInterval
RawTimeInterval
RawDayTimeInterval
LongArray
PortableObject
Otherwise, a PofSerializer
for each element of the array must be obtainable from the PofContext
associated with this PofWriter.
iProp
- the property indexao
- the Object[] property to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF stream; or if the given property cannot be encoded into a POF streamjava.io.IOException
- if an I/O error occursvoid writeObjectArray(int iProp, java.lang.Object[] ao, java.lang.Class clz) throws java.io.IOException
Each element of the given array must be an instance (or an array of instances) of one of the following:
RawQuad
Binary
RawDate
RawTime
RawDateTime
RawYearMonthInterval
RawTimeInterval
RawDayTimeInterval
LongArray
PortableObject
Otherwise, a PofSerializer
for each element of the array must be obtainable from the PofContext
associated with this PofWriter.
Additionally, the type of each element must be equal to the specified class.
iProp
- the property indexao
- the Object[] property to writeclz
- the class of all elements; must not be nulljava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF stream; if the given property cannot be encoded into a POF stream; or if the type of one or more elements of the array is not equal to the specified classjava.io.IOException
- if an I/O error occursvoid writeCollection(int iProp, java.util.Collection coll) throws java.io.IOException
Each element of the given Collection must be an instance (or an array of instances) of one of the following:
RawQuad
Binary
RawDate
RawTime
RawDateTime
RawYearMonthInterval
RawTimeInterval
RawDayTimeInterval
LongArray
PortableObject
Otherwise, a PofSerializer
for each element of the Collection must be obtainable from the PofContext
associated with this PofWriter.
iProp
- the property indexcoll
- the Collection property to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF stream; or if the given property cannot be encoded into a POF streamjava.io.IOException
- if an I/O error occursvoid writeCollection(int iProp, java.util.Collection coll, java.lang.Class clz) throws java.io.IOException
Each element of the given Collection must be an instance (or an array of instances) of one of the following:
RawQuad
Binary
RawDate
RawTime
RawDateTime
RawYearMonthInterval
RawTimeInterval
RawDayTimeInterval
LongArray
PortableObject
Otherwise, a PofSerializer
for each element of the Collection must be obtainable from the PofContext
associated with this PofWriter.
Additionally, the type of each element must be equal to the specified class.
iProp
- the property indexcoll
- the Collection property to writeclz
- the class of all elements; must not be nulljava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF stream; if the given property cannot be encoded into a POF stream; or if the type of one or more elements of the Collection is not equal to the specified classjava.io.IOException
- if an I/O error occursvoid writeLongArray(int iProp, LongArray la) throws java.io.IOException
Each element of the given LongArray must be an instance (or an array of instances) of one of the following:
RawQuad
Binary
RawDate
RawTime
RawDateTime
RawYearMonthInterval
RawTimeInterval
RawDayTimeInterval
LongArray
PortableObject
Otherwise, a PofSerializer
for each element of the LongArray must be obtainable from the PofContext
associated with this PofWriter.
iProp
- the property indexla
- the LongArray property to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF stream; or if the given property cannot be encoded into a POF streamjava.io.IOException
- if an I/O error occursvoid writeLongArray(int iProp, LongArray la, java.lang.Class clz) throws java.io.IOException
Each element of the given LongArray must be an instance (or an array of instances) of one of the following:
RawQuad
Binary
RawDate
RawTime
RawDateTime
RawYearMonthInterval
RawTimeInterval
RawDayTimeInterval
LongArray
PortableObject
Otherwise, a PofSerializer
for each element of the LongArray must be obtainable from the PofContext
associated with this PofWriter.
Additionally, the type of each element must be equal to the specified class.
iProp
- the property indexla
- the LongArray property to writeclz
- the class of all elements; must not be nulljava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF stream; if the given property cannot be encoded into a POF stream; or if the type of one or more elements of the LongArray is not equal to the specified classjava.io.IOException
- if an I/O error occursvoid writeMap(int iProp, java.util.Map map) throws java.io.IOException
Each key and value of the given Map must be an instance (or an array of instances) of one of the following:
RawQuad
Binary
RawDate
RawTime
RawDateTime
RawYearMonthInterval
RawTimeInterval
RawDayTimeInterval
LongArray
PortableObject
Otherwise, a PofSerializer
for each key and value of the Map must be obtainable from the PofContext
associated with this PofWriter.
iProp
- the property indexmap
- the Map property to writejava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF stream; or if the given property cannot be encoded into a POF streamjava.io.IOException
- if an I/O error occursvoid writeMap(int iProp, java.util.Map map, java.lang.Class clzKey) throws java.io.IOException
Each key and value of the given Map must be an instance (or an array of instances) of one of the following:
RawQuad
Binary
RawDate
RawTime
RawDateTime
RawYearMonthInterval
RawTimeInterval
RawDayTimeInterval
LongArray
PortableObject
Otherwise, a PofSerializer
for each key and value of the Map must be obtainable from the PofContext
associated with this PofWriter.
Additionally, the type of each key must be equal to the specified class.
iProp
- the property indexmap
- the Map property to writeclzKey
- the class of all keys; must not be nulljava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF stream; if the given property cannot be encoded into a POF stream; or if the type of one or more keys is not equal to the specified classjava.io.IOException
- if an I/O error occursvoid writeMap(int iProp, java.util.Map map, java.lang.Class clzKey, java.lang.Class clzValue) throws java.io.IOException
Each key and value of the given Map must be an instance (or an array of instances) of one of the following:
RawQuad
Binary
RawDate
RawTime
RawDateTime
RawYearMonthInterval
RawTimeInterval
RawDayTimeInterval
LongArray
PortableObject
Otherwise, a PofSerializer
for each key and value of the Map must be obtainable from the PofContext
associated with this PofWriter.
Additionally, the type of each key and value must be equal to the specified key class and value class respectively.
iProp
- the property indexmap
- the Map property to writeclzKey
- the class of all keys; must not be nullclzValue
- the class of all values; must not be nulljava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF stream; if the given property cannot be encoded into a POF stream; or if the type of one or more keys or values of the Map is not equal to the specified key or value classjava.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 = writer.getPofContext(); try { // switch to another PofContext PofContext ctxNew = ...; writer.setContext(ctxNew); // output POF data using the writer } finally { // restore the original PofContext writer.setPofContext(ctxOrig); }
ctx
- the new PofContext; must not be nullint getUserTypeId()
int getVersionId()
java.lang.IllegalStateException
- if no user type is being writtenvoid setVersionId(int nVersionId)
nVersionId
- the user type identifier; must be non-negativejava.lang.IllegalArgumentException
- if the given version ID is negativejava.lang.IllegalStateException
- if no user type is being writtenPofWriter createNestedPofWriter(int iProp) throws java.io.IOException
iProp
- the property indexjava.lang.IllegalArgumentException
- if the property index is invalid, or is less than or equal to the index of the previous property written to the POF streamjava.lang.IllegalStateException
- if no user type is being writtenjava.io.IOException
- if an I/O error occursvoid writeRemainder(Binary binProps) throws java.io.IOException
Calling this method terminates the current user type by writing a -1 to the POF stream after the last indexed property. Subsequent calls to the various writeXYZ methods of this interface will fail after this method is called.
binProps
- a Binary object containing zero or more indexed properties in binary POF encoded form; may be nulljava.lang.IllegalStateException
- if no user type is being writtenjava.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 |