org.infinispan.container

Class DefaultDataContainer<K,V>

java.lang.Object

org.infinispan.container.DefaultDataContainer<K,V>

All Implemented Interfaces:

Iterable<InternalCacheEntry<K,V>>, DataContainer<K,V>

@ThreadSafe
public class DefaultDataContainer<K,V>
extends Object
implements DataContainer<K,V>

DefaultDataContainer is both eviction and non-eviction based data container.

Since:

4.0

Author:

Manik Surtani, Galder Zamarreño, Vladimir Blagojevic, Trustin Lee

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DefaultDataContainer.EntryIterator

Nested classes/interfaces inherited from interface org.infinispan.container.DataContainer

DataContainer.ComputeAction<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected InternalEntryFactory	entryFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
	DefaultDataContainer(int concurrencyLevel)
	DefaultDataContainer(int concurrencyLevel, Equivalence<? super K> keyEq)
protected	DefaultDataContainer(int concurrencyLevel, long thresholdSize, EvictionStrategy strategy, EvictionThreadPolicy policy, Equivalence<? super K> keyEquivalence, EntrySizeCalculator<? super K,? super V> sizeCalculator)
protected	DefaultDataContainer(int concurrencyLevel, long thresholdSize, EvictionStrategy strategy, EvictionThreadPolicy policy, Equivalence<? super K> keyEquivalence, EvictionType thresholdPolicy)

Method Summary

Modifier and Type	Method and Description
static <K,V> DefaultDataContainer<K,V>	boundedDataContainer(int concurrencyLevel, long maxEntries, EvictionStrategy strategy, EvictionThreadPolicy thredPolicy, Equivalence<? super K> keyEquivalence, EntrySizeCalculator<? super K,? super V> sizeCalculator)
static <K,V> DefaultDataContainer<K,V>	boundedDataContainer(int concurrencyLevel, long maxEntries, EvictionStrategy strategy, EvictionThreadPolicy thredPolicy, Equivalence<? super K> keyEquivalence, EvictionType thresholdPolicy)
long	capacity() Returns the capacity of the underlying container.
void	clear() Removes all entries in the container
InternalCacheEntry<K,V>	compute(K key, DataContainer.ComputeAction<K,V> action) Computes the new value for the key.
boolean	containsKey(Object k) Tests whether an entry exists in the container
Set<InternalCacheEntry<K,V>>	entrySet() Returns a mutable set of immutable cache entries exposed as immutable Map.Entry instances.
void	evict(K key) Atomically, it removes the key from DataContainer and passivates it to persistence.
void	executeTask(KeyFilter<? super K> filter, BiConsumer<? super K,InternalCacheEntry<K,V>> action) Executes task specified by the given action on the container key/values filtered using the specified key filter.
void	executeTask(KeyValueFilter<? super K,? super V> filter, BiConsumer<? super K,InternalCacheEntry<K,V>> action) Executes task specified by the given action on the container key/values filtered using the specified keyvalue filter.
InternalCacheEntry<K,V>	get(Object k) Retrieves a cached entry
void	initialize(EvictionManager evictionManager, PassivationManager passivator, InternalEntryFactory entryFactory, ActivationManager activator, PersistenceManager clm, TimeService timeService, CacheNotifier cacheNotifier, ExpirationManager<K,V> expirationManager)
Iterator<InternalCacheEntry<K,V>>	iterator()
Iterator<InternalCacheEntry<K,V>>	iteratorIncludingExpired() Same as DataContainer.iterator() except that is also returns expired entries.
Set<K>	keySet() Returns a set of keys in the container.
InternalCacheEntry<K,V>	peek(Object key) Retrieves a cache entry in the same way as DataContainer.get(Object)} except that it does not update or reorder any of the internal constructs.
void	purgeExpired() This method just calls to ExpirationManager.processExpiration()
void	put(K k, V v, Metadata metadata) Puts an entry in the cache along with metadata adding information such lifespan of entry, max idle time, version information...etc.
InternalCacheEntry<K,V>	remove(Object k) Removes an entry from the cache The key must be activate by invoking ActivationManager.onRemove(Object, boolean).
void	resize(long newSize) Resizes the capacity of the underlying container.
int	size()
int	sizeIncludingExpired()
static <K,V> DefaultDataContainer<K,V>	unBoundedDataContainer(int concurrencyLevel)
static <K,V> DefaultDataContainer<K,V>	unBoundedDataContainer(int concurrencyLevel, Equivalence<? super K> keyEquivalence)
Collection<V>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

entryFactory

protected InternalEntryFactory entryFactory

Constructor Detail

DefaultDataContainer

public DefaultDataContainer(int concurrencyLevel)

DefaultDataContainer

public DefaultDataContainer(int concurrencyLevel,
                            Equivalence<? super K> keyEq)

DefaultDataContainer

protected DefaultDataContainer(int concurrencyLevel,
                               long thresholdSize,
                               EvictionStrategy strategy,
                               EvictionThreadPolicy policy,
                               Equivalence<? super K> keyEquivalence,
                               EvictionType thresholdPolicy)

DefaultDataContainer

protected DefaultDataContainer(int concurrencyLevel,
                               long thresholdSize,
                               EvictionStrategy strategy,
                               EvictionThreadPolicy policy,
                               Equivalence<? super K> keyEquivalence,
                               EntrySizeCalculator<? super K,? super V> sizeCalculator)

Method Detail

initialize

public void initialize(EvictionManager evictionManager,
                       PassivationManager passivator,
                       InternalEntryFactory entryFactory,
                       ActivationManager activator,
                       PersistenceManager clm,
                       TimeService timeService,
                       CacheNotifier cacheNotifier,
                       ExpirationManager<K,V> expirationManager)

boundedDataContainer

public static <K,V> DefaultDataContainer<K,V> boundedDataContainer(int concurrencyLevel,
                                                                   long maxEntries,
                                                                   EvictionStrategy strategy,
                                                                   EvictionThreadPolicy thredPolicy,
                                                                   Equivalence<? super K> keyEquivalence,
                                                                   EvictionType thresholdPolicy)

boundedDataContainer

public static <K,V> DefaultDataContainer<K,V> boundedDataContainer(int concurrencyLevel,
                                                                   long maxEntries,
                                                                   EvictionStrategy strategy,
                                                                   EvictionThreadPolicy thredPolicy,
                                                                   Equivalence<? super K> keyEquivalence,
                                                                   EntrySizeCalculator<? super K,? super V> sizeCalculator)

unBoundedDataContainer

public static <K,V> DefaultDataContainer<K,V> unBoundedDataContainer(int concurrencyLevel,
                                                                     Equivalence<? super K> keyEquivalence)

unBoundedDataContainer

public static <K,V> DefaultDataContainer<K,V> unBoundedDataContainer(int concurrencyLevel)

peek

public InternalCacheEntry<K,V> peek(Object key)

Description copied from interface: DataContainer

Retrieves a cache entry in the same way as DataContainer.get(Object)} except that it does not update or reorder any of the internal constructs. I.e., expiration does not happen, and in the case of the LRU container, the entry is not moved to the end of the chain.

This method should be used instead of DataContainer.get(Object)} when called while iterating through the data container using methods like DataContainer.keySet() to avoid changing the underlying collection's order.

Specified by:

peek in interface DataContainer<K,V>

Parameters:

key - key under which entry is stored

Returns:

entry, if it exists, or null if not

get

public InternalCacheEntry<K,V> get(Object k)

Description copied from interface: DataContainer

Retrieves a cached entry

Specified by:

get in interface DataContainer<K,V>

Parameters:

k - key under which entry is stored

Returns:

entry, if it exists and has not expired, or null if not

put

public void put(K k,
                V v,
                Metadata metadata)

Description copied from interface: DataContainer

Puts an entry in the cache along with metadata adding information such lifespan of entry, max idle time, version information...etc.

The key must be activate by invoking ActivationManager.onUpdate(Object, boolean).

Specified by:

put in interface DataContainer<K,V>

Parameters:

k - key under which to store entry

v - value to store

metadata - metadata of the entry

containsKey

public boolean containsKey(Object k)

Description copied from interface: DataContainer

Tests whether an entry exists in the container

Specified by:

containsKey in interface DataContainer<K,V>

Parameters:

k - key to test

Returns:

true if entry exists and has not expired; false otherwise

remove

public InternalCacheEntry<K,V> remove(Object k)

Description copied from interface: DataContainer

Removes an entry from the cache

The key must be activate by invoking ActivationManager.onRemove(Object, boolean).

Specified by:

remove in interface DataContainer<K,V>

Parameters:

k - key to remove

Returns:

entry removed, or null if it didn't exist or had expired

capacity

public long capacity()

Description copied from interface: DataContainer

Returns the capacity of the underlying container. This is only supported if the container is bounded. An UnsupportedOperationException is thrown otherwise.

Specified by:

capacity in interface DataContainer<K,V>

Returns:

resize

public void resize(long newSize)

Description copied from interface: DataContainer

Resizes the capacity of the underlying container. This is only supported if the container is bounded. An UnsupportedOperationException is thrown otherwise.

Specified by:

resize in interface DataContainer<K,V>

Parameters:

newSize - the new size

size

public int size()

Specified by:

size in interface DataContainer<K,V>

Returns:

count of the number of entries in the container excluding expired entries

sizeIncludingExpired

public int sizeIncludingExpired()

Specified by:

sizeIncludingExpired in interface DataContainer<K,V>

Returns:

count of the number of entries in the container including expired entries

clear

public void clear()

Description copied from interface: DataContainer

Removes all entries in the container

Specified by:

clear in interface DataContainer<K,V>

keySet

public Set<K> keySet()

Description copied from interface: DataContainer

Returns a set of keys in the container. When iterating through the container using this method, clients should never call DataContainer.get(Object) method but instead DataContainer.peek(Object), in order to avoid changing the order of the underlying collection as a side of effect of iterating through it.

Specified by:

keySet in interface DataContainer<K,V>

Returns:

a set of keys

values

public Collection<V> values()

Specified by:

values in interface DataContainer<K,V>

Returns:

a set of values contained in the container

entrySet

public Set<InternalCacheEntry<K,V>> entrySet()

Description copied from interface: DataContainer

Returns a mutable set of immutable cache entries exposed as immutable Map.Entry instances. Clients of this method such as Cache.entrySet() operation implementors are free to convert the set into an immutable set if needed, which is the most common use case.

If a client needs to iterate through a mutable set of mutable cache entries, it should iterate the container itself rather than iterating through the return of entrySet().

Specified by:

entrySet in interface DataContainer<K,V>

Returns:

a set of immutable cache entries

purgeExpired

public void purgeExpired()

Description copied from interface: DataContainer

This method just calls to ExpirationManager.processExpiration()

Specified by:

purgeExpired in interface DataContainer<K,V>

See Also:

ExpirationManager.processExpiration()

evict

public void evict(K key)

Description copied from interface: DataContainer

Atomically, it removes the key from DataContainer and passivates it to persistence.

The passivation must be done by invoking the method PassivationManager.passivate(org.infinispan.container.entries.InternalCacheEntry).

Specified by:

evict in interface DataContainer<K,V>

Parameters:

key - The key to evict.

compute

public InternalCacheEntry<K,V> compute(K key,
                                       DataContainer.ComputeAction<K,V> action)

Description copied from interface: DataContainer

Computes the new value for the key.

See DataContainer.ComputeAction.compute(Object, org.infinispan.container.entries.InternalCacheEntry, InternalEntryFactory).

The key must be activate by invoking ActivationManager.onRemove(Object, boolean) or ActivationManager.onUpdate(Object, boolean) depending if the value returned by the DataContainer.ComputeAction is null or not respectively.

Note the entry provided to DataContainer.ComputeAction may be expired as these entries are not filtered as many other methods do.

Specified by:

compute in interface DataContainer<K,V>

Parameters:

key - The key.

action - The action that will compute the new value.

Returns:

The InternalCacheEntry associated to the key.

iterator

public Iterator<InternalCacheEntry<K,V>> iterator()

Description copied from interface: DataContainer

This iterator only returns entries that are not expired, however it will not remove them while doing so.

Specified by:

iterator in interface Iterable<InternalCacheEntry<K,V>>

Specified by:

iterator in interface DataContainer<K,V>

Returns:

iterator that doesn't produce expired entries

iteratorIncludingExpired

public Iterator<InternalCacheEntry<K,V>> iteratorIncludingExpired()

Description copied from interface: DataContainer

Same as DataContainer.iterator() except that is also returns expired entries.

Specified by:

iteratorIncludingExpired in interface DataContainer<K,V>

Returns:

iterator that returns all entries including expired ones

executeTask

public void executeTask(KeyFilter<? super K> filter,
                        BiConsumer<? super K,InternalCacheEntry<K,V>> action)
                 throws InterruptedException

Description copied from interface: DataContainer

Executes task specified by the given action on the container key/values filtered using the specified key filter.

Specified by:

executeTask in interface DataContainer<K,V>

Parameters:

filter - the filter for the container keys

action - the specified action to execute on filtered key/values

Throws:

InterruptedException

executeTask

public void executeTask(KeyValueFilter<? super K,? super V> filter,
                        BiConsumer<? super K,InternalCacheEntry<K,V>> action)
                 throws InterruptedException

Description copied from interface: DataContainer

Executes task specified by the given action on the container key/values filtered using the specified keyvalue filter.

Specified by:

executeTask in interface DataContainer<K,V>

Parameters:

filter - the filter for the container key/values

action - the specified action to execute on filtered key/values

Throws:

InterruptedException