Package com.cedarsoftware.util

Enum Class MultiKeyMap.KeyMode

java.lang.Object

java.lang.Enum<MultiKeyMap.KeyMode>

com.cedarsoftware.util.MultiKeyMap.KeyMode

All Implemented Interfaces:

Serializable, Comparable<MultiKeyMap.KeyMode>, Constable

Enclosing class:

MultiKeyMap<V>

public static enum MultiKeyMap.KeyMode
extends Enum<MultiKeyMap.KeyMode>

Enum to control how keys are stored in put() operations. Used as optional last parameter in varargs put() method.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
SINGLE_KEY	Store the preceding keys as a single key without auto-unpacking.

Method Summary

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

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SINGLE_KEY

public static final MultiKeyMap.KeyMode SINGLE_KEY

Store the preceding keys as a single key without auto-unpacking. Use this when you want Collections or Arrays to be treated as single keys rather than being auto-unpacked into multiple key dimensions.

Method Details

values

public static MultiKeyMap.KeyMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MultiKeyMap.KeyMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null