Package org.apache.ignite.internal.persistence.store

Interface StoreObject

All Known Subinterfaces:

KeyStoreObject

All Known Implementing Classes:

KeyStoreObjectImpl, StoreObjectAdapter, StoreObjectImpl

public interface StoreObject

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
byte	cacheObjectType()
void	finishUnmarshal(StoreContext ctx, ClassLoader ldr)
StoreObject	prepareForCache(StoreContext ctx)	Prepares cache object for cache (e.g. copies user-provided object if needed).
void	prepareMarshal(StoreContext ctx)
int	putValue(long addr)
boolean	putValue(ByteBuffer buf)
boolean	putValue(ByteBuffer buf, int off, int len)
<T> T	value(StoreContext ctx)
byte[]	valueBytes(StoreContext ctx)
int	valueBytesLength(StoreContext ctx)

Field Details

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 Details

value

<T> T value(StoreContext ctx)
     throws IgniteCheckedException

Parameters:

ctx - Context.

Returns:

Value.

Throws:

IgniteCheckedException

valueBytes

byte[] valueBytes(StoreContext ctx)
           throws IgniteCheckedException

Parameters:

ctx - Context.

Returns:

Value bytes.

Throws:

IgniteCheckedException - If failed.

valueBytesLength

int valueBytesLength(StoreContext ctx)
              throws IgniteCheckedException

Parameters:

ctx - Cache object context.

Returns:

Size required to store this value object.

Throws:

IgniteCheckedException - If failed.

putValue

boolean putValue(ByteBuffer buf)
          throws IgniteCheckedException

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

int putValue(long addr)
      throws IgniteCheckedException

Parameters:

addr - Address tp write value to.

Returns:

Number of bytes written.

Throws:

IgniteCheckedException - If failed.

putValue

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

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.

cacheObjectType

byte cacheObjectType()

Returns:

Object type.

prepareForCache

StoreObject prepareForCache(StoreContext 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(StoreContext ctx,
 ClassLoader ldr)
              throws IgniteCheckedException

Parameters:

ctx - Context.

ldr - Class loader.

Throws:

IgniteCheckedException - If failed.

prepareMarshal

void prepareMarshal(StoreContext ctx)
             throws IgniteCheckedException

Parameters:

ctx - Context.

Throws:

IgniteCheckedException - If failed.