com.luciad.util.collections

LuciadLightspeedInterface ILcdMultiKeyCache

All Superinterfaces:

ILcdMultiKeyMap<java.lang.Object,java.lang.Object>, java.util.Map<java.lang.Object,java.lang.Object>

public interface ILcdMultiKeyCache
extends ILcdMultiKeyMap<java.lang.Object,java.lang.Object>

Multi-key cache used by the view to cache data. It allows any type of key and value to be stored in the cache. A multi-key cache is a multi-key map that takes ownership of the stored values. The cache itself can remove entries when needed. See ILcdMultiKeyMap for a detailed description of the workings of a multi-key map.

Since:

2012.0

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
java.util.Set<? extends java.util.Map.Entry<java.lang.Object,? extends ILcdMultiKeyCache>>	branchEntrySet() Gets the entries of this branch's branch map.
java.util.Collection<? extends ILcdMultiKeyCache>	branchValues() Gets the values of this branch's leaf map.
ILcdMultiKeyCache	getBranch(java.lang.Object[] aKeys) Returns the branch that is associated with the given key, or null if the branch does not exist.
ILcdMultiKeyCache	getOrCreateBranch(java.lang.Object[] aKeys) Creates and returns a new branch for the given key.

Methods inherited from interface com.luciad.util.collections.ILcdMultiKeyMap

branchKeySet, branchSize, clearRecursive, get, put, recursiveLeafKeySet, remove, removeRecursive

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

getBranch

ILcdMultiKeyCache getBranch(java.lang.Object[] aKeys)

Description copied from interface: ILcdMultiKeyMap

Returns the branch that is associated with the given key, or null if the branch does not exist.

Specified by:

getBranch in interface ILcdMultiKeyMap<java.lang.Object,java.lang.Object>

Parameters:

aKeys - the key

Returns:

the branch associated with the given key, can be null if a branch does not exist.

See Also:

ILcdMultiKeyMap.getOrCreateBranch(Object[])

getOrCreateBranch

ILcdMultiKeyCache getOrCreateBranch(java.lang.Object[] aKeys)

Description copied from interface: ILcdMultiKeyMap

Creates and returns a new branch for the given key. A new branch (or sub-branch) is only created when necessary.

Specified by:

getOrCreateBranch in interface ILcdMultiKeyMap<java.lang.Object,java.lang.Object>

Parameters:

aKeys - the key

Returns:

the branch associated with the given key. This method never returns null.

branchEntrySet

java.util.Set<? extends java.util.Map.Entry<java.lang.Object,? extends ILcdMultiKeyCache>> branchEntrySet()

Description copied from interface: ILcdMultiKeyMap

Gets the entries of this branch's branch map.

Specified by:

branchEntrySet in interface ILcdMultiKeyMap<java.lang.Object,java.lang.Object>

Returns:

the branch entry set

branchValues

java.util.Collection<? extends ILcdMultiKeyCache> branchValues()

Description copied from interface: ILcdMultiKeyMap

Gets the values of this branch's leaf map.

Specified by:

branchValues in interface ILcdMultiKeyMap<java.lang.Object,java.lang.Object>

Returns:

the branch value set