Package org.apache.ignite.internal.binary

Class BinaryObjectImpl

java.lang.Object

org.apache.ignite.internal.binary.BinaryObjectExImpl

org.apache.ignite.internal.binary.BinaryObjectImpl

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, BinaryObject, BinaryObjectEx, CacheObject, KeyCacheObject, Message

public final class BinaryObjectImpl
extends BinaryObjectExImpl
implements Externalizable, KeyCacheObject

Binary object implementation.

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.apache.ignite.internal.processors.cache.CacheObject

TYPE_BINARY, TYPE_BINARY_ENUM, TYPE_BYTE_ARR, TYPE_REGULAR

Fields inherited from interface org.apache.ignite.plugin.extensions.communication.Message

DIRECT_TYPE_SIZE

Constructor Summary

Constructors

Constructor	Description
BinaryObjectImpl()	For Externalizable.
BinaryObjectImpl(BinaryContext ctx, byte[] bytes)
BinaryObjectImpl(BinaryContext ctx, byte[] arr, int start)
BinaryObjectImpl(BinaryContext ctx, byte[] valBytes, CacheObjectContext coCtx)

Method Summary

Modifier and Type	Method	Description
byte[]	array()
byte	cacheObjectType()
BinaryObject	clone()	Copies this binary object.
static int	compareForDml(Object first, Object second)	Compare two objects for DML operation.
BinaryContext	context()	Get binary context.
void	context(BinaryContext ctx)
KeyCacheObject	copy(int part)
BinarySerializedFieldComparator	createFieldComparator()	Create field comparator.
BinarySchema	createSchema()	Create schema for object.
int	dataStartOffset()	Get offset of data begin.
<T> T	deserialize()	Gets fully deserialized instance of binary object.
<T> T	deserialize(@Nullable ClassLoader ldr)	Gets fully deserialized instance of binary object.
BinaryObjectImpl	detach()
BinaryObjectImpl	detach(boolean checkCrossObjReferences)
void	detachAllowed(boolean detachAllowed)
boolean	detached()
short	directType()	Gets message type.
<F> F	field(int fieldId)	Gets field value.
<F> F	field(String fieldName)	Gets field value.
protected <F> F	field(BinaryReaderHandles rCtx, String fieldName)
<F> F	fieldByOrder(int order)	Get field by offset.
byte	fieldsCount()	Gets fields count.
void	finishUnmarshal(CacheObjectValueContext ctx, ClassLoader ldr)
int	footerStartOffset()	Get offset of the footer begin.
boolean	hasArray()
boolean	hasField(String fieldName)	Checks whether field exists in the object.
int	hashCode()
boolean	hasSchema()
boolean	internal()
boolean	isFlagSet(short flag)	Check if flag set.
boolean	isPlatformType()	Gets flag indicating whether object value is a platform type.
int	length()
long	offheapAddress()
void	onAckReceived()	Method called when ack message received.
int	partition()
void	partition(int part)	Sets partition ID for this key.
CacheObject	prepareForCache(CacheObjectContext ctx)	Prepares cache object for cache (e.g. copies user-provided object if needed).
void	prepareMarshal(CacheObjectValueContext ctx)
int	putValue(long addr)
boolean	putValue(ByteBuffer buf)
boolean	putValue(ByteBuffer buf, int off, int len)
@Nullable BinaryType	rawType()	Get raw type.
void	readExternal(ObjectInput in)
boolean	readFrom(ByteBuffer buf, MessageReader reader)	Reads this message from provided byte buffer.
int	schemaId()	Get schema ID.
int	size()	Get the size of the object
int	start()
String	toString()
@Nullable BinaryType	type()	Gets type information for this binary object.
int	typeId()
<T> T	value(CacheObjectValueContext ctx, boolean cpy)
<T> T	value(CacheObjectValueContext ctx, boolean cpy, ClassLoader ldr)	Deserializes a value from an internal representation.
byte[]	valueBytes(CacheObjectValueContext ctx)
int	valueBytesLength(CacheObjectContext ctx)
void	writeExternal(ObjectOutput out)
boolean	writeFieldByOrder(int order, ByteBuffer buf)	Writes field value defined by the given field offset to the given byte buffer.
boolean	writeTo(ByteBuffer buf, MessageWriter writer)	Writes this message to provided byte buffer.

Methods inherited from class org.apache.ignite.internal.binary.BinaryObjectExImpl

enumName, enumOrdinal, equals, hasCircularReferences, toBuilder

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BinaryObjectImpl

public BinaryObjectImpl()

For Externalizable.

BinaryObjectImpl

public BinaryObjectImpl(BinaryContext ctx,
                        byte[] arr,
                        int start)

Parameters:

ctx - Context.

arr - Array.

start - Start.

BinaryObjectImpl

public BinaryObjectImpl(BinaryContext ctx,
                        byte[] bytes)

Parameters:

ctx - Context.

bytes - Array/ValBytes.

BinaryObjectImpl

public BinaryObjectImpl(BinaryContext ctx,
                        byte[] valBytes,
                        CacheObjectContext coCtx)

Parameters:

ctx - Context.

valBytes - Value bytes.

coCtx - Cache object context.

Method Detail

copy

public KeyCacheObject copy(int part)

Specified by:

copy in interface KeyCacheObject

Parameters:

part - Partition ID.

Returns:

Copy of this object with given partition set.

partition

public int partition()

Specified by:

partition in interface KeyCacheObject

Returns:

Partition ID for this key or -1 if it is unknown.

partition

public void partition(int part)

Sets partition ID for this key.

Specified by:

partition in interface KeyCacheObject

Parameters:

part - Partition ID.

cacheObjectType

public byte cacheObjectType()

Specified by:

cacheObjectType in interface CacheObject

Returns:

Object type.

isPlatformType

public boolean isPlatformType()

Gets flag indicating whether object value is a platform type. Platform types will be automatically deserialized on public API cache operations regardless whether IgniteCache.withKeepBinary() is used or not.

Specified by:

isPlatformType in interface CacheObject

Returns:

Platform type flag.

internal

public boolean internal()

Specified by:

internal in interface KeyCacheObject

Returns:

True if internal cache key.

value

@Nullable
public <T> T value(CacheObjectValueContext ctx,
                   boolean cpy)

Specified by:

value in interface CacheObject

Parameters:

ctx - Context.

cpy - If true need to copy value.

Returns:

Value.

value

@Nullable
public <T> T value(CacheObjectValueContext ctx,
                   boolean cpy,
                   ClassLoader ldr)

Deserializes a value from an internal representation.

Specified by:

value in interface CacheObject

Parameters:

ctx - Context.

cpy - If true need to copy value.

ldr - Class loader, if it is null, default class loader will be used.

Returns:

Value.

valueBytes

public byte[] valueBytes(CacheObjectValueContext ctx)
                  throws IgniteCheckedException

Specified by:

valueBytes in interface CacheObject

Parameters:

ctx - Context.

Returns:

Value bytes.

Throws:

IgniteCheckedException - If failed.

putValue

public boolean putValue(ByteBuffer buf)
                 throws IgniteCheckedException

Specified by:

putValue in interface CacheObject

Parameters:

buf - Buffer to write value to.

Returns:

True if value was successfully written, false if there was not enough space in the buffer.

Throws:

IgniteCheckedException - If failed.

putValue

public int putValue(long addr)
             throws IgniteCheckedException

Specified by:

putValue in interface CacheObject

Parameters:

addr - Address tp write value to.

Returns:

Number of bytes written.

Throws:

IgniteCheckedException - If failed.

putValue

public boolean putValue(ByteBuffer buf,
                        int off,
                        int len)
                 throws IgniteCheckedException

Specified by:

putValue in interface CacheObject

Parameters:

buf - Buffer to write value to.

off - Offset in source binary data.

len - Length of the data to write.

Returns:

True if value was successfully written, false if there was not enough space in the buffer.

Throws:

IgniteCheckedException - If failed.

valueBytesLength

public int valueBytesLength(CacheObjectContext ctx)
                     throws IgniteCheckedException

Specified by:

valueBytesLength in interface CacheObject

Parameters:

ctx - Cache object context.

Returns:

Size required to store this value object.

Throws:

IgniteCheckedException - If failed.

prepareForCache

public CacheObject prepareForCache(CacheObjectContext ctx)

Prepares cache object for cache (e.g. copies user-provided object if needed).

Specified by:

prepareForCache in interface CacheObject

Parameters:

ctx - Cache context.

Returns:

Instance to store in cache.

finishUnmarshal

public void finishUnmarshal(CacheObjectValueContext ctx,
                            ClassLoader ldr)
                     throws IgniteCheckedException

Specified by:

finishUnmarshal in interface CacheObject

Parameters:

ctx - Context.

ldr - Class loader.

Throws:

IgniteCheckedException - If failed.

prepareMarshal

public void prepareMarshal(CacheObjectValueContext ctx)

Specified by:

prepareMarshal in interface CacheObject

Parameters:

ctx - Context.

length

public int length()

Specified by:

length in class BinaryObjectExImpl

Returns:

Length.

detach

public BinaryObjectImpl detach()

Returns:

Detached binary object.

detach

public BinaryObjectImpl detach(boolean checkCrossObjReferences)

Returns:

Detached binary object.

detached

public boolean detached()

Returns:

Detached or not.

detachAllowed

public void detachAllowed(boolean detachAllowed)

Parameters:

detachAllowed - Detach allowed flag.

context

public BinaryContext context()

Get binary context.

Specified by:

context in class BinaryObjectExImpl

Returns:

Binary context.

context

public void context(BinaryContext ctx)

Parameters:

ctx - Context.

array

public byte[] array()

Specified by:

array in class BinaryObjectExImpl

Returns:

Object array if object is array based, otherwise null.

start

public int start()

Specified by:

start in class BinaryObjectExImpl

Returns:

Object start.

offheapAddress

public long offheapAddress()

Specified by:

offheapAddress in class BinaryObjectExImpl

Returns:

Object offheap address is object is offheap based, otherwise 0.

hasArray

public boolean hasArray()

Specified by:

hasArray in class BinaryObjectExImpl

Returns:

True if object is array based.

isFlagSet

public boolean isFlagSet(short flag)

Check if flag set.

Specified by:

isFlagSet in interface BinaryObjectEx

Parameters:

flag - flag to check.

Returns:

true if flag is set, false otherwise.

typeId

public int typeId()

Specified by:

typeId in interface BinaryObjectEx

Returns:

Type ID.

type

@Nullable
public @Nullable BinaryType type()
                          throws BinaryObjectException

Gets type information for this binary object.

Specified by:

type in interface BinaryObject

Returns:

Binary object type information.

Throws:

BinaryObjectException - In case of error.

rawType

@Nullable
public @Nullable BinaryType rawType()
                             throws BinaryObjectException

Get raw type.

Specified by:

rawType in interface BinaryObjectEx

Returns:

Raw type

Throws:

BinaryObjectException - If failed.

field

@Nullable
public <F> F field(String fieldName)
            throws BinaryObjectException

Gets field value.

Specified by:

field in interface BinaryObject

Type Parameters:

F - Type of the field value.

Parameters:

fieldName - Field name.

Returns:

Field value.

Throws:

BinaryObjectException - In case of any other error.

field

@Nullable
public <F> F field(int fieldId)
            throws BinaryObjectException

Gets field value.

Specified by:

field in class BinaryObjectExImpl

Parameters:

fieldId - Field ID.

Returns:

Field value.

Throws:

BinaryObjectException - In case of any other error.

createFieldComparator

public BinarySerializedFieldComparator createFieldComparator()

Create field comparator.

Specified by:

createFieldComparator in class BinaryObjectExImpl

Returns:

Comparator.

dataStartOffset

public int dataStartOffset()

Get offset of data begin.

Specified by:

dataStartOffset in class BinaryObjectExImpl

Returns:

Field value.

footerStartOffset

public int footerStartOffset()

Get offset of the footer begin.

Specified by:

footerStartOffset in class BinaryObjectExImpl

Returns:

Field value.

fieldByOrder

@Nullable
public <F> F fieldByOrder(int order)

Get field by offset.

Specified by:

fieldByOrder in class BinaryObjectExImpl

Parameters:

order - Field offset.

Returns:

Field value.

writeFieldByOrder

public boolean writeFieldByOrder(int order,
                                 ByteBuffer buf)

Writes field value defined by the given field offset to the given byte buffer.

Specified by:

writeFieldByOrder in class BinaryObjectExImpl

Parameters:

order - Field offset.

Returns:

Boolean flag indicating whether the field was successfully written to the buffer, false if there is no enough space for the field in the buffer.

field

@Nullable
protected <F> F field(BinaryReaderHandles rCtx,
                      String fieldName)

Specified by:

field in class BinaryObjectExImpl

Parameters:

rCtx - Reader context.

fieldName - Field name.

Returns:

Field value.

hasField

public boolean hasField(String fieldName)

Checks whether field exists in the object.

Specified by:

hasField in interface BinaryObject

Parameters:

fieldName - Field name.

Returns:

True if field exists.

deserialize

@Nullable
public <T> T deserialize(@Nullable
                         @Nullable ClassLoader ldr)
                  throws BinaryObjectException

Gets fully deserialized instance of binary object. If ldr was not specified, configured class loader will be used IgniteConfiguration.getClassLoader().

Specified by:

deserialize in interface BinaryObject

Type Parameters:

T - Type of the deserialized object.

Parameters:

ldr - Class loader.

Returns:

Fully deserialized instance of binary object.

Throws:

BinaryInvalidTypeException - If class doesn't exist.

BinaryObjectException - In case of any other error.

deserialize

@Nullable
public <T> T deserialize()
                  throws BinaryObjectException

Gets fully deserialized instance of binary object.

Specified by:

deserialize in interface BinaryObject

Type Parameters:

T - Type of the deserialized object.

Returns:

Fully deserialized instance of binary object.

Throws:

BinaryInvalidTypeException - If class doesn't exist.

BinaryObjectException - In case of any other error.

clone

public BinaryObject clone()
                   throws CloneNotSupportedException

Copies this binary object.

Specified by:

clone in interface BinaryObject

Overrides:

clone in class BinaryObjectExImpl

Returns:

Copy of this binary object.

Throws:

CloneNotSupportedException

hashCode

public int hashCode()

Specified by:

hashCode in interface KeyCacheObject

Overrides:

hashCode in class Object

Returns:

Key hash code.

hasSchema

public boolean hasSchema()

Specified by:

hasSchema in class BinaryObjectExImpl

Returns:

True if object has schema.

schemaId

public int schemaId()

Get schema ID.

Specified by:

schemaId in class BinaryObjectExImpl

Returns:

Schema ID.

createSchema

public BinarySchema createSchema()

Create schema for object.

Specified by:

createSchema in class BinaryObjectExImpl

Returns:

Schema.

onAckReceived

public void onAckReceived()

Method called when ack message received.

Specified by:

onAckReceived in interface Message

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

writeTo

public boolean writeTo(ByteBuffer buf,
                       MessageWriter writer)

Writes this message to provided byte buffer.

Specified by:

writeTo in interface Message

Parameters:

buf - Byte buffer.

writer - Writer.

Returns:

Whether message was fully written.

readFrom

public boolean readFrom(ByteBuffer buf,
                        MessageReader reader)

Reads this message from provided byte buffer.

Specified by:

readFrom in interface Message

Parameters:

buf - Byte buffer.

reader - Reader.

Returns:

Whether message was fully read.

directType

public short directType()

Gets message type.

Specified by:

directType in interface Message

Returns:

Message type.

fieldsCount

public byte fieldsCount()

Gets fields count.

Specified by:

fieldsCount in interface Message

Returns:

Fields count.

compareForDml

public static int compareForDml(Object first,
                                Object second)

Compare two objects for DML operation.

Parameters:

first - First.

second - Second.

Returns:

Comparison result.

size

public int size()

Get the size of the object

Specified by:

size in interface BinaryObject

Returns:

Size of the object

toString

public String toString()

Overrides:

toString in class BinaryObjectExImpl