org.gridgain.grid.kernal.processors.cache.distributed

Class GridPartitionedCacheEntryImpl<K,V>

java.lang.Object

org.gridgain.grid.kernal.processors.cache.GridCacheEntryImpl<K,V>

org.gridgain.grid.kernal.processors.cache.distributed.GridPartitionedCacheEntryImpl<K,V>

All Implemented Interfaces:

Externalizable, Serializable, Map.Entry<K,V>, GridCacheEntry<K,V>, GridMetadataAware

public class GridPartitionedCacheEntryImpl<K,V>
extends GridCacheEntryImpl<K,V>

Partitioned cache entry public API.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.gridgain.grid.kernal.processors.cache.GridCacheEntryImpl

cached, ctx, key, MODES_SMART, proxy

Constructor Summary

Constructors

Constructor and Description
GridPartitionedCacheEntryImpl() Empty constructor required for Externalizable.
GridPartitionedCacheEntryImpl(GridCacheProjectionImpl<K,V> nearPrj, GridCacheContext<K,V> ctx, K key, GridCacheEntryEx<K,V> cached)

Method Summary

Methods

Modifier and Type	Method and Description
<V1> V1	addMeta(String name, V1 val) Adds a new metadata.
<V1> V1	addMetaIfAbsent(String name, Callable<V1> c) Adds given metadata value only if it was absent.
<V1> V1	addMetaIfAbsent(String name, V1 val) Adds given metadata value only if it was absent.
<V1> Map<String,V1>	allMeta() Gets all metadata in this entry.
void	copyMeta(GridMetadataAware from) Copies all metadata from another instance.
void	copyMeta(Map<String,?> data) Copies all metadata from given map.
GridDhtCacheAdapter<K,V>	dht()
protected GridCacheEntryEx<K,V>	entryEx(boolean touch, long topVer)
boolean	evictDhtOnly(GridPredicate<GridCacheEntry<K,V>>[] filter)
boolean	evictNearOnly(GridPredicate<GridCacheEntry<K,V>>[] filter)
boolean	hasMeta(String name) Tests whether or not given metadata is set.
boolean	hasMeta(String name, Object val) Tests whether or not metadata with given name and value is set.
<V1> V1	meta(String name) Gets metadata by name.
GridNearCacheAdapter<K,V>	near()
V	peek(Collection<GridCachePeekMode> modes) This method has the same semantic as GridCacheProjection.peek(Object, Collection) method.
V	peekDht(GridPredicate<GridCacheEntry<K,V>>[] filter)
protected GridCacheEntryEx<K,V>	peekEx(long topVer)
<V1> V1	putMetaIfAbsent(String name, Callable<V1> c) Adds given metadata value only if it was absent.
<V1> V1	putMetaIfAbsent(String name, V1 val) Adds given metadata value only if it was absent.
<V1> V1	removeMeta(String name) Removes metadata by name.
<V1> boolean	removeMeta(String name, V1 val) Removes metadata only if its current value is equal to val passed in.
<V1> boolean	replaceMeta(String name, V1 curVal, V1 newVal) Replaces given metadata with new newVal value only if its current value is equal to curVal.
String	toString()

Methods inherited from class org.gridgain.grid.kernal.processors.cache.GridCacheEntryImpl

backup, clear, compact, equals, evict, expirationTime, get, getAsync, getKey, getValue, hashCode, isCached, isLocked, isLockedByThread, lock, lockAsync, memorySize, partition, peek, primary, projection, readExternal, reload, reloadAsync, remove, remove, removeAsync, removeAsync, removex, removexAsync, replace, replace, replaceAsync, replaceAsync, replacex, replacexAsync, reset, set, setAsync, setIfAbsent, setIfAbsentAsync, setValue, setx, setxAsync, setxIfAbsent, setxIfAbsentAsync, timeToLive, timeToLive, transform, transformAsync, unlock, unwrapNoCreate, version, writeExternal

Methods inherited from class java.lang.Object

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

Constructor Detail

GridPartitionedCacheEntryImpl

public GridPartitionedCacheEntryImpl()

Empty constructor required for Externalizable.

GridPartitionedCacheEntryImpl

public GridPartitionedCacheEntryImpl(GridCacheProjectionImpl<K,V> nearPrj,
                             GridCacheContext<K,V> ctx,
                             K key,
                             @Nullable
                             GridCacheEntryEx<K,V> cached)

Parameters:

nearPrj - Parent projection or null if entry belongs to default cache.

ctx - Near cache context.

key - key.

cached - Cached entry (either from near or dht cache map).

Method Detail

dht

public GridDhtCacheAdapter<K,V> dht()

Returns:

Dht cache.

near

public GridNearCacheAdapter<K,V> near()

Returns:

Near cache.

evictNearOnly

public boolean evictNearOnly(@Nullable
                    GridPredicate<GridCacheEntry<K,V>>[] filter)

Parameters:

filter - Optional filter.

Returns:

True if evicted.

evictDhtOnly

public boolean evictDhtOnly(@Nullable
                   GridPredicate<GridCacheEntry<K,V>>[] filter)

Parameters:

filter - Filter.

Returns:

True if evicted.

peek

public V peek(@Nullable
     Collection<GridCachePeekMode> modes)
       throws GridException

This method has the same semantic as GridCacheProjection.peek(Object, Collection) method.

Specified by:

peek in interface GridCacheEntry<K,V>

Overrides:

peek in class GridCacheEntryImpl<K,V>

Parameters:

modes - See GridCacheProjection.peek(Object, Collection).

Returns:

See GridCacheProjection.peek(Object, Collection).

Throws:

GridException - See GridCacheProjection.peek(Object, Collection).

peekDht

@Nullable
public V peekDht(@Nullable
                 GridPredicate<GridCacheEntry<K,V>>[] filter)

Parameters:

filter - Filter.

Returns:

Peeked value.

entryEx

protected GridCacheEntryEx<K,V> entryEx(boolean touch,
                            long topVer)

Overrides:

entryEx in class GridCacheEntryImpl<K,V>

peekEx

protected GridCacheEntryEx<K,V> peekEx(long topVer)

Overrides:

peekEx in class GridCacheEntryImpl<K,V>

addMeta

public <V1> V1 addMeta(String name,
              V1 val)

Adds a new metadata.

Specified by:

addMeta in interface GridMetadataAware

Overrides:

addMeta in class GridCacheEntryImpl<K,V>

Type Parameters:

V1 - Type of the value.

Parameters:

name - Metadata name.

val - Metadata value.

Returns:

Metadata previously associated with given name, or null if there was none.

addMetaIfAbsent

public <V1> V1 addMetaIfAbsent(String name,
                      Callable<V1> c)

Adds given metadata value only if it was absent.

Specified by:

addMetaIfAbsent in interface GridMetadataAware

Overrides:

addMetaIfAbsent in class GridCacheEntryImpl<K,V>

Type Parameters:

V1 - Type of the value.

Parameters:

name - Metadata name.

c - Factory closure to produce value to add if it's not attached already. Not that unlike GridMetadataAware.addMeta(String, Object) method the factory closure will not be called unless the value is required and therefore value will only be created when it is actually needed. If null and metadata value is missing - null will be returned from this method.

Returns:

The value of the metadata after execution of this method.

addMetaIfAbsent

public <V1> V1 addMetaIfAbsent(String name,
                      V1 val)

Adds given metadata value only if it was absent. Unlike GridMetadataAware.putMetaIfAbsent(String, Callable), this method always returns the latest value and never previous one.

Specified by:

addMetaIfAbsent in interface GridMetadataAware

Overrides:

addMetaIfAbsent in class GridCacheEntryImpl<K,V>

Type Parameters:

V1 - Type of the value.

Parameters:

name - Metadata name.

val - Value to add if it's not attached already.

Returns:

The value of the metadata after execution of this method.

allMeta

public <V1> Map<String,V1> allMeta()

Gets all metadata in this entry.

Specified by:

allMeta in interface GridMetadataAware

Overrides:

allMeta in class GridCacheEntryImpl<K,V>

Type Parameters:

V1 - Type of the value.

Returns:

All metadata in this entry.

hasMeta

public boolean hasMeta(String name)

Tests whether or not given metadata is set.

Specified by:

hasMeta in interface GridMetadataAware

Overrides:

hasMeta in class GridCacheEntryImpl<K,V>

Parameters:

name - Name of the metadata to test.

Returns:

Whether or not given metadata is set.

hasMeta

public boolean hasMeta(String name,
              Object val)

Tests whether or not metadata with given name and value is set. Returns true if attachment with given name it set and its value is equals to provided value. Otherwise returns false.

Specified by:

hasMeta in interface GridMetadataAware

Overrides:

hasMeta in class GridCacheEntryImpl<K,V>

Parameters:

name - Name of the metadata.

val - Value to compare. Cannot be null.

Returns:

true if metadata with given name is set and its value is equals to provided value - otherwise returns false.

meta

public <V1> V1 meta(String name)

Gets metadata by name.

Specified by:

meta in interface GridMetadataAware

Overrides:

meta in class GridCacheEntryImpl<K,V>

Type Parameters:

V1 - Type of the value.

Parameters:

name - Metadata name.

Returns:

Metadata value or null.

putMetaIfAbsent

public <V1> V1 putMetaIfAbsent(String name,
                      Callable<V1> c)

Adds given metadata value only if it was absent.

Specified by:

putMetaIfAbsent in interface GridMetadataAware

Overrides:

putMetaIfAbsent in class GridCacheEntryImpl<K,V>

Type Parameters:

V1 - Type of the value.

Parameters:

name - Metadata name.

c - Factory closure to produce value to add if it's not attached already. Not that unlike GridMetadataAware.addMeta(String, Object) method the factory closure will not be called unless the value is required and therefore value will only be created when it is actually needed.

Returns:

null if new value was put, or current value if put didn't happen.

putMetaIfAbsent

public <V1> V1 putMetaIfAbsent(String name,
                      V1 val)

Adds given metadata value only if it was absent.

Specified by:

putMetaIfAbsent in interface GridMetadataAware

Overrides:

putMetaIfAbsent in class GridCacheEntryImpl<K,V>

Type Parameters:

V1 - Type of the value.

Parameters:

name - Metadata name.

val - Value to add if it's not attached already.

Returns:

null if new value was put, or current value if put didn't happen.

removeMeta

public <V1> V1 removeMeta(String name)

Removes metadata by name.

Specified by:

removeMeta in interface GridMetadataAware

Overrides:

removeMeta in class GridCacheEntryImpl<K,V>

Type Parameters:

V1 - Type of the value.

Parameters:

name - Name of the metadata to remove.

Returns:

Value of removed metadata or null.

removeMeta

public <V1> boolean removeMeta(String name,
                      V1 val)

Removes metadata only if its current value is equal to val passed in.

Specified by:

removeMeta in interface GridMetadataAware

Overrides:

removeMeta in class GridCacheEntryImpl<K,V>

Type Parameters:

V1 - Value type.

Parameters:

name - Name of metadata attribute.

val - Value to compare.

Returns:

True if value was removed, false otherwise.

replaceMeta

public <V1> boolean replaceMeta(String name,
                       V1 curVal,
                       V1 newVal)

Replaces given metadata with new newVal value only if its current value is equal to curVal. Otherwise, it is no-op.

Specified by:

replaceMeta in interface GridMetadataAware

Overrides:

replaceMeta in class GridCacheEntryImpl<K,V>

Parameters:

name - Name of the metadata.

curVal - Current value to check.

newVal - New value.

Returns:

true if replacement occurred, false otherwise.

copyMeta

public void copyMeta(Map<String,?> data)

Copies all metadata from given map.

Specified by:

copyMeta in interface GridMetadataAware

Overrides:

copyMeta in class GridCacheEntryImpl<K,V>

Parameters:

data - Map to copy metadata from.

copyMeta

public void copyMeta(GridMetadataAware from)

Copies all metadata from another instance.

Specified by:

copyMeta in interface GridMetadataAware

Overrides:

copyMeta in class GridCacheEntryImpl<K,V>

Parameters:

from - Metadata aware instance to copy metadata from.

toString

public String toString()

Overrides:

toString in class GridCacheEntryImpl<K,V>