Package com.apple.foundationdb.map
Class BunchedMapScanEntry<K,V,T>
- java.lang.Object
-
- com.apple.foundationdb.map.BunchedMapScanEntry<K,V,T>
-
- Type Parameters:
K
- type of keys in the bunched mapV
- type of values in the bunched mapT
- type of the tag associated with each subspace
@API(EXPERIMENTAL) public class BunchedMapScanEntry<K,V,T> extends Object
Struct containing the results of scanning one or moreBunchedMap
s using thescanMulti()
function. This is the type returned by anBunchedMapMultiIterator
. It includes, as one might expect from a map entry object, a key and a value contained within aBunchedMap
. However, it also contains information about which subspace the key and value were contained within and which "tag" the subspace was associated with. This is the same subspace and tag that is returned by aSubspaceSplitter
.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description K
getKey()
Returns the key from this entry.Subspace
getSubspace()
Returns the subspace containing this entry.T
getSubspaceTag()
Returns the tag associated with the subspace containing this entry.V
getValue()
Returns the value from this entry.
-
-
-
Method Detail
-
getSubspace
@Nonnull public Subspace getSubspace()
Returns the subspace containing this entry. There should be one instance of aBunchedMap
within thisSubspace
.- Returns:
- the subspace containing this entry
-
getSubspaceTag
@Nullable public T getSubspaceTag()
Returns the tag associated with the subspace containing this entry. This will be consistent with callingsplitter.subspaceTag(getSubspace())
wheresplitter
is theSubspaceSplitter
that was used to distinguish between different subspaces within a multi-map scan. However, this method does not have to recalculate the tag. In particular, it can only benull
if theSubspaceSplitter
can returnnull
.- Returns:
- the tag associated with the subspace containing this entry
-
getKey
@Nonnull public K getKey()
Returns the key from this entry.- Returns:
- the map key associated with this entry
-
-