Class MapReturnType

java.lang.Object
com.aerospike.client.cdt.MapReturnType

public final class MapReturnType extends Object
Map return type. Type of data to return when selecting or removing items from the map.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    Return count of items selected.
    static final int
    Return true if count > 0.
    static final int
    Return key index order.
    static final int
    Invert meaning of map command and return values.
    static final int
    Return key for single key read and key list for range read.
    static final int
    Return key/value items.
    static final int
    Do not return a result.
    static final int
    Return an ordered map.
    static final int
    Return value order.
    static final int
    Return reverse key order.
    static final int
    Return reverse value order.
    static final int
    Return an unordered map.
    static final int
    Return value for single key read and value list for range read.
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • NONE

      public static final int NONE
      Do not return a result.
      See Also:
    • INDEX

      public static final int INDEX
      Return key index order.
      • 0 = first key
      • N = Nth key
      • -1 = last key
      See Also:
    • REVERSE_INDEX

      public static final int REVERSE_INDEX
      Return reverse key order.
      • 0 = last key
      • -1 = first key
      See Also:
    • RANK

      public static final int RANK
      Return value order.
      • 0 = smallest value
      • N = Nth smallest value
      • -1 = largest value
      See Also:
    • REVERSE_RANK

      public static final int REVERSE_RANK
      Return reverse value order.
      • 0 = largest value
      • N = Nth largest value
      • -1 = smallest value
      See Also:
    • COUNT

      public static final int COUNT
      Return count of items selected.
      See Also:
    • KEY

      public static final int KEY
      Return key for single key read and key list for range read.
      See Also:
    • VALUE

      public static final int VALUE
      Return value for single key read and value list for range read.
      See Also:
    • KEY_VALUE

      public static final int KEY_VALUE
      Return key/value items. The possible return types are:
      • HashMap : Returned for unordered maps
      • TreeMap : Returned for key ordered maps
      • List<Entry> : Returned for range results where range order needs to be preserved.
      See Also:
    • EXISTS

      public static final int EXISTS
      Return true if count > 0.
      See Also:
    • UNORDERED_MAP

      public static final int UNORDERED_MAP
      Return an unordered map.
      See Also:
    • ORDERED_MAP

      public static final int ORDERED_MAP
      Return an ordered map.
      See Also:
    • INVERTED

      public static final int INVERTED
      Invert meaning of map command and return values. For example:
      MapOperation.removeByKeyRange(binName, keyBegin, keyEnd, MapReturnType.KEY | MapReturnType.INVERTED);
      With the INVERTED flag enabled, the keys outside of the specified key range will be removed and returned.
      See Also:
  • Constructor Details

    • MapReturnType

      public MapReturnType()