org.apache.ignite.internal.binary

Class BinaryObjectExImpl

java.lang.Object

org.apache.ignite.internal.binary.BinaryObjectExImpl

All Implemented Interfaces:

Serializable, Cloneable, BinaryObject, BinaryObjectEx

Direct Known Subclasses:

BinaryObjectImpl, BinaryObjectOffheapImpl

public abstract class BinaryObjectExImpl
extends Object
implements BinaryObjectEx

Internal binary object interface.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BinaryObjectExImpl()

Method Summary

Methods

Modifier and Type	Method and Description
abstract byte[]	array()
BinaryObject	clone() Copies this binary object.
protected abstract BinarySchema	createSchema() Create schema for object.
int	enumOrdinal() Get ordinal for this enum object.
boolean	equals(Object other)
protected abstract <F> F	field(BinaryReaderHandles ctx, String fieldName)
abstract <F> F	field(int fieldId) Gets field value.
protected abstract <F> F	fieldByOrder(int fieldOffset) Get field by offset.
protected abstract boolean	hasArray()
abstract int	length()
abstract long	offheapAddress()
protected abstract int	schemaId() Get schema ID.
abstract int	start()
BinaryObjectBuilder	toBuilder() Creates a new BinaryObjectBuilder based on this binary object.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.ignite.internal.binary.BinaryObjectEx

rawType, typeId

Methods inherited from interface org.apache.ignite.binary.BinaryObject

deserialize, field, hasField, type

Constructor Detail

BinaryObjectExImpl

public BinaryObjectExImpl()

Method Detail

length

public abstract int length()

Returns:

Length.

start

public abstract int start()

Returns:

Object start.

hasArray

protected abstract boolean hasArray()

Returns:

True if object is array based.

array

public abstract byte[] array()

Returns:

Object array if object is array based, otherwise null.

offheapAddress

public abstract long offheapAddress()

Returns:

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

field

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

Gets field value.

Parameters:

fieldId - Field ID.

Returns:

Field value.

Throws:

BinaryObjectException - In case of any other error.

enumOrdinal

public int enumOrdinal()
                throws BinaryObjectException

Get ordinal for this enum object. Use BinaryType.isEnum() to check if object is of enum type.

Specified by:

enumOrdinal in interface BinaryObject

Returns:

Ordinal.

Throws:

BinaryObjectException - If object is not enum.

fieldByOrder

@Nullable
protected abstract <F> F fieldByOrder(int fieldOffset)

Get field by offset.

Parameters:

fieldOffset - Field offset.

Returns:

Field value.

field

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

Parameters:

ctx - Reader context.

fieldName - Field name.

Returns:

Field value.

schemaId

protected abstract int schemaId()

Get schema ID.

Returns:

Schema ID.

createSchema

protected abstract BinarySchema createSchema()

Create schema for object.

Returns:

Schema.

toBuilder

public BinaryObjectBuilder toBuilder()
                              throws BinaryObjectException

Creates a new BinaryObjectBuilder based on this binary object. The following code

 BinaryObjectBuilder builder = binaryObject.toBuilder();
 

is equivalent to

 BinaryObjectBuilder builder = ignite.binary().builder(binaryObject);
 

Specified by:

toBuilder in interface BinaryObject

Returns:

Binary object builder.

Throws:

BinaryObjectException - If builder cannot be created.

clone

public BinaryObject clone()
                   throws CloneNotSupportedException

Copies this binary object.

Specified by:

clone in interface BinaryObject

Overrides:

clone in class Object

Returns:

Copy of this binary object.

Throws:

CloneNotSupportedException

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object