org.gridgain.grid.kernal.processors.cache

Class GridCacheFilterEvaluationEntry<K,V>

java.lang.Object

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

All Implemented Interfaces:

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

public class GridCacheFilterEvaluationEntry<K,V>
extends Object
implements GridCacheEntry<K,V>

Entry implementation for passing raw cache map entries through filters. Needed to protect original entry from invalidation by filter's peek.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GridCacheFilterEvaluationEntry(K key, V val, GridCacheEntryEx<K,V> impl)
GridCacheFilterEvaluationEntry(K key, V val, GridCacheEntryEx<K,V> impl, boolean allowTx)

Method Summary

Methods

Modifier and Type	Method and Description
<V> V	addMeta(String name, V val) Adds a new metadata.
<V> V	addMetaIfAbsent(String name, Callable<V> c) Adds given metadata value only if it was absent.
<V> V	addMetaIfAbsent(String name, V val) Adds given metadata value only if it was absent.
<V> Map<String,V>	allMeta() Gets all metadata in this entry.
boolean	backup() Gets the flag indicating if current node is backup for this entry.
boolean	clear() This method has the same semantic as GridCacheProjection.clear(Object) method.
boolean	compact() Optimizes the size of this entry.
void	copyMeta(GridMetadataAware from) Copies all metadata from another instance.
void	copyMeta(Map<String,?> data) Copies all metadata from given map.
boolean	evict() This method has the same semantic as GridCacheProjection.evict(Object) method.
long	expirationTime() Gets expiration time for this entry.
V	get() This method has the same semantic as GridCacheProjection.get(Object) method.
GridFuture<V>	getAsync() This method has the same semantic as GridCacheProjection.getAsync(Object) method.
K	getKey()
V	getValue() This method has the same semantic as GridCacheEntry.get() method, however it wraps GridException into GridRuntimeException if failed in order to comply with Map.Entry interface.
boolean	hasMeta(String name) Tests whether or not given metadata is set.
<V> boolean	hasMeta(String name, V val) Tests whether or not metadata with given name and value is set.
boolean	isCached() Checks whether entry is currently present in cache or not.
boolean	isLocked() This method has the same semantic as GridCacheProjection.isLocked(Object) method.
boolean	isLockedByThread() This method has the same semantic as GridCacheProjection.isLockedByThread(Object) method.
boolean	lock(long timeout, GridPredicate<GridCacheEntry<K,V>>... filter) Synchronously acquires lock on a cached object associated with this entry only if the passed in filter (if any) passes.
GridFuture<Boolean>	lockAsync(long timeout, GridPredicate<GridCacheEntry<K,V>>... filter) Asynchronously acquires lock on a cached object associated with this entry only if the passed in filter (if any) passes.
int	memorySize() Gets size of serialized key and value in addition to any overhead added by GridGain itself.
<V> V	meta(String name) Gets metadata by name.
int	partition() Gets affinity partition id for this entry.
V	peek() This method has the same semantic as GridCacheProjection.peek(Object) method.
V	peek(Collection<GridCachePeekMode> modes) This method has the same semantic as GridCacheProjection.peek(Object, Collection) method.
boolean	primary() Gets the flag indicating current node's primary ownership for this entry.
GridCacheProjection<K,V>	projection() Cache projection to which this entry belongs.
<V> V	putMetaIfAbsent(String name, Callable<V> c) Adds given metadata value only if it was absent.
<V> V	putMetaIfAbsent(String name, V val) Adds given metadata value only if it was absent.
V	reload() This method has the same semantic as GridCacheProjection.reload(Object) method.
GridFuture<V>	reloadAsync() This method has the same semantic as GridCacheProjection.reloadAsync(Object) method.
V	remove(GridPredicate<GridCacheEntry<K,V>>... filter) This method has the same semantic as GridCacheProjection.remove(Object, GridPredicate[]) method.
boolean	remove(V val) This method has the same semantic as GridCacheProjection.remove(Object, Object) method.
GridFuture<V>	removeAsync(GridPredicate<GridCacheEntry<K,V>>... filter) This method has the same semantic as GridCacheProjection.removeAsync(Object, GridPredicate[]) method.
GridFuture<Boolean>	removeAsync(V val) This method has the same semantic as GridCacheProjection.removeAsync(Object, Object) method.
<V> V	removeMeta(String name) Removes metadata by name.
<V> boolean	removeMeta(String name, V val) Removes metadata only if its current value is equal to val passed in.
boolean	removex(GridPredicate<GridCacheEntry<K,V>>... filter) This method has the same semantic as GridCacheProjection.removex(Object, GridPredicate[]) method.
GridFuture<Boolean>	removexAsync(GridPredicate<GridCacheEntry<K,V>>... filter) This method has the same semantic as GridCacheProjection.removexAsync(Object, GridPredicate[]) method.
V	replace(V val) This method has the same semantic as GridCacheProjection.replace(Object, Object) method.
boolean	replace(V oldVal, V newVal) This method has the same semantic as GridCacheProjection.replace(Object, Object, Object) method.
GridFuture<V>	replaceAsync(V val) This method has the same semantic as GridCacheProjection.replaceAsync(Object, Object) method.
GridFuture<Boolean>	replaceAsync(V oldVal, V newVal) This method has the same semantic as GridCacheProjection.replaceAsync(Object, Object, Object) method.
<V> boolean	replaceMeta(String name, V curVal, V newVal) Replaces given metadata with new newVal value only if its current value is equal to curVal.
boolean	replacex(V val) This method has the same semantic as GridCacheProjection.replacex(Object, Object) method.
GridFuture<Boolean>	replacexAsync(V val) This method has the same semantic as GridCacheProjection.replacexAsync(Object, Object) method.
V	set(V val, GridPredicate<GridCacheEntry<K,V>>... filter) This method has the same semantic as GridCacheProjection.put(Object, Object, GridPredicate[]) method.
GridFuture<V>	setAsync(V val, GridPredicate<GridCacheEntry<K,V>>... filter) This method has the same semantic as GridCacheProjection.putAsync(Object, Object, GridPredicate[]) method.
V	setIfAbsent(V val) This method has the same semantic as GridCacheProjection.putIfAbsent(Object, Object) method.
GridFuture<V>	setIfAbsentAsync(V val) This method has the same semantic as GridCacheProjection.putIfAbsentAsync(Object, Object) method.
V	setValue(V val) This method has the same semantic as GridCacheEntry.set(Object, GridPredicate[]) method, however it wraps GridException into GridRuntimeException if failed in order to comply with Map.Entry interface.
boolean	setx(V val, GridPredicate<GridCacheEntry<K,V>>... filter) This method has the same semantic as GridCacheProjection.putx(Object, Object, GridPredicate[]) method.
GridFuture<Boolean>	setxAsync(V val, GridPredicate<GridCacheEntry<K,V>>... filter) This method has the same semantic as GridCacheProjection.putxAsync(Object, Object, GridPredicate[]) method.
boolean	setxIfAbsent(V val) This method has the same semantic as GridCacheProjection.putxIfAbsent(Object, Object) method.
GridFuture<Boolean>	setxIfAbsentAsync(V val) This method has the same semantic as GridCacheProjection.putxIfAbsentAsync(Object, Object) method.
long	timeToLive() Gets time to live, i.e.
void	timeToLive(long ttl) Sets time to live, i.e.
String	toString()
void	transform(GridClosure<V,V> transformer) This method has the same semantic as GridCacheProjection.transform(Object, GridClosure) method.
GridFuture<?>	transformAsync(GridClosure<V,V> transformer) This method has the same semantic as GridCacheProjection.transformAsync(Object, GridClosure) method.
void	unlock(GridPredicate<GridCacheEntry<K,V>>... filter) Unlocks this entry only if current thread owns the lock.
Object	version() Gets current version of this cache entry.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map.Entry

equals, hashCode

Constructor Detail

GridCacheFilterEvaluationEntry

public GridCacheFilterEvaluationEntry(K key,
                              V val,
                              GridCacheEntryEx<K,V> impl,
                              boolean allowTx)

Parameters:

key - Key.

val - Value.

impl - Entry implementation.

allowTx - Whether value access is allowed in transactional mode.

GridCacheFilterEvaluationEntry

public GridCacheFilterEvaluationEntry(K key,
                              V val,
                              GridCacheEntryEx<K,V> impl)

Parameters:

key - Key.

val - Value.

impl - Entry implementation.

Method Detail

getKey

public K getKey()

Specified by:

getKey in interface Map.Entry<K,V>

getValue

public V getValue()

This method has the same semantic as GridCacheEntry.get() method, however it wraps GridException into GridRuntimeException if failed in order to comply with Map.Entry interface.

Specified by:

getValue in interface Map.Entry<K,V>

Specified by:

getValue in interface GridCacheEntry<K,V>

Returns:

See GridCacheEntry.get()

setValue

public V setValue(V val)

This method has the same semantic as GridCacheEntry.set(Object, GridPredicate[]) method, however it wraps GridException into GridRuntimeException if failed in order to comply with Map.Entry interface.

Specified by:

setValue in interface Map.Entry<K,V>

Specified by:

setValue in interface GridCacheEntry<K,V>

Returns:

See GridCacheEntry.set(Object, GridPredicate[])

peek

@Nullable
public V peek()

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

Specified by:

peek in interface GridCacheEntry<K,V>

Returns:

See GridCacheProjection.peek(Object).

peek

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

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

Specified by:

peek in interface GridCacheEntry<K,V>

Parameters:

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

Returns:

See GridCacheProjection.peek(Object, Collection).

get

@Nullable
public V get()
      throws GridException

This method has the same semantic as GridCacheProjection.get(Object) method.

Specified by:

get in interface GridCacheEntry<K,V>

Returns:

See GridCacheProjection.get(Object).

Throws:

GridException - See GridCacheProjection.get(Object).

getAsync

public GridFuture<V> getAsync()

This method has the same semantic as GridCacheProjection.getAsync(Object) method.

Specified by:

getAsync in interface GridCacheEntry<K,V>

Returns:

See GridCacheProjection.getAsync(Object).

projection

public GridCacheProjection<K,V> projection()

Cache projection to which this entry belongs. Note that entry and its parent projections have same flags and filters.

Specified by:

projection in interface GridCacheEntry<K,V>

Returns:

Cache projection for the cache to which this entry belongs.

reload

@Nullable
public V reload()
         throws GridException

This method has the same semantic as GridCacheProjection.reload(Object) method.

Specified by:

reload in interface GridCacheEntry<K,V>

Returns:

See GridCacheProjection.reload(Object).

Throws:

GridException - See GridCacheProjection.reload(Object).

reloadAsync

public GridFuture<V> reloadAsync()

This method has the same semantic as GridCacheProjection.reloadAsync(Object) method.

Specified by:

reloadAsync in interface GridCacheEntry<K,V>

Returns:

See GridCacheProjection.reloadAsync(Object).

isLocked

public boolean isLocked()

This method has the same semantic as GridCacheProjection.isLocked(Object) method.

Specified by:

isLocked in interface GridCacheEntry<K,V>

Returns:

See GridCacheProjection.isLocked(Object).

isLockedByThread

public boolean isLockedByThread()

This method has the same semantic as GridCacheProjection.isLockedByThread(Object) method.

Specified by:

isLockedByThread in interface GridCacheEntry<K,V>

Returns:

See GridCacheProjection.isLockedByThread(Object).

version

public Object version()

Gets current version of this cache entry.

Specified by:

version in interface GridCacheEntry<K,V>

Returns:

Version of this cache entry.

expirationTime

public long expirationTime()

Gets expiration time for this entry.

Specified by:

expirationTime in interface GridCacheEntry<K,V>

Returns:

Absolute time when this value expires.

timeToLive

public long timeToLive()

Gets time to live, i.e. maximum life time, of this entry in milliseconds.

Specified by:

timeToLive in interface GridCacheEntry<K,V>

Returns:

Time to live value for this entry.

timeToLive

public void timeToLive(long ttl)

Sets time to live, i.e. maximum life time, of this entry in milliseconds. Note that this method is transactional - if entry is enlisted into a transaction, then time-to-live will not be set until transaction commit.

When called outside the transaction, this method will have no effect until the next update operation.

Specified by:

timeToLive in interface GridCacheEntry<K,V>

Parameters:

ttl - Time to live value for this entry.

primary

public boolean primary()

Gets the flag indicating current node's primary ownership for this entry.

Note, that this value is dynamic and may change with grid topology changes.

Specified by:

primary in interface GridCacheEntry<K,V>

Returns:

True if current grid node is the primary owner for this entry.

backup

public boolean backup()

Gets the flag indicating if current node is backup for this entry.

Note, that this value is dynamic and may change with grid topology changes.

Specified by:

backup in interface GridCacheEntry<K,V>

Returns:

True if current grid node is the backup for this entry.

partition

public int partition()

Gets affinity partition id for this entry.

Specified by:

partition in interface GridCacheEntry<K,V>

Returns:

Partition id.

set

@Nullable
public V set(V val,
             @Nullable
             GridPredicate<GridCacheEntry<K,V>>... filter)
      throws GridException

This method has the same semantic as GridCacheProjection.put(Object, Object, GridPredicate[]) method.

Specified by:

set in interface GridCacheEntry<K,V>

Parameters:

val - See GridCacheProjection.put(Object, Object, GridPredicate[])

filter - See GridCacheProjection.put(Object, Object, GridPredicate[]).

Returns:

See GridCacheProjection.put(Object, Object, GridPredicate[]).

Throws:

GridException - See GridCacheProjection.put(Object, Object, GridPredicate[]).

setAsync

public GridFuture<V> setAsync(V val,
                     @Nullable
                     GridPredicate<GridCacheEntry<K,V>>... filter)

This method has the same semantic as GridCacheProjection.putAsync(Object, Object, GridPredicate[]) method.

Specified by:

setAsync in interface GridCacheEntry<K,V>

Parameters:

val - See GridCacheProjection.putAsync(Object, Object, GridPredicate[])

filter - See GridCacheProjection.putAsync(Object, Object, GridPredicate[]).

Returns:

See GridCacheProjection.putAsync(Object, Object, GridPredicate[]).

setIfAbsent

@Nullable
public V setIfAbsent(V val)
              throws GridException

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

Specified by:

setIfAbsent in interface GridCacheEntry<K,V>

Parameters:

val - See GridCacheProjection.putIfAbsent(Object, Object)

Returns:

See GridCacheProjection.putIfAbsent(Object, Object).

Throws:

GridException - See GridCacheProjection.putIfAbsent(Object, Object).

setIfAbsentAsync

public GridFuture<V> setIfAbsentAsync(V val)

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

Specified by:

setIfAbsentAsync in interface GridCacheEntry<K,V>

Parameters:

val - See GridCacheProjection.putIfAbsentAsync(Object, Object)

Returns:

See GridCacheProjection.putIfAbsentAsync(Object, Object).

setx

public boolean setx(V val,
           @Nullable
           GridPredicate<GridCacheEntry<K,V>>... filter)
             throws GridException

This method has the same semantic as GridCacheProjection.putx(Object, Object, GridPredicate[]) method.

Specified by:

setx in interface GridCacheEntry<K,V>

Parameters:

val - See GridCacheProjection.putx(Object, Object, GridPredicate[])

filter - See GridCacheProjection.putx(Object, Object, GridPredicate[]).

Returns:

See GridCacheProjection.putx(Object, Object, GridPredicate[]).

Throws:

GridException - See GridCacheProjection.putx(Object, Object, GridPredicate[]).

setxAsync

public GridFuture<Boolean> setxAsync(V val,
                            @Nullable
                            GridPredicate<GridCacheEntry<K,V>>... filter)

This method has the same semantic as GridCacheProjection.putxAsync(Object, Object, GridPredicate[]) method.

Specified by:

setxAsync in interface GridCacheEntry<K,V>

Parameters:

val - See GridCacheProjection.putxAsync(Object, Object, GridPredicate[])

filter - See GridCacheProjection.putxAsync(Object, Object, GridPredicate[]).

Returns:

See GridCacheProjection.putxAsync(Object, Object, GridPredicate[]).

setxIfAbsent

public boolean setxIfAbsent(@Nullable
                   V val)
                     throws GridException

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

Specified by:

setxIfAbsent in interface GridCacheEntry<K,V>

Parameters:

val - See GridCacheProjection.putxIfAbsent(Object, Object)

Returns:

See GridCacheProjection.putxIfAbsent(Object, Object).

Throws:

GridException - See GridCacheProjection.putxIfAbsent(Object, Object).

setxIfAbsentAsync

public GridFuture<Boolean> setxIfAbsentAsync(V val)

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

Specified by:

setxIfAbsentAsync in interface GridCacheEntry<K,V>

Parameters:

val - See GridCacheProjection.putxIfAbsentAsync(Object, Object)

Returns:

See GridCacheProjection.putxIfAbsentAsync(Object, Object).

transform

public void transform(GridClosure<V,V> transformer)
               throws GridException

This method has the same semantic as GridCacheProjection.transform(Object, GridClosure) method.

Specified by:

transform in interface GridCacheEntry<K,V>

Parameters:

transformer - Closure to be applied to the previous value in cache. If this closure returns null, the associated value will be removed from cache.

Throws:

GridException - If cache update failed.

See Also:

GridCacheProjection.transform(Object, GridClosure)

transformAsync

public GridFuture<?> transformAsync(GridClosure<V,V> transformer)

This method has the same semantic as GridCacheProjection.transformAsync(Object, GridClosure) method.

Specified by:

transformAsync in interface GridCacheEntry<K,V>

Parameters:

transformer - Closure to be applied to the previous value in cache. If this closure returns null, the associated value will be removed from cache.

Returns:

Transform operation future.

replace

@Nullable
public V replace(V val)
          throws GridException

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

Specified by:

replace in interface GridCacheEntry<K,V>

Parameters:

val - See GridCacheProjection.replace(Object, Object)

Returns:

See GridCacheProjection.replace(Object, Object).

Throws:

GridException - See GridCacheProjection.replace(Object, Object).

replaceAsync

public GridFuture<V> replaceAsync(V val)

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

Specified by:

replaceAsync in interface GridCacheEntry<K,V>

Parameters:

val - See GridCacheProjection.replaceAsync(Object, Object)

Returns:

See GridCacheProjection.replaceAsync(Object, Object).

replacex

public boolean replacex(V val)
                 throws GridException

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

Specified by:

replacex in interface GridCacheEntry<K,V>

Parameters:

val - See GridCacheProjection.replacex(Object, Object)

Returns:

See GridCacheProjection.replacex(Object, Object).

Throws:

GridException - See GridCacheProjection.replacex(Object, Object).

replacexAsync

public GridFuture<Boolean> replacexAsync(V val)

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

Specified by:

replacexAsync in interface GridCacheEntry<K,V>

Parameters:

val - See GridCacheProjection.replacexAsync(Object, Object)

Returns:

See GridCacheProjection.replacexAsync(Object, Object).

replace

public boolean replace(V oldVal,
              V newVal)
                throws GridException

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

Specified by:

replace in interface GridCacheEntry<K,V>

Parameters:

oldVal - See GridCacheProjection.replace(Object, Object, Object)

newVal - See GridCacheProjection.replace(Object, Object, Object)

Returns:

See GridCacheProjection.replace(Object, Object).

Throws:

GridException - See GridCacheProjection.replace(Object, Object).

replaceAsync

public GridFuture<Boolean> replaceAsync(V oldVal,
                               V newVal)

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

Specified by:

replaceAsync in interface GridCacheEntry<K,V>

Parameters:

oldVal - See GridCacheProjection.replaceAsync(Object, Object, Object)

newVal - See GridCacheProjection.replaceAsync(Object, Object, Object)

Returns:

See GridCacheProjection.replaceAsync(Object, Object).

remove

@Nullable
public V remove(@Nullable
                GridPredicate<GridCacheEntry<K,V>>... filter)
         throws GridException

This method has the same semantic as GridCacheProjection.remove(Object, GridPredicate[]) method.

Specified by:

remove in interface GridCacheEntry<K,V>

Parameters:

filter - See GridCacheProjection.remove(Object, GridPredicate[]).

Returns:

See GridCacheProjection.remove(Object, GridPredicate[]).

Throws:

GridException - See GridCacheProjection.remove(Object, GridPredicate[]).

removeAsync

public GridFuture<V> removeAsync(@Nullable
                        GridPredicate<GridCacheEntry<K,V>>... filter)

This method has the same semantic as GridCacheProjection.removeAsync(Object, GridPredicate[]) method.

Specified by:

removeAsync in interface GridCacheEntry<K,V>

Parameters:

filter - See GridCacheProjection.removeAsync(Object, GridPredicate[]).

Returns:

See GridCacheProjection.removeAsync(Object, GridPredicate[]).

removex

public boolean removex(@Nullable
              GridPredicate<GridCacheEntry<K,V>>... filter)
                throws GridException

This method has the same semantic as GridCacheProjection.removex(Object, GridPredicate[]) method.

Specified by:

removex in interface GridCacheEntry<K,V>

Parameters:

filter - See GridCacheProjection.removex(Object, GridPredicate[]).

Returns:

See GridCacheProjection.removex(Object, GridPredicate[]).

Throws:

GridException - See GridCacheProjection.removex(Object, GridPredicate[]).

removexAsync

public GridFuture<Boolean> removexAsync(@Nullable
                               GridPredicate<GridCacheEntry<K,V>>... filter)

This method has the same semantic as GridCacheProjection.removexAsync(Object, GridPredicate[]) method.

Specified by:

removexAsync in interface GridCacheEntry<K,V>

Parameters:

filter - See GridCacheProjection.removexAsync(Object, GridPredicate[]).

Returns:

See GridCacheProjection.removexAsync(Object, GridPredicate[]).

remove

public boolean remove(V val)
               throws GridException

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

Specified by:

remove in interface GridCacheEntry<K,V>

Parameters:

val - See GridCacheProjection.remove(Object, Object).

Returns:

See GridCacheProjection.remove(Object, Object).

Throws:

GridException - See GridCacheProjection.remove(Object, Object).

removeAsync

public GridFuture<Boolean> removeAsync(V val)

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

Specified by:

removeAsync in interface GridCacheEntry<K,V>

Parameters:

val - See GridCacheProjection.removeAsync(Object, Object).

Returns:

See GridCacheProjection.removeAsync(Object, Object).

evict

public boolean evict()

This method has the same semantic as GridCacheProjection.evict(Object) method.

Specified by:

evict in interface GridCacheEntry<K,V>

Returns:

See GridCacheProjection.evict(Object).

clear

public boolean clear()

This method has the same semantic as GridCacheProjection.clear(Object) method.

Specified by:

clear in interface GridCacheEntry<K,V>

Returns:

See GridCacheProjection.clear(Object).

compact

public boolean compact()
                throws GridException

Optimizes the size of this entry. If entry is expired at the time of the call then entry is removed locally.

Specified by:

compact in interface GridCacheEntry<K,V>

Returns:

true if entry was cleared from cache (if value was null).

Throws:

GridException - If failed to compact.

lock

public boolean lock(long timeout,
           @Nullable
           GridPredicate<GridCacheEntry<K,V>>... filter)
             throws GridException

Synchronously acquires lock on a cached object associated with this entry only if the passed in filter (if any) passes. This method together with filter check will be executed as one atomic operation.

Transactions

Locks are not transactional and should not be used from within transactions. If you do need explicit locking within transaction, then you should use GridCacheTxConcurrency.PESSIMISTIC concurrency control for transaction which will acquire explicit locks for relevant cache operations.

Cache Flags

This method is not available if any of the following flags are set on projection: GridCacheFlag.LOCAL, GridCacheFlag.READ.

Specified by:

lock in interface GridCacheEntry<K,V>

Parameters:

timeout - Timeout in milliseconds to wait for lock to be acquired ('0' for no expiration).

filter - Optional filter to validate prior to acquiring the lock.

Returns:

True if all filters passed and lock was acquired, false otherwise.

Throws:

GridException - If lock acquisition resulted in error.

lockAsync

public GridFuture<Boolean> lockAsync(long timeout,
                            @Nullable
                            GridPredicate<GridCacheEntry<K,V>>... filter)

Asynchronously acquires lock on a cached object associated with this entry only if the passed in filter (if any) passes. This method together with filter check will be executed as one atomic operation.

Transactions

Locks are not transactional and should not be used from within transactions. If you do need explicit locking within transaction, then you should use GridCacheTxConcurrency.PESSIMISTIC concurrency control for transaction which will acquire explicit locks for relevant cache operations.

Cache Flags

This method is not available if any of the following flags are set on projection: GridCacheFlag.LOCAL, GridCacheFlag.READ.

Specified by:

lockAsync in interface GridCacheEntry<K,V>

Parameters:

timeout - Timeout in milliseconds to wait for lock to be acquired ('0' for no expiration).

filter - Optional filter to validate prior to acquiring the lock.

Returns:

Future for the lock operation. The future will return true whenever all filters pass and locks are acquired before timeout is expired, false otherwise.

unlock

public void unlock(GridPredicate<GridCacheEntry<K,V>>... filter)
            throws GridException

Unlocks this entry only if current thread owns the lock. If optional filter will not pass, then unlock will not happen. If this entry was never locked by current thread, then this method will do nothing.

Transactions

Locks are not transactional and should not be used from within transactions. If you do need explicit locking within transaction, then you should use GridCacheTxConcurrency.PESSIMISTIC concurrency control for transaction which will acquire explicit locks for relevant cache operations.

Cache Flags

This method is not available if any of the following flags are set on projection: GridCacheFlag.LOCAL, GridCacheFlag.READ.

Specified by:

unlock in interface GridCacheEntry<K,V>

Parameters:

filter - Optional filter that needs to pass prior to unlock taking effect.

Throws:

GridException - If unlock execution resulted in error.

isCached

public boolean isCached()

Checks whether entry is currently present in cache or not. If entry is not in cache (e.g. has been removed) false is returned. In this case all operations on this entry will cause creation of a new entry in cache.

Specified by:

isCached in interface GridCacheEntry<K,V>

Returns:

True if entry is in cache, false otherwise.

memorySize

public int memorySize()
               throws GridException

Gets size of serialized key and value in addition to any overhead added by GridGain itself.

Specified by:

memorySize in interface GridCacheEntry<K,V>

Returns:

size in bytes.

Throws:

GridException - If failed to evaluate entry size.

copyMeta

public void copyMeta(GridMetadataAware from)

Copies all metadata from another instance.

Specified by:

copyMeta in interface GridMetadataAware

Parameters:

from - Metadata aware instance to copy metadata from.

copyMeta

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

Copies all metadata from given map.

Specified by:

copyMeta in interface GridMetadataAware

Parameters:

data - Map to copy metadata from.

addMeta

@Nullable
public <V> V addMeta(String name,
                     V val)

Adds a new metadata.

Specified by:

addMeta in interface GridMetadataAware

Type Parameters:

V - Type of the value.

Parameters:

name - Metadata name.

val - Metadata value.

Returns:

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

putMetaIfAbsent

@Nullable
public <V> V putMetaIfAbsent(String name,
                             V val)

Adds given metadata value only if it was absent.

Specified by:

putMetaIfAbsent in interface GridMetadataAware

Type Parameters:

V - 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.

putMetaIfAbsent

@Nullable
public <V> V putMetaIfAbsent(String name,
                             Callable<V> c)

Adds given metadata value only if it was absent.

Specified by:

putMetaIfAbsent in interface GridMetadataAware

Type Parameters:

V - 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.

addMetaIfAbsent

public <V> V addMetaIfAbsent(String name,
                    V 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

Type Parameters:

V - 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.

addMetaIfAbsent

@Nullable
public <V> V addMetaIfAbsent(String name,
                             @Nullable
                             Callable<V> c)

Adds given metadata value only if it was absent.

Specified by:

addMetaIfAbsent in interface GridMetadataAware

Type Parameters:

V - 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.

meta

public <V> V meta(String name)

Gets metadata by name.

Specified by:

meta in interface GridMetadataAware

Type Parameters:

V - Type of the value.

Parameters:

name - Metadata name.

Returns:

Metadata value or null.

removeMeta

public <V> V removeMeta(String name)

Removes metadata by name.

Specified by:

removeMeta in interface GridMetadataAware

Type Parameters:

V - Type of the value.

Parameters:

name - Name of the metadata to remove.

Returns:

Value of removed metadata or null.

removeMeta

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

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

Specified by:

removeMeta in interface GridMetadataAware

Type Parameters:

V - Value type.

Parameters:

name - Name of metadata attribute.

val - Value to compare.

Returns:

True if value was removed, false otherwise.

allMeta

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

Gets all metadata in this entry.

Specified by:

allMeta in interface GridMetadataAware

Type Parameters:

V - 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

Parameters:

name - Name of the metadata to test.

Returns:

Whether or not given metadata is set.

hasMeta

public <V> boolean hasMeta(String name,
                  V 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

Type Parameters:

V - Type of the value.

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.

replaceMeta

public <V> boolean replaceMeta(String name,
                      V curVal,
                      V 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

Parameters:

name - Name of the metadata.

curVal - Current value to check.

newVal - New value.

Returns:

true if replacement occurred, false otherwise.

toString

public String toString()

Overrides:

toString in class Object