org.apache.ignite.internal.binary

Class BinaryMarshaller

java.lang.Object

org.apache.ignite.marshaller.AbstractMarshaller

org.apache.ignite.internal.binary.BinaryMarshaller

All Implemented Interfaces:

Marshaller

public class BinaryMarshaller
extends AbstractMarshaller

Implementation of Marshaller that lets to serialize and deserialize all objects in the binary format.

Field Summary

Fields inherited from class org.apache.ignite.marshaller.AbstractMarshaller

ctx, DFLT_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
BinaryMarshaller()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	available() Checks whether BinaryMarshaller is able to work on the current JVM.
MarshallerContext	getContext() Returns currently set MarshallerContext.
byte[]	marshal(Object obj) Marshals object to byte array.
void	marshal(Object obj, OutputStream out) Marshals object to the output stream.
void	onUndeploy(ClassLoader ldr) Undeployment callback invoked when class loader is being undeployed.
<T> T	unmarshal(byte[] bytes, ClassLoader clsLdr) Unmarshals object from byte array using given class loader.
<T> T	unmarshal(InputStream in, ClassLoader clsLdr) Unmarshals object from the input stream using given class loader.

Methods inherited from class org.apache.ignite.marshaller.AbstractMarshaller

setContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BinaryMarshaller

public BinaryMarshaller()

Method Detail

available

public static boolean available()

Checks whether BinaryMarshaller is able to work on the current JVM.

As long as BinaryMarshaller uses JVM-private API, which is not guaranteed to be available on all JVM, this method should be called to ensure marshaller could work properly.

Result of this method is automatically checked in constructor.

Returns:

true if BinaryMarshaller can work on the current JVM or false if it can't.

getContext

public MarshallerContext getContext()

Returns currently set MarshallerContext.

Returns:

Marshaller context.

marshal

public byte[] marshal(@Nullable
             Object obj)
               throws IgniteCheckedException

Marshals object to byte array.

Specified by:

marshal in interface Marshaller

Overrides:

marshal in class AbstractMarshaller

Parameters:

obj - Object to marshal.

Returns:

Byte array.

Throws:

IgniteCheckedException - If marshalling failed.

marshal

public void marshal(@Nullable
           Object obj,
           OutputStream out)
             throws IgniteCheckedException

Marshals object to the output stream. This method should not close given output stream.

Parameters:

obj - Object to marshal.

out - Output stream to marshal into.

Throws:

IgniteCheckedException - If marshalling failed.

unmarshal

public <T> T unmarshal(byte[] bytes,
              @Nullable
              ClassLoader clsLdr)
            throws IgniteCheckedException

Unmarshals object from byte array using given class loader.

Specified by:

unmarshal in interface Marshaller

Overrides:

unmarshal in class AbstractMarshaller

Type Parameters:

T - Type of unmarshalled object.

Parameters:

bytes - Byte array.

clsLdr - Class loader to use.

Returns:

Unmarshalled object.

Throws:

IgniteCheckedException - If unmarshalling failed.

unmarshal

public <T> T unmarshal(InputStream in,
              @Nullable
              ClassLoader clsLdr)
            throws IgniteCheckedException

Unmarshals object from the input stream using given class loader. This method should not close given input stream.

Type Parameters:

T - Type of unmarshalled object.

Parameters:

in - Input stream.

clsLdr - Class loader to use.

Returns:

Unmarshalled object.

Throws:

IgniteCheckedException - If unmarshalling failed.

onUndeploy

public void onUndeploy(ClassLoader ldr)

Undeployment callback invoked when class loader is being undeployed. Some marshallers may want to clean their internal state that uses the undeployed class loader somehow.

Specified by:

onUndeploy in class AbstractMarshaller

Parameters:

ldr - Class loader being undeployed.