|
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
BitHelper
com.tangosol.util.ExternalizableHelper
public abstract class ExternalizableHelper
Helpers for the Serializable, Externalizable and the ExternalizableLite interface.
Note: This class is configured via the ExternalizableHelper.xml document located in the same package as the class. The location of the configuration file can be overridden using the tangosol.externalizable.config
system property.
Nested Class Summary | |
---|---|
static class |
ExternalizableHelper.DefaultObjectStreamFactory Default ObjectStreamFactory implementation. |
static class |
ExternalizableHelper.FormatAwareCompressor A DeltaCompressor wrapper implementation that removes/replaces the serialization format byte (FMT_EXT) before/after delegating to the underlying compressor. |
protected static class |
ExternalizableHelper.IntDecoratedObject Integer decorated object. |
static interface |
ExternalizableHelper.Shielded Marker interface. |
static class |
ExternalizableHelper.ShieldedDataOutputStream An OutputStream that implements DataOutput that delegates all operations other than flush and close to an underlying object that implements DataOutput. |
static class |
ExternalizableHelper.ShieldedInputStream An InputStream that delegates all operations other than close to an underlying InputStream. |
static class |
ExternalizableHelper.ShieldedObjectOutputStream An OutputStream that implements ObjectOutput that delegates all operations other than flush and close to an underlying object that implements ObjectOutput. |
static class |
ExternalizableHelper.ShieldedOutputStream An OutputStream that delegates all operations other than flush and close to an underlying OutputStream. |
static class |
ExternalizableHelper.SimpleXmlBeanClassCache An implementation XmlBeanClassCache that uses a pre-defined list of XmlBean implementations. |
static interface |
ExternalizableHelper.XmlBeanClassCache An interface for caching class reference by integer ID values. |
Field Summary | |
---|---|
static Converter |
CONVERTER_FROM_BINARY A converter from Binary to Object format, which uses the DefaultSerializer. |
static Converter |
CONVERTER_STRIP_INTDECO A pass-through Binary converter that removes an IntDecoration if present. |
static Converter |
CONVERTER_TO_BINARY A converter from Object to Binary format that uses the DefaultSerializer. |
static int |
DECO_APP_1 Decoration: Application-assignable decoration; this decoration will not be used, modified or overwritten by Coherence or other Oracle products. |
static int |
DECO_APP_2 Decoration: Application-assignable decoration; this decoration will not be used, modified or overwritten by Coherence or other Oracle products. |
static int |
DECO_APP_3 Decoration: Application-assignable decoration; this decoration will not be used, modified or overwritten by Coherence or other Oracle products. |
static int |
DECO_CUSTOM Decoration: A client specific value (opaque). |
static int |
DECO_EXPIRY Decoration: The expiry for the value. |
static int |
DECO_ID_MAX Decoration range: The maximum decoration identifier. |
static int |
DECO_ID_MIN Decoration range: The minimum decoration identifier. |
static int |
DECO_PUSHREP Decoration: Information managed on behalf of Push Replication. |
static int |
DECO_RSVD_1 Decoration: Reserved for future use by Coherence; do not use. |
static int |
DECO_RSVD_2 Decoration: Reserved for future use by Coherence; do not use. |
static int |
DECO_STORE Decoration: The persistent state for the value. |
static int |
DECO_TOPLINK Decoration: Information managed on behalf of TopLink Grid. |
static int |
DECO_TX Decoration: Information managed on behalf of the OptimisticNamedCache implementation. |
static int |
DECO_VALUE Decoration: The original value (before being decorated). |
static int |
DECO_WLS Decoration: Information managed on behalf of WebLogic. |
static Binary[] |
EMPTY_BINARY_ARRAY An empty array of Binary objects. |
protected static int |
FMT_B_ARRAY Serialization format: Byte array value. |
protected static int |
FMT_BIN_DECO Serialization format: Decorated Binary value. |
protected static int |
FMT_BIN_EXT_DECO Serialization format: Extended-range Decorated Binary value. |
protected static int |
FMT_BINARY Serialization format: Binary value. |
protected static int |
FMT_BOOLEAN Serialization format: Boolean value. |
protected static int |
FMT_BYTE Serialization format: Byte value. |
protected static int |
FMT_DECIMAL Serialization format: BigDecimal value. |
protected static int |
FMT_DOUBLE Serialization format: Double value. |
protected static int |
FMT_EXT Serialization format: A DefaultSerializer is NOT used. |
protected static int |
FMT_FLOAT Serialization format: Float value. |
protected static int |
FMT_IDO Serialization format: Integer-decorated value. |
protected static int |
FMT_INT Serialization format: Integer value. |
protected static int |
FMT_INTEGER Serialization format: BigInteger value. |
protected static int |
FMT_LONG Serialization format: Long value. |
protected static int |
FMT_NONE Serialization format: Unknown value (alias to FMT_UNKNOWN). |
protected static int |
FMT_NULL Serialization format: Null value. |
protected static int |
FMT_OBJ_EXT Serialization format: ExternalizableLite value. |
protected static int |
FMT_OBJ_SER Serialization format: Serializable value. |
protected static int |
FMT_SHORT Serialization format: Short value. |
protected static int |
FMT_STRING Serialization format: String value. |
protected static int |
FMT_UNKNOWN Serialization format: Unknown value. |
protected static int |
FMT_XML_BEAN Serialization format: XmlBean value. |
protected static int |
FMT_XML_SER Serialization format: XmlSerializable value. |
static boolean |
FORCE_RESOLVING_STREAMS Option: Always use a ResolvingObjectInputStream, even if a regular ObjectInputStream is available. |
protected static int |
MAX_DECO_HEADER_BYTES The maximum number of bytes the header of the binary-decorated value may contain. |
static java.lang.String |
PROPERTY_CONFIG The name of the system property that can be used to override the location of the ExternalizableHelper configuration file. |
static ObjectStreamFactory |
s_streamfactory Option: Configurable ObjectStreamFactory. |
static int |
TRINT_DOMAIN_SPAN Trints use 6 hexits (3 bytes), so the trint domain span is 0x01000000. |
static int |
TRINT_MAX_VALUE Trints use 6 hexits (3 bytes), so the trint maximum is 0x00FFFFFF. |
static int |
TRINT_MAX_VARIANCE Trints use 6 hexits (3 bytes), so the trint maximum variance (from a "current" value) is half the trint domain span, or 0x00800000. |
static boolean |
USE_MARSHAL_STREAMS Option: Use marshalling object streams that can read classes over the network. |
static boolean |
USE_POF_STREAMS Option: Use POF as the default serialization format. |
static boolean |
USE_XMLBEAN_CLASS_CACHE Option: Use an XmlBean class cache. |
static ExternalizableHelper.XmlBeanClassCache |
XMLBEAN_CLASS_CACHE Option: XmlBean class cache implementation. |
Constructor Summary | |
---|---|
ExternalizableHelper() |
Method Summary | |
---|---|
static Binary |
asBinary(ReadBuffer buf) Return a Binary representing the contents of the specified ReadBuffer, or null if the buffer is null. |
static int |
calculatePackedLength(int n) Calculate the number of bytes needed to store a packed integer using the variable-length format described by WriteBuffer.BufferOutput#writePackedInt(int) |
static int |
calculatePackedLength(long l) Calculate the number of bytes needed to store a packed long using the variable-length format described by WriteBuffer.BufferOutput#writePackedLong(long) |
static java.lang.String |
convertUTF(byte[] ab, int of, int cb, char[] ach) Convert binary UTF-8 encode data to a String. |
static Binary |
decorate(Binary bin, Binary[] abinDecorations) Decorate the passed Binary with the passed decorations. |
static Binary |
decorate(Binary bin, int nId, Binary binDecoration) Decorate the passed value with the specified decoration and return the resulting Binary. |
static ExternalizableHelper.IntDecoratedObject |
decorate(java.lang.Object oValue, int nDecoration) Decorate the specified value with the specified integer decoration. |
static Binary |
decorateBinary(Binary binValue, int nDecoration) Decorate the specified Binary value with the specified integer decoration. |
static Serializer |
ensureSerializer(java.lang.ClassLoader loader) Obtain a Serializer for the specified ClassLoader. |
static int |
extractIntDecoration(Binary bin) Extract a decoration value from the specified Binary that contains a representation of an IntDecoratedObject. |
static java.lang.Object |
fromBinary(Binary bin) Read an object from a Binary object. |
static java.lang.Object |
fromBinary(Binary bin, java.lang.ClassLoader loader) Read an object from a Binary object. |
static java.lang.Object |
fromBinary(Binary bin, Serializer serializer) Read an object from a Binary object using the specified Serializer. |
static java.lang.Object |
fromByteArray(byte[] ab) Read an object from a byte array. |
static java.lang.Object |
fromByteArray(byte[] ab, java.lang.ClassLoader loader) Read an object from a byte array. |
static Binary |
getDecoration(Binary bin, int nId) Extract and return the specified decoration from the passed Binary. |
static Binary[] |
getDecorations(Binary bin) Return an array containing all of the decorations from the passed Binary. |
static DeltaCompressor |
getDeltaCompressor(Serializer serializer, DeltaCompressor compressor) Return a DeltaCompressor suitable for compressing/extracting binaries produced by ExternalizableHelper using the specified serializer. |
static java.io.InputStream |
getInputStream(java.io.DataInput in) Get an InputStream for the passed DataInput object. |
static java.io.ObjectInput |
getNewObjectInput(java.io.DataInput in, java.lang.ClassLoader loader) Get a new ObjectInput for the passed DataInput, even if the passed DataInput is an ObjectInput. |
static java.io.ObjectInput |
getObjectInput(java.io.DataInput in, java.lang.ClassLoader loader) Get an ObjectInput for the passed DataInput object. |
static java.io.ObjectOutput |
getObjectOutput(java.io.DataOutput out) Get an ObjectOutput for the passed DataOutput object. |
static ObjectStreamFactory |
getObjectStreamFactory() Return the ObjectStreamFactory used to convert DataInput/Output into ObjectInput/Output streams. |
static java.io.OutputStream |
getOutputStream(java.io.DataOutput out) Get an OutputStream for the passed DataOutput object. |
static java.io.OutputStream |
getShieldedOutputStream(java.io.OutputStream out) Get a shielded OutputStream for the passed OutputStream object. |
protected static int |
getStreamFormat(java.lang.Object o) Internal: Select an optimal stream format to use to store the passed object in a stream (as used by the DefaultSerializer). |
static Binary |
getUndecorated(Binary bin) If the passed Binary is decorated, extract the original Binary value that the decorations were added to, otherwise return the passed Binary value. |
static boolean |
isDecorated(Binary bin) If the Binary is the result of serialization by ExternalizableHelper, determine if the Binary contains decorations. |
static boolean |
isIntDecorated(Binary bin) Check whether or not the specified Binary is a representation of an IntDecoratedObject. |
static boolean |
isMarshalled(java.io.DataOutput out) Determine whether the passed DataOutput handles marshalling of ObjectOutput. |
static boolean |
isResolving(java.io.DataOutput out) Determine whether the passed DataOutput handles ClassLoader resolving. |
static boolean |
isSerializable(java.lang.Object o) Determine if the resource object can be serialized using the DefaultSerializer. |
static boolean |
isSerializerCompatible(Serializer serializerThis, Serializer serializerThat) Determines whether or not the specified serializers are compatible. |
static java.lang.Class |
loadClass(java.lang.String sClass, java.lang.ClassLoader loader1, java.lang.ClassLoader loader2) Attempt to load the specified class using sequentionally all of the specified loaders, the ContextClassLoader and the current class loader. |
static java.net.URL |
loadResource(java.lang.String sName, java.lang.ClassLoader loader1, java.lang.ClassLoader loader2) Attempt to find a valid, resolvable URL for the specified resource, first by using each of the specified ClassLoaders, then using the ContextClassLoader. |
static void |
main(java.lang.String[] asArgs) Parse a hex string representing a serialized object. |
static int |
makeTrint(long l) Convert a long integer to a trint. |
static java.math.BigDecimal |
readBigDecimal(java.io.DataInput in) Read a BigDecimal from a DataInput stream. |
static java.math.BigInteger |
readBigInteger(java.io.DataInput in) Read a BigInteger from a DataInput stream. |
static boolean[] |
readBooleanArray(java.io.DataInput in) Read a packed boolean array. |
static byte[] |
readByteArray(java.io.DataInput in) Read a variable-length encoded byte array. |
static int |
readCollection(java.io.DataInput in, java.util.Collection collection, java.lang.ClassLoader loader) Read collection content from a DataInput stream and update the specified collection. |
static java.sql.Date |
readDate(java.io.DataInput in) Read a Date from a DataInput stream. |
static double[] |
readDoubleArray(java.io.DataInput in) Read an array of double numbers from a DataInput stream. |
static ExternalizableLite |
readExternalizableLite(java.io.DataInput in) Read an ExternalizableLite object from a DataInput stream. |
static ExternalizableLite |
readExternalizableLite(java.io.DataInput in, java.lang.ClassLoader loader) Read an ExternalizableLite object from a DataInput stream. |
static float[] |
readFloatArray(java.io.DataInput in) Read an array of float numbers from a DataInput stream. |
static int |
readInt(java.io.DataInput in) Read an int that uses variable length storage in the stream. |
static long |
readLong(java.io.DataInput in) Read a long that uses variable length storage in the stream. |
static int |
readMap(java.io.DataInput in, java.util.Map map, java.lang.ClassLoader loader) Read map content from a DataInput stream and update the specified map. |
static int |
readMap(java.io.DataInput in, java.util.Map map, int cBlock, java.lang.ClassLoader loader) Read map content from a DataInput stream and update the specified map using the "putAll" method. |
static java.lang.Object |
readObject(java.io.DataInput in) Read an Object from the passed DataInput object. |
static java.lang.Object |
readObject(java.io.DataInput in, java.lang.ClassLoader loader) Read an Object from the passed DataInput object. |
static java.lang.String |
readSafeUTF(java.io.DataInput in) Read a variable-length encoded UTF packed String. |
static java.lang.Object |
readSerializable(java.io.DataInput in) Read an object from a DataInput stream. |
static java.lang.Object |
readSerializable(java.io.DataInput in, java.lang.ClassLoader loader) Read an object from a DataInput stream. |
static java.lang.String[] |
readStringArray(java.io.DataInput in) Read a String array. |
static java.sql.Time |
readTime(java.io.DataInput in) Read a Time from a DataInput stream. |
static java.sql.Timestamp |
readTimestamp(java.io.DataInput in) Read a Timestamp from a DataInput stream. |
static int |
readTrint(java.io.DataInput in) Read a signed three-byte integer value from a stream. |
static int |
readUnsignedTrint(java.io.DataInput in) Read an unsigned three-byte integer value from a stream. |
static java.lang.String |
readUTF(java.io.DataInput in) Read a variable-length encoded UTF packed String. |
static XmlBean |
readXmlBean(java.io.DataInput in, java.lang.ClassLoader loader) Read an XmlBean object from a DataInput stream. |
static XmlSerializable |
readXmlSerializable(java.io.DataInput in) Read an XmlSerializable object from a DataInput stream. |
static XmlSerializable |
readXmlSerializable(java.io.DataInput in, java.lang.ClassLoader loader) Read an XmlSerializable object from a DataInput stream. |
static Binary |
removeIntDecoration(Binary bin) Remove a decoration value from the specified Binary that contains a representation of an IntDecoratedObject. |
static void |
reportIncompatibleSerializers(NamedCache cache, java.lang.String sService, Serializer serializer) Log the message explaining the serializer incompatibility between the specified cache and a service. |
static void |
setObjectStreamFactory(ObjectStreamFactory factory) Specify an ObjectStreamFactory that should be used to convert DataInput/Output into ObjectInput/Output streams. |
static Binary |
toBinary(java.lang.Object o) Write an object into a Binary object. |
static Binary |
toBinary(java.lang.Object o, Serializer serializer) Write an object into a Binary object using the specified Serializer. |
static byte[] |
toByteArray(java.lang.Object o) Write an object to a byte array. |
static byte[] |
toByteArray(java.lang.Object o, Serializer serializer) Write an object to a byte array using the specified Serializer. |
static Binary |
toLiteBinary(ExternalizableLite o) Write an ExternalizableLite object into a Binary object. |
static long |
translateTrint(int nTrint, long lCurrent) Convert a three-byte unsigned integer ("trint") to a long value. |
static Binary |
undecorate(Binary bin, int nId) Remove the specified decoration from the passed Binary. |
static void |
validateBufferSize(int cb) Verify that the requested buffer size is smaller than the configured maximum. |
static void |
writeBigDecimal(java.io.DataOutput out, java.math.BigDecimal dec) Write a BigDecimal to a DataOutput stream. |
static void |
writeBigInteger(java.io.DataOutput out, java.math.BigInteger bigint) Write a BigInteger to a DataOutput stream. |
static void |
writeBooleanArray(java.io.DataOutput out, boolean[] af) Write a packed boolean array. |
static void |
writeByteArray(java.io.DataOutput out, byte[] ab) Write a variable-length encoded byte array. |
static void |
writeCollection(java.io.DataOutput out, java.util.Collection collection) Write collection content to a DataOutput stream. |
static void |
writeDate(java.io.DataOutput out, java.sql.Date date) Write a Date to a DataOutput stream. |
static void |
writeDoubleArray(java.io.DataOutput out, double[] ad) Write an array of double numbers to a DataOutput stream. |
static void |
writeExternalizableLite(java.io.DataOutput out, ExternalizableLite o) Write an ExternalizableLite object to a DataOutput stream. |
static void |
writeFloatArray(java.io.DataOutput out, float[] afl) Write an array of float numbers to a DataOutput stream. |
static void |
writeInt(java.io.DataOutput out, int n) Write an int to a stream using a variable length of storage. |
static void |
writeLong(java.io.DataOutput out, long l) Write a long to a stream using a variable length of storage. |
static void |
writeMap(java.io.DataOutput out, java.util.Map map) Write map content to a DataOutput stream. |
static void |
writeObject(java.io.DataOutput out, java.lang.Object o) Write the specified data to the passed DataOutput object. |
static void |
writeSafeUTF(java.io.DataOutput out, java.lang.String s) Write a variable-length encoded UTF packed String. |
static void |
writeSerializable(java.io.DataOutput out, java.lang.Object o) Write an object to a DataOutput stream. |
static void |
writeStringArray(java.io.DataOutput out, java.lang.String[] as) Write a String array. |
static void |
writeTime(java.io.DataOutput out, java.sql.Time time) Write a Time to a DataOutput stream. |
static void |
writeTimestamp(java.io.DataOutput out, java.sql.Timestamp dt) Write a Timestamp to a DataOutput stream. |
static void |
writeTrint(java.io.DataOutput out, int n) Write a three-byte integer value to a stream. |
static void |
writeTrint(java.io.DataOutput out, long l) Write a three-byte integer value to a stream. |
static void |
writeUTF(java.io.DataOutput out, java.lang.String s) Write a variable-length encoded UTF packed String. |
static void |
writeXmlBean(java.io.DataOutput out, XmlBean bean) Write an XmlBean object to a DataOutput stream. |
static void |
writeXmlSerializable(java.io.DataOutput out, XmlSerializable o) Write an XmlSerializable object to a DataOutput stream. |
Field Detail |
---|
protected static final int FMT_NONE
protected static final int FMT_UNKNOWN
protected static final int FMT_NULL
protected static final int FMT_INT
protected static final int FMT_LONG
protected static final int FMT_DOUBLE
protected static final int FMT_INTEGER
protected static final int FMT_DECIMAL
protected static final int FMT_STRING
protected static final int FMT_BINARY
protected static final int FMT_B_ARRAY
protected static final int FMT_XML_SER
protected static final int FMT_OBJ_EXT
protected static final int FMT_OBJ_SER
protected static final int FMT_XML_BEAN
protected static final int FMT_IDO
protected static final int FMT_FLOAT
protected static final int FMT_SHORT
protected static final int FMT_BYTE
protected static final int FMT_BOOLEAN
protected static final int FMT_BIN_DECO
Structure is:
byte 0 : format identifier (18) byte 1 : bit mask of decoration identifiers (see DECO_* constants) byte 2 : packed int specifying the length of the first decoration byte next : binary data ...For each decoration, there is a packed int for its length, followed by its binary data. The first decoration is the decorated value itself, if present.
Note: FMT_IDO cannot be combined with FMT_BIN_DECO.
protected static final int FMT_BIN_EXT_DECO
Structure is:
byte 0 : format identifier (19) byte 1 : bit mask of decoration identifiers (see DECO_* constants), in the packed long format (1-10 bytes) byte next : packed int specifying the length of the first decoration byte next : binary data ...For each decoration, there is a packed int for its length, followed by its binary data. The first decoration is the decorated value itself, if present.
Note: FMT_IDO cannot be combined with FMT_BIN_EXT_DECO.
protected static final int FMT_EXT
public static final int DECO_ID_MIN
public static final int DECO_ID_MAX
public static final int DECO_VALUE
public static final int DECO_EXPIRY
public static final int DECO_STORE
public static final int DECO_TX
OptimisticNamedCache
implementation.
public static final int DECO_PUSHREP
public static final int DECO_RSVD_2
public static final int DECO_RSVD_1
public static final int DECO_CUSTOM
DECO_APP_1
, DECO_APP_2
and DECO_APP_3
decorations.
public static final int DECO_TOPLINK
public static final int DECO_WLS
public static final int DECO_APP_1
public static final int DECO_APP_2
public static final int DECO_APP_3
protected static final int MAX_DECO_HEADER_BYTES
public static final int TRINT_DOMAIN_SPAN
public static final int TRINT_MAX_VALUE
public static final int TRINT_MAX_VARIANCE
public static final Binary[] EMPTY_BINARY_ARRAY
public static final Converter CONVERTER_TO_BINARY
public static final Converter CONVERTER_FROM_BINARY
public static final Converter CONVERTER_STRIP_INTDECO
public static final java.lang.String PROPERTY_CONFIG
The value of this property must be the name of a resource that contains an XML document with the structure defined in the /com/tangosol/util/ExternalizableHelper.xml configuration descriptor.
public static final boolean FORCE_RESOLVING_STREAMS
public static final boolean USE_MARSHAL_STREAMS
public static final boolean USE_XMLBEAN_CLASS_CACHE
public static final ExternalizableHelper.XmlBeanClassCache XMLBEAN_CLASS_CACHE
public static final boolean USE_POF_STREAMS
public static ObjectStreamFactory s_streamfactory
Constructor Detail |
---|
public ExternalizableHelper()
Method Detail |
---|
public static byte[] toByteArray(java.lang.Object o)
o
- the object to write into a byte arrayWrapperException
- may contain an IOExceptionpublic static byte[] toByteArray(java.lang.Object o, Serializer serializer)
o
- the object to write into a byte arrayserializer
- the Serializer to useWrapperException
- may contain an IOExceptionpublic static java.lang.Object fromByteArray(byte[] ab)
ab
- the byte array containing the objectWrapperException
- may contain an IOExceptionpublic static java.lang.Object fromByteArray(byte[] ab, java.lang.ClassLoader loader)
ab
- the byte array containing the objectloader
- the ClassLoader to useWrapperException
- may contain an IOExceptionpublic static Binary toBinary(java.lang.Object o)
o
- the object to write into a Binary objectWrapperException
- may contain an IOExceptionpublic static Binary toBinary(java.lang.Object o, Serializer serializer)
o
- the object to write into a Binary objectserializer
- the Serializer to useWrapperException
- may contain an IOExceptionpublic static java.lang.Object fromBinary(Binary bin)
bin
- the Binary object containing the serialized objectWrapperException
- may contain an IOExceptionpublic static java.lang.Object fromBinary(Binary bin, java.lang.ClassLoader loader)
bin
- the Binary object containing the serialized objectloader
- the ClassLoader to useWrapperException
- may contain an IOExceptionpublic static java.lang.Object fromBinary(Binary bin, Serializer serializer)
bin
- the Binary object containing the serialized objectserializer
- the Serializer to useWrapperException
- may contain an IOExceptionpublic static Serializer ensureSerializer(java.lang.ClassLoader loader)
loader
- a ClassLoaderpublic static Binary toLiteBinary(ExternalizableLite o)
toBinary
, this method only serializes the object's content and not the identity part. To reconstruct the object frm that binary you would instantiate and "read" it as follows:
ExternalizableLite o = new MyLiteObject(); o.readExternal(bin.getBufferInput());
o
- the ExternalizableLite object to write into a Binary objectWrapperException
- may contain an IOExceptionpublic static int readTrint(java.io.DataInput in) throws java.io.IOException
in
- DataInput stream to read fromjava.io.IOException
- if an I/O exception occurspublic static int readUnsignedTrint(java.io.DataInput in) throws java.io.IOException
in
- DataInput stream to read fromjava.io.IOException
- if an I/O exception occurspublic static void writeTrint(java.io.DataOutput out, int n) throws java.io.IOException
out
- DataOutput stream to write ton
- a three-byte integer value passed as an intjava.io.IOException
- if an I/O exception occurspublic static void writeTrint(java.io.DataOutput out, long l) throws java.io.IOException
out
- DataOutput stream to write tol
- a three-byte integer value passed as an longjava.io.IOException
- if an I/O exception occurspublic static int makeTrint(long l)
l
- the long value to convert to a trintpublic static long translateTrint(int nTrint, long lCurrent)
nTrint
- the unsigned 3-byte integer value (a "trint")lCurrent
- the signed 8-byte integer value that the trint will be translated based on ("close to")public static int readInt(java.io.DataInput in) throws java.io.IOException
in
- a DataInput stream to read fromjava.io.IOException
- if an I/O exception occurspublic static int calculatePackedLength(int n)
WriteBuffer.BufferOutput#writePackedInt(int)
n
- the value to calculate the packed length ofpublic static void writeInt(java.io.DataOutput out, int n) throws java.io.IOException
out
- a DataOutput stream to write ton
- an int value to writejava.io.IOException
- if an I/O exception occurspublic static long readLong(java.io.DataInput in) throws java.io.IOException
in
- a DataInput stream to read fromjava.io.IOException
- if an I/O exception occurspublic static int calculatePackedLength(long l)
WriteBuffer.BufferOutput#writePackedLong(long)
l
- the long value to calculate the packed length ofpublic static void writeLong(java.io.DataOutput out, long l) throws java.io.IOException
out
- a DataOutput stream to write tol
- a long value to writejava.io.IOException
- if an I/O exception occurspublic static boolean[] readBooleanArray(java.io.DataInput in) throws java.io.IOException
in
- a DataInput stream to read fromjava.io.IOException
- if an I/O exception occurspublic static void writeBooleanArray(java.io.DataOutput out, boolean[] af) throws java.io.IOException
out
- a DataOutput stream to write toaf
- a boolean array value to writejava.io.IOException
- if an I/O exception occursjava.lang.NullPointerException
- if null value if passedpublic static byte[] readByteArray(java.io.DataInput in) throws java.io.IOException
in
- a DataInput stream to read fromjava.io.IOException
- if an I/O exception occurspublic static void writeByteArray(java.io.DataOutput out, byte[] ab) throws java.io.IOException
out
- a DataOutput stream to write toab
- a byte array value to writejava.io.IOException
- if an I/O exception occursjava.lang.NullPointerException
- if null value if passedpublic static java.lang.String readUTF(java.io.DataInput in) throws java.io.IOException
Note: This format changed in Coherence 3.0; previously the leading integer value was the number of characters, and currently it is the number of bytes as per the java.io package implementations.
in
- a DataInput stream to read fromjava.io.IOException
- if an I/O exception occurspublic static java.lang.String convertUTF(byte[] ab, int of, int cb, char[] ach) throws java.io.UTFDataFormatException
ab
- an array of bytes containing UTF-8 encoded charactersof
- the offset into the array of the UTF-8 data to decodecb
- the binary length in the array of the UTF-8 data to decodeach
- a temp char array large enough to convert the UTF intojava.io.UTFDataFormatException
- if the UTF data is corruptpublic static void writeUTF(java.io.DataOutput out, java.lang.String s) throws java.io.IOException
Note: This format changed in Coherence 3.0; previously the leading integer value was the number of characters, and currently it is the number of bytes as per the java.io package implementations.
out
- a DataOutput stream to write tos
- a String value to writejava.io.IOException
- if an I/O exception occursjava.lang.NullPointerException
- if null value if passedpublic static java.lang.String readSafeUTF(java.io.DataInput in) throws java.io.IOException
Note: This format changed in Coherence 3.0; previously the leading integer value was the number of characters, and currently it is the number of bytes as per the java.io package implementations.
in
- a DataInput stream to read fromjava.io.IOException
- if an I/O exception occurspublic static void writeSafeUTF(java.io.DataOutput out, java.lang.String s) throws java.io.IOException
Note: This format changed in Coherence 3.0; previously the leading integer value was the number of characters, and currently it is the number of bytes as per the java.io package implementations.
out
- a DataOutput stream to write tos
- a String value to write (could be null)java.io.IOException
- if an I/O exception occurspublic static java.lang.String[] readStringArray(java.io.DataInput in) throws java.io.IOException
in
- a DataInput stream to read fromjava.io.IOException
- if an I/O exception occurspublic static void writeStringArray(java.io.DataOutput out, java.lang.String[] as) throws java.io.IOException
out
- a DataOutput stream to write toas
- a String array to writejava.io.IOException
- if an I/O exception occursjava.lang.NullPointerException
- if null value if passedpublic static java.math.BigInteger readBigInteger(java.io.DataInput in) throws java.io.IOException
in
- a DataInput stream to read fromjava.io.IOException
- if an I/O exception occurspublic static void writeBigInteger(java.io.DataOutput out, java.math.BigInteger bigint) throws java.io.IOException
out
- a DataOutput stream to write tobigint
- a BigInteger value to writejava.io.IOException
- if an I/O exception occursjava.lang.NullPointerException
- if null value if passedpublic static java.math.BigDecimal readBigDecimal(java.io.DataInput in) throws java.io.IOException
in
- a DataInput stream to read fromjava.io.IOException
- if an I/O exception occurspublic static void writeBigDecimal(java.io.DataOutput out, java.math.BigDecimal dec) throws java.io.IOException
out
- a DataOutput stream to write todec
- a BigDecimal value to writejava.io.IOException
- if an I/O exception occursjava.lang.NullPointerException
- if null value if passedpublic static java.sql.Date readDate(java.io.DataInput in) throws java.io.IOException
in
- a DataInput stream to read fromjava.io.IOException
- if an I/O exception occurspublic static void writeDate(java.io.DataOutput out, java.sql.Date date) throws java.io.IOException
out
- a DataOutput stream to write todate
- a Date value to writejava.io.IOException
- if an I/O exception occursjava.lang.NullPointerException
- if null value if passedpublic static java.sql.Time readTime(java.io.DataInput in) throws java.io.IOException
in
- a DataInput stream to read fromjava.io.IOException
- if an I/O exception occurspublic static void writeTime(java.io.DataOutput out, java.sql.Time time) throws java.io.IOException
out
- a DataOutput stream to write totime
- a Time value to writejava.io.IOException
- if an I/O exception occursjava.lang.NullPointerException
- if null value if passedpublic static java.sql.Timestamp readTimestamp(java.io.DataInput in) throws java.io.IOException
in
- a DataInput stream to read fromjava.io.IOException
- if an I/O exception occurspublic static void writeTimestamp(java.io.DataOutput out, java.sql.Timestamp dt) throws java.io.IOException
out
- a DataOutput stream to write todt
- a Timestamp value to writejava.io.IOException
- if an I/O exception occursjava.lang.NullPointerException
- if null value if passedpublic static float[] readFloatArray(java.io.DataInput in) throws java.io.IOException
in
- a DataInput stream to read fromjava.io.IOException
- if an I/O exception occurspublic static void writeFloatArray(java.io.DataOutput out, float[] afl) throws java.io.IOException
out
- a DataOutput stream to write toafl
- an array of floats to writejava.io.IOException
- if an I/O exception occursjava.lang.NullPointerException
- if null value if passedpublic static double[] readDoubleArray(java.io.DataInput in) throws java.io.IOException
in
- a DataInput stream to read fromjava.io.IOException
- if an I/O exception occurspublic static void writeDoubleArray(java.io.DataOutput out, double[] ad) throws java.io.IOException
out
- a DataOutput stream to write toad
- an array of doubles to writejava.io.IOException
- if an I/O exception occursjava.lang.NullPointerException
- if null value if passedpublic static int readMap(java.io.DataInput in, java.util.Map map, java.lang.ClassLoader loader) throws java.io.IOException
This method reads entries from the stream and "puts" them into the specified map one-by-one using the "put" method.
in
- a DataInput stream to read frommap
- a map to add the entries intoloader
- the ClassLoader to usejava.io.IOException
- if an I/O exception occursreadMap(DataInput, Map, int, ClassLoader)
public static int readMap(java.io.DataInput in, java.util.Map map, int cBlock, java.lang.ClassLoader loader) throws java.io.IOException
While the method readMap(DataInput, Map, ClassLoader)
reads entries from the stream and "puts" them into the specified map one-by-one, this method collects up to the "block" number of entries into a temporary map and then updates the passed in map using the "putAll" method.
in
- a DataInput stream to read frommap
- a map to add the entries intocBlock
- the maximum number of entries to read at onceloader
- the ClassLoader to usejava.io.IOException
- if an I/O exception occurspublic static void writeMap(java.io.DataOutput out, java.util.Map map) throws java.io.IOException
out
- a DataOutput stream to write tomap
- the map to writejava.io.IOException
- if an I/O exception occurspublic static int readCollection(java.io.DataInput in, java.util.Collection collection, java.lang.ClassLoader loader) throws java.io.IOException
This method reads elements from the stream and adds them into the specified collection one-by-one using the "add" method.
in
- a DataInput stream to read fromcollection
- a collection to add the elements intoloader
- the ClassLoader to usejava.io.IOException
- if an I/O exception occurspublic static void writeCollection(java.io.DataOutput out, java.util.Collection collection) throws java.io.IOException
out
- a DataOutput stream to write tocollection
- the collection to writejava.io.IOException
- if an I/O exception occurspublic static XmlSerializable readXmlSerializable(java.io.DataInput in) throws java.io.IOException
in
- a DataInput stream to read fromjava.io.IOException
- if an I/O exception occurspublic static XmlSerializable readXmlSerializable(java.io.DataInput in, java.lang.ClassLoader loader) throws java.io.IOException
in
- a DataInput stream to read fromloader
- the ClassLoader to usejava.io.IOException
- if an I/O exception occurspublic static void writeXmlSerializable(java.io.DataOutput out, XmlSerializable o) throws java.io.IOException
out
- a DataOutput stream to write too
- an XmlSerializable value to writejava.io.IOException
- if an I/O exception occursjava.lang.NullPointerException
- if null value if passedpublic static ExternalizableLite readExternalizableLite(java.io.DataInput in) throws java.io.IOException
in
- a DataInput stream to read fromjava.io.IOException
- if an I/O exception occurspublic static ExternalizableLite readExternalizableLite(java.io.DataInput in, java.lang.ClassLoader loader) throws java.io.IOException
in
- a DataInput stream to read fromloader
- the ClassLoader to usejava.io.IOException
- if an I/O exception occurspublic static void writeExternalizableLite(java.io.DataOutput out, ExternalizableLite o) throws java.io.IOException
out
- a DataOutput stream to write too
- an ExternalizableLite value to writejava.io.IOException
- if an I/O exception occursjava.lang.NullPointerException
- if null value if passedpublic static XmlBean readXmlBean(java.io.DataInput in, java.lang.ClassLoader loader) throws java.io.IOException
in
- a DataInput stream to read fromloader
- the ClassLoader to usejava.io.IOException
- if an I/O exception occurspublic static void writeXmlBean(java.io.DataOutput out, XmlBean bean) throws java.io.IOException
out
- a DataOutput stream to write tobean
- an XmlBean value to writejava.io.IOException
- if an I/O exception occursjava.lang.NullPointerException
- if null value if passedpublic static java.lang.Object readSerializable(java.io.DataInput in) throws java.io.IOException
in
- a DataInput stream to read fromjava.io.IOException
- if an I/O exception occurspublic static java.lang.Object readSerializable(java.io.DataInput in, java.lang.ClassLoader loader) throws java.io.IOException
in
- a DataInput stream to read fromloader
- the ClassLoader to usejava.io.IOException
- if an I/O exception occurspublic static void writeSerializable(java.io.DataOutput out, java.lang.Object o) throws java.io.IOException
out
- a DataOutput stream to write too
- a value object to writejava.io.IOException
- if an I/O exception occurspublic static java.lang.Object readObject(java.io.DataInput in) throws java.io.IOException
in
- the DataInput stream to read an object fromjava.io.IOException
- if an I/O exception occurspublic static java.lang.Object readObject(java.io.DataInput in, java.lang.ClassLoader loader) throws java.io.IOException
in
- the DataInput stream to read an object fromloader
- the ClassLoader to usejava.io.IOException
- if an I/O exception occurspublic static void writeObject(java.io.DataOutput out, java.lang.Object o) throws java.io.IOException
out
- the DataOutput stream to write too
- the data to write to the DataOutput; may be nulljava.io.IOException
- if an I/O exception occurspublic static void validateBufferSize(int cb)
cb
- size of the buffer being requestedjava.nio.BufferOverflowException
- if cb > MAX_BUFFER
public static DeltaCompressor getDeltaCompressor(Serializer serializer, DeltaCompressor compressor)
serializer
- the serializer whose produced binary format is consumed by the specified compressorcompressor
- the compressorpublic static java.lang.Class loadClass(java.lang.String sClass, java.lang.ClassLoader loader1, java.lang.ClassLoader loader2) throws java.lang.ClassNotFoundException
sClass
- the class nameloader1
- first ClassLoader to tryloader2
- second ClassLoader to tryjava.lang.ClassNotFoundException
- if all the attempts failpublic static java.net.URL loadResource(java.lang.String sName, java.lang.ClassLoader loader1, java.lang.ClassLoader loader2)
sName
- the resource nameloader1
- first ClassLoader to tryloader2
- second ClassLoader to trypublic static java.io.InputStream getInputStream(java.io.DataInput in)
in
- an Object implementing the DataInput interfacepublic static java.io.OutputStream getOutputStream(java.io.DataOutput out)
out
- an Object implementing the DataOutput interfacepublic static java.io.OutputStream getShieldedOutputStream(java.io.OutputStream out)
out
- an OutputStreampublic static java.io.ObjectInput getObjectInput(java.io.DataInput in, java.lang.ClassLoader loader) throws java.io.IOException
in
- an Object implementing the DataInput interfaceloader
- the ClassLoader to usejava.io.IOException
- if an I/O exception occurspublic static java.io.ObjectInput getNewObjectInput(java.io.DataInput in, java.lang.ClassLoader loader) throws java.io.IOException
in
- an Object implementing the DataInput interfaceloader
- the ClassLoader to usein
java.io.IOException
- if an I/O exception occurspublic static java.io.ObjectOutput getObjectOutput(java.io.DataOutput out) throws java.io.IOException
out
- an Object implementing the DataOutput interfacejava.io.IOException
- if an I/O exception occurspublic static boolean isMarshalled(java.io.DataOutput out)
out
- an object implementing DataOutputjava.io.IOException
- if an I/O exception occurspublic static boolean isResolving(java.io.DataOutput out)
out
- an object implementing DataOutputpublic static ObjectStreamFactory getObjectStreamFactory()
public static void setObjectStreamFactory(ObjectStreamFactory factory)
Warning: This facility should be used with extreme care; failure to set the ObjectStreamFactory identically on all cluster nodes may render some of all clustered services completely inoperable,
factory
- the ObjectStreamFactory to usepublic static boolean isSerializable(java.lang.Object o)
protected static int getStreamFormat(java.lang.Object o)
o
- an Objectpublic static boolean isSerializerCompatible(Serializer serializerThis, Serializer serializerThat)
serializerThis
- the first SerializerserializerThis
- the second Serializerpublic static void reportIncompatibleSerializers(NamedCache cache, java.lang.String sService, Serializer serializer)
cache
- the NamedCachce referencesService
- the service nameserializer
- the serializer used by the servicepublic static boolean isDecorated(Binary bin)
Note: This method can only be used against Binary values that result from serialization by ExternalizableHelper or Binary values that are already decorated.
bin
- the Binary to checkpublic static Binary decorate(Binary bin, int nId, Binary binDecoration)
The decoration id must be in range defined by DECO_ID_MIN
and DECO_ID_MAX
. A series of DECO_* constants are defined for the pre-approved decorations, including:
DECO_VALUE
stores the original, undecorated value;DECO_EXPIRY
, DECO_STORE
, DECO_TX
and DECO_PUSHREP
are used by various facilities of Coherence;DECO_TOPLINK
and DECO_WLS
are assigned to Oracle products;DECO_APP_1
, DECO_APP_2
and DECO_APP_3
are made available for use by application developers;DECO_CUSTOM
is another application-definable decoration, but one that has also been used by Oracle frameworks and products in the past, which means that a potential exists for collisions.All other potential decoration id values are reserved. Product and framework developers that require a new decoration id to be assigned to them should contact the Coherence product development team.
Note: This method can only be used against Binary values that result from serialization by ExternalizableHelper or Binary values that are already decorated.
bin
- the Binary to decorate, which may already be decoratednId
- the identifier for the decoration, one of the DECO_* constantsbinDecoration
- the decoration to apply; a null value will remove the specified decorationpublic static Binary decorate(Binary bin, Binary[] abinDecorations)
"value"
decoration.
Note: This method can only be used against Binary values that result from serialization by ExternalizableHelper or Binary values that are already decorated.
bin
- the Binary to decorate, which may already be decorated; may be nullabinDecorations
- the decorations to apply; each non-null element is assumed to be a decoration to add whose identifier is its index in the array; the array contents will not be modified by this methodpublic static Binary getDecoration(Binary bin, int nId)
Note: This method can only be used against Binary values that result from serialization by ExternalizableHelper or Binary values that are already decorated.
bin
- the Binary that may be decoratednId
- the identifier for the decorationpublic static Binary[] getDecorations(Binary bin)
If the passed value is not decorated, then the result is a single- element array containing the undecorated value, which is the DECO_VALUE decoration.
Note: This method can only be used against Binary values that result from serialization by ExternalizableHelper or Binary values that are already decorated.
bin
- the Binary that may be decoratedpublic static Binary undecorate(Binary bin, int nId)
Note: This method can only be used against Binary values that result from serialization by ExternalizableHelper or Binary values that are already decorated.
bin
- the Binary to undecoratenId
- the identifier for the decoration to removepublic static Binary getUndecorated(Binary bin)
Note: This method can only be used against Binary values that result from serialization by ExternalizableHelper or Binary values that are already decorated.
public static Binary asBinary(ReadBuffer buf)
buf
- the read bufferpublic static void main(java.lang.String[] asArgs)
Example:
java com.tangosol.util.ExternalizableHelper 0x0603486921
public static ExternalizableHelper.IntDecoratedObject decorate(java.lang.Object oValue, int nDecoration)
oValue
- the value to be decoratednDecoration
- the integer decorationpublic static Binary decorateBinary(Binary binValue, int nDecoration)
binValue
- the Binary value to be decoratednDecoration
- the integer decorationpublic static boolean isIntDecorated(Binary bin)
bin
- the Binary objectpublic static int extractIntDecoration(Binary bin)
bin
- the Binary objectpublic static Binary removeIntDecoration(Binary bin)
bin
- the Binary object
|
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 |