Package com.apple.foundationdb.map

Class BunchedMapScanEntry<K,​V,​T>

  • Type Parameters:
    K - type of keys in the bunched map
    V - type of values in the bunched map
    T - 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 more BunchedMaps using the scanMulti() function. This is the type returned by an BunchedMapMultiIterator. It includes, as one might expect from a map entry object, a key and a value contained within a BunchedMap. 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 a SubspaceSplitter.

    • Method Detail

      • getSubspace

        @Nonnull
public Subspace getSubspace()
        Returns the subspace containing this entry. There should be one instance of a BunchedMap within this Subspace.
        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 calling splitter.subspaceTag(getSubspace()) where splitter is the SubspaceSplitter 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 be null if the SubspaceSplitter can return null.
        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

      • getValue

        @Nonnull
public V getValue()
        Returns the value from this entry.
        Returns:
        the map value associated with this entry