MapReturnType (aerospike-client 3.3.3 API)

java.lang.Object
- java.lang.Enum<MapReturnType>
- - com.aerospike.client.cdt.MapReturnType

All Implemented Interfaces:

Serializable, Comparable<MapReturnType>
```
public enum MapReturnType
extends Enum<MapReturnType>
```
Map return type. Type of data to return when selecting or removing items from the map.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`COUNT` Return count of items selected.
`INDEX` Return key index order.
`KEY` Return key for single key read and key list for range read.
`KEY_VALUE` Return key/value items.
`NONE` Do not return a result.
`RANK` Return value order.
`REVERSE_INDEX` Return reverse key order.
`REVERSE_RANK` Return reserve value order.
`VALUE` Return value for single key read and value list for range read.

Method Summary

Methods
Modifier and Type	Method and Description
`static MapReturnType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static MapReturnType[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - NONE
```
public static final MapReturnType NONE
```
    Do not return a result.
  - INDEX
```
public static final MapReturnType INDEX
```
    Return key index order.
    - 0 = first key
    - N = Nth key
    - -1 = last key
  - REVERSE_INDEX
```
public static final MapReturnType REVERSE_INDEX
```
    Return reverse key order.
    - 0 = last key
    - -1 = first key
  - RANK
```
public static final MapReturnType RANK
```
    Return value order.
    - 0 = smallest value
    - N = Nth smallest value
    - -1 = largest value
  - REVERSE_RANK
```
public static final MapReturnType REVERSE_RANK
```
    Return reserve value order.
    - 0 = largest value
    - N = Nth largest value
    - -1 = smallest value
  - COUNT
```
public static final MapReturnType COUNT
```
    Return count of items selected.
  - KEY
```
public static final MapReturnType KEY
```
    Return key for single key read and key list for range read.
  - VALUE
```
public static final MapReturnType VALUE
```
    Return value for single key read and value list for range read.
  - KEY_VALUE
```
public static final MapReturnType 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.
- Method Detail
  - values
```
public static MapReturnType[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (MapReturnType c : MapReturnType.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static MapReturnType valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    name - the name of the enum constant to be returned.
    
    Returns:
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null

Enum MapReturnType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NONE

INDEX

REVERSE_INDEX

RANK

REVERSE_RANK

COUNT

KEY

VALUE

KEY_VALUE

Method Detail

values

valueOf