public abstract class AbstractDelegatingMarshaller extends Object implements StreamingMarshaller
Modifier and Type | Field and Description |
---|---|
protected StreamingMarshaller |
marshaller |
Constructor and Description |
---|
AbstractDelegatingMarshaller() |
Modifier and Type | Method and Description |
---|---|
void |
finishObjectInput(ObjectInput oi)
Finish using the given ObjectInput.
|
void |
finishObjectOutput(ObjectOutput oo)
Finish using the given ObjectOutput.
|
BufferSizePredictor |
getBufferSizePredictor(Object o)
Returns a marshalled payload size predictor for a particular type.
|
boolean |
isMarshallable(Object o)
A method that checks whether the given object is marshallable as per the rules of this marshaller.
|
Object |
objectFromByteBuffer(byte[] buf)
Unmarshalls an object from a byte array.
|
Object |
objectFromByteBuffer(byte[] buf,
int offset,
int length)
Unmarshalls an object from a specific portion of a byte array.
|
Object |
objectFromInputStream(InputStream is)
Unmarshall an object from an
InputStream |
Object |
objectFromObjectStream(ObjectInput in)
Unmarshalls an object from an
ObjectInput |
ByteBuffer |
objectToBuffer(Object o)
A method that returns an instance of
ByteBuffer , which allows direct access to the byte
array with minimal array copying |
byte[] |
objectToByteBuffer(Object obj)
Marshalls an object to a byte array.
|
byte[] |
objectToByteBuffer(Object obj,
int estimatedSize)
Marshalls an object to a byte array.
|
void |
objectToObjectStream(Object obj,
ObjectOutput out)
Marshalls an object to a given
ObjectOutput |
ObjectInput |
startObjectInput(InputStream is,
boolean isReentrant)
Create and open a new ObjectInput for the given input stream.
|
ObjectOutput |
startObjectOutput(OutputStream os,
boolean isReentrant,
int estimatedSize)
Create and open an ObjectOutput instance for the given output stream.
|
void |
stop()
Stop the marshaller.
|
start
protected StreamingMarshaller marshaller
public void stop()
StreamingMarshaller
stop
in interface StreamingMarshaller
public ObjectOutput startObjectOutput(OutputStream os, boolean isReentrant, int estimatedSize)
StreamingMarshaller
Create and open an ObjectOutput instance for the given output stream. This method should be used for opening data outputs when multiple objectToObjectStream() calls will be made before the stream is closed by calling finishObjectOutput().
This method also takes a boolean that represents whether this particular call to startObjectOutput() is reentrant or not. A call to startObjectOutput() should be marked reentrant whenever a 2nd or more calls to this method are made without having called finishObjectOutput() first.
To potentially speed up calling startObjectOutput multiple times in a non-reentrant way, i.e. startObjectOutput/finishObjectOutput...startObjectOutput/finishObjectOutput...etc, which is is the most common case, the StreamingMarshaller implementation could potentially use some mechanisms to speed up this startObjectOutput call.
On the other hand, when a call is reentrant, i.e. startObjectOutput/startObjectOutput(reentrant)...finishObjectOutput/finishObjectOutput,
the StreamingMarshaller implementation might treat it differently. An example of reentrancy would be marshalling of MarshalledValue
.
When sending or storing a MarshalledValue, a call to startObjectOutput() would occur so that the stream is open and
following, a 2nd call could occur so that MarshalledValue's raw byte array version is calculated and sent across.
This enables storing as binary on the receiver side which is performance gain. The StreamingMarshaller implementation could decide
that it needs a separate ObjectOutput or similar for the 2nd call since it's aim is only to get the raw byte array version
and the close finish with it.
startObjectOutput
in interface StreamingMarshaller
os
- output streamisReentrant
- whether the call is reentrant or not.estimatedSize
- estimated size in bytes of the output. Only meant as a possible performance optimization.public void finishObjectOutput(ObjectOutput oo)
StreamingMarshaller
finishObjectOutput
in interface StreamingMarshaller
oo
- data output that finished usingpublic void objectToObjectStream(Object obj, ObjectOutput out)
StreamingMarshaller
ObjectOutput
objectToObjectStream
in interface StreamingMarshaller
obj
- object to marshallout
- stream to marshall topublic ObjectInput startObjectInput(InputStream is, boolean isReentrant)
StreamingMarshaller
Create and open a new ObjectInput for the given input stream. This method should be used for opening data inputs when multiple objectFromObjectStream() calls will be made before the stream is closed.
This method also takes a boolean that represents whether this particular call to startObjectInput() is reentrant or not. A call to startObjectInput() should be marked reentrant whenever a 2nd or more calls to this method are made without having called finishObjectInput() first.
To potentially speed up calling startObjectInput multiple times in a non-reentrant way, i.e. startObjectInput/finishObjectInput...startObjectInput/finishObjectInput...etc, which is is the most common case, the StreamingMarshaller implementation could potentially use some mechanisms to speed up this startObjectInput call.
startObjectInput
in interface StreamingMarshaller
is
- input streamisReentrant
- whether the call is reentrant or not.public void finishObjectInput(ObjectInput oi)
StreamingMarshaller
finishObjectInput
in interface StreamingMarshaller
oi
- data input that finished usingpublic Object objectFromObjectStream(ObjectInput in)
StreamingMarshaller
ObjectInput
objectFromObjectStream
in interface StreamingMarshaller
in
- stream to unmarshall frompublic Object objectFromInputStream(InputStream is)
StreamingMarshaller
InputStream
objectFromInputStream
in interface StreamingMarshaller
is
- stream to unmarshall frompublic byte[] objectToByteBuffer(Object obj, int estimatedSize)
Marshaller
objectToByteBuffer
in interface Marshaller
obj
- object to convert to a byte array. Must not be null.estimatedSize
- an estimate of how large the resulting byte array may bepublic byte[] objectToByteBuffer(Object obj)
Marshaller
objectToByteBuffer
in interface Marshaller
obj
- object to convert to a byte array. Must not be null.public Object objectFromByteBuffer(byte[] buf)
Marshaller
objectFromByteBuffer
in interface Marshaller
buf
- byte array containing the binary representation of an object. Must not be null.public Object objectFromByteBuffer(byte[] buf, int offset, int length)
Marshaller
objectFromByteBuffer
in interface Marshaller
buf
- byte array containing the binary representation of an object. Must not be null.offset
- point in buffer to start readinglength
- number of bytes to considerpublic ByteBuffer objectToBuffer(Object o)
Marshaller
ByteBuffer
, which allows direct access to the byte
array with minimal array copyingobjectToBuffer
in interface Marshaller
o
- object to marshallpublic boolean isMarshallable(Object o)
Marshaller
isMarshallable
in interface Marshaller
o
- object to verify whether it's marshallable or notpublic BufferSizePredictor getBufferSizePredictor(Object o)
Marshaller
getBufferSizePredictor
in interface Marshaller
o
- Object for which serialized predictor will be returnedBufferSizePredictor
Copyright © 2015 JBoss, a division of Red Hat. All rights reserved.