org.apache.ignite.internal.processors.cache

Interface CacheObject

All Superinterfaces:

Message, Serializable

All Known Subinterfaces:

KeyCacheObject

All Known Implementing Classes:

BinaryEnumObjectImpl, BinaryObjectImpl, BinaryObjectOffheapImpl, CacheObjectAdapter, CacheObjectByteArrayImpl, CacheObjectImpl, KeyCacheObjectImpl

public interface CacheObject
extends Message

Field Summary

Fields

Modifier and Type	Field and Description
static byte	TYPE_BINARY
static byte	TYPE_BINARY_ENUM
static byte	TYPE_BYTE_ARR
static byte	TYPE_REGULAR

Method Summary

Methods

Modifier and Type	Method and Description
byte	cacheObjectType()
void	finishUnmarshal(CacheObjectContext ctx, ClassLoader ldr)
boolean	isPlatformType() Gets flag indicating whether object value is a platform type.
CacheObject	prepareForCache(CacheObjectContext ctx) Prepares cache object for cache (e.g. copies user-provided object if needed).
void	prepareMarshal(CacheObjectContext ctx)
<T> T	value(CacheObjectContext ctx, boolean cpy)
byte[]	valueBytes(CacheObjectContext ctx)

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

directType, fieldsCount, onAckReceived, readFrom, writeTo

Field Detail

TYPE_REGULAR

static final byte TYPE_REGULAR

See Also:

Constant Field Values

TYPE_BYTE_ARR

static final byte TYPE_BYTE_ARR

See Also:

Constant Field Values

TYPE_BINARY

static final byte TYPE_BINARY

See Also:

Constant Field Values

TYPE_BINARY_ENUM

static final byte TYPE_BINARY_ENUM

See Also:

Constant Field Values

Method Detail

value

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

Parameters:

ctx - Context.

cpy - If true need to copy value.

Returns:

Value.

valueBytes

byte[] valueBytes(CacheObjectContext ctx)
                  throws IgniteCheckedException

Parameters:

ctx - Context.

Returns:

Value bytes.

Throws:

IgniteCheckedException - If failed.

cacheObjectType

byte cacheObjectType()

Returns:

Object type.

isPlatformType

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.

Returns:

Platform type flag.

prepareForCache

CacheObject prepareForCache(CacheObjectContext ctx)

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

Parameters:

ctx - Cache context.

Returns:

Instance to store in cache.

finishUnmarshal

void finishUnmarshal(CacheObjectContext ctx,
                   ClassLoader ldr)
                     throws IgniteCheckedException

Parameters:

ctx - Context.

ldr - Class loader.

Throws:

IgniteCheckedException - If failed.

prepareMarshal

void prepareMarshal(CacheObjectContext ctx)
                    throws IgniteCheckedException

Parameters:

ctx - Context.

Throws:

IgniteCheckedException - If failed.