Interface MarshallableEntryFactory<K,V>

public interface MarshallableEntryFactory<K,V>

Factory for MarshallableEntry.

Since:

10.0

Author:

Ryan Emerson

Method Summary

Modifier and Type	Method	Description
MarshallableEntry<K,V>	cloneWithExpiration(MarshallableEntry<K,V> me, long creationTime, long lifespan)	Clone the provided MarshallableEntry if needed to apply lifespan expiration.
MarshallableEntry<K,V>	create(Object key)	value defaults to null
MarshallableEntry<K,V>	create(Object key, Object value)	metadata defaults to null created defaults to -1 lastUsed defaults to -1
MarshallableEntry<K,V>	create(Object key, Object value, Metadata metadata, PrivateMetadata internalMetadata, long created, long lastUsed)	Creates a MarshallableEntry using non-marshalled POJOs as arguments
MarshallableEntry<K,V>	create(Object key, ByteBuffer valueBytes, ByteBuffer metadataBytes, ByteBuffer internalMetadataBytes, long created, long lastUsed)	Creates a MarshallableEntry using a object key and already marshalled value/metadata as arguments
default MarshallableEntry<K,V>	create(Object key, InternalCacheValue<V> v)	Creates a MarshallableEntry instance from a key and an InternalCacheValue.
MarshallableEntry<K,V>	create(Object key, MarshalledValue value)	Creates a MarshallableEntry using a Key MarshalledValue.
MarshallableEntry<K,V>	create(ByteBuffer key, ByteBuffer valueBytes)	metadataBytes defaults to null created defaults to -1 lastUsed defaults to -1
MarshallableEntry<K,V>	create(ByteBuffer key, ByteBuffer valueBytes, ByteBuffer metadataBytes, ByteBuffer internalMetadataBytes, long created, long lastUsed)	Creates a MarshallableEntry using already marshalled objects as arguments
default MarshallableEntry<K,V>	create(InternalCacheEntry<K,V> e)	Creates a MarshallableEntry instance from an InternalCacheEntry.
MarshallableEntry<K,V>	getEmpty()

Method Details

create

MarshallableEntry<K,V> create(ByteBuffer key,
 ByteBuffer valueBytes)

metadataBytes defaults to null created defaults to -1 lastUsed defaults to -1

See Also:

• create(ByteBuffer, ByteBuffer, ByteBuffer, ByteBuffer, long, long)

create

MarshallableEntry<K,V> create(ByteBuffer key,
 ByteBuffer valueBytes,
 ByteBuffer metadataBytes,
 ByteBuffer internalMetadataBytes,
 long created,
 long lastUsed)

Creates a MarshallableEntry using already marshalled objects as arguments

Parameters:

key - ByteBuffer of serialized key object

valueBytes - ByteBuffer of serialized value object

metadataBytes - ByteBuffer of serialized metadata object

internalMetadataBytes - ByteBuffer of serialized internal metadata object

created - timestamp of when the entry was created, -1 means this value is ignored

lastUsed - timestamp of last time entry was accessed in memory

Returns:

MarshallableEntry instance that lazily handles unmarshalling of keys, values and metadata via the MarshallableEntry.getKey(), MarshallableEntry.getValue() and MarshallableEntry.getMetadata() methods.

create

MarshallableEntry<K,V> create(Object key,
 ByteBuffer valueBytes,
 ByteBuffer metadataBytes,
 ByteBuffer internalMetadataBytes,
 long created,
 long lastUsed)

Creates a MarshallableEntry using a object key and already marshalled value/metadata as arguments

Parameters:

key - entry key

valueBytes - ByteBuffer of serialized value object

metadataBytes - ByteBuffer of serialized metadata object

internalMetadataBytes - ByteBuffer of serialized internal metadata object

created - timestamp of when the entry was created, -1 means this value is ignored

lastUsed - timestamp of last time entry was accessed in memory

Returns:

MarshallableEntry instance that lazily handles unmarshalling of values and metadata via the MarshallableEntry.getKey(), MarshallableEntry.getValue() and MarshallableEntry.getMetadata() methods.

create

MarshallableEntry<K,V> create(Object key)

value defaults to null

See Also:

• create(Object, Object)

create

MarshallableEntry<K,V> create(Object key,
 Object value)

metadata defaults to null created defaults to -1 lastUsed defaults to -1

See Also:

• create(Object, Object, Metadata, PrivateMetadata, long, long)

create

MarshallableEntry<K,V> create(Object key,
 Object value,
 Metadata metadata,
 PrivateMetadata internalMetadata,
 long created,
 long lastUsed)

Creates a MarshallableEntry using non-marshalled POJOs as arguments

Parameters:

key - entry key

value - entry value

metadata - entry metadata

internalMetadata - entry internal metadata

created - timestamp of when the entry was created, -1 means this value is ignored

lastUsed - timestamp of last time entry was accessed in memory

Returns:

MarshallableEntry instance that lazily handles serialization of keys, values and metadata via the MarshallableEntry.getKeyBytes(), MarshallableEntry.getValueBytes() and MarshallableEntry.getMetadataBytes() methods.

create

default MarshallableEntry<K,V> create(Object key,
 InternalCacheValue<V> v)

Creates a MarshallableEntry instance from a key and an InternalCacheValue.

Parameters:

key - the entry key.

v - the InternalCacheValue.

create

default MarshallableEntry<K,V> create(InternalCacheEntry<K,V> e)

Creates a MarshallableEntry instance from an InternalCacheEntry.

Parameters:

e - the InternalCacheEntry.

create

MarshallableEntry<K,V> create(Object key,
 MarshalledValue value)

Creates a MarshallableEntry using a Key MarshalledValue.

Parameters:

key - entry key

value - a MarshalledValue whose values are used to populate MarshallableEntry.getValueBytes(), MarshallableEntry.getMetadataBytes(), MarshallableEntry.created() and MarshallableEntry.lastUsed() fields.

Returns:

MarshallableEntry instance that lazily handles unmarshalling of keys, values and metadata via the MarshallableEntry.getKey(), MarshallableEntry.getValue() and MarshallableEntry.getMetadata() methods.

Throws:

NullPointerException - if the provided MarshalledValue is null.

cloneWithExpiration

MarshallableEntry<K,V> cloneWithExpiration(MarshallableEntry<K,V> me,
 long creationTime,
 long lifespan)

Clone the provided MarshallableEntry if needed to apply lifespan expiration. If the entry already has lifespan applied this method will do nothing, returning the same MarshallableEntry back.

Parameters:

me - the entry to clone if applicable

creationTime - the creation time to apply for lifespan

lifespan - the duration for which the entry will expire after the creationTime

Returns:

a new entry if lifespan was applied otherwise the same entry provided

getEmpty

MarshallableEntry<K,V> getEmpty()

Returns:

a cached empty MarshallableEntry instance.