org.spincast.core.dictionary

Enum DictionaryEntryNotFoundBehavior

java.lang.Object

java.lang.Enum<DictionaryEntryNotFoundBehavior>

org.spincast.core.dictionary.DictionaryEntryNotFoundBehavior

All Implemented Interfaces:

Serializable, Comparable<DictionaryEntryNotFoundBehavior>

public enum DictionaryEntryNotFoundBehavior
extends Enum<DictionaryEntryNotFoundBehavior>

How to deal with a key that is not found in the dictionary, at runtime?

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXCEPTION A DictionaryKeyNotFoundException exception will be thrown.
RETURN_EMPTY_STRING Returns an empty string
RETURN_KEY Returns the key itself.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EXCEPTION

public static final DictionaryEntryNotFoundBehavior EXCEPTION

A DictionaryKeyNotFoundException exception will be thrown.

RETURN_KEY

public static final DictionaryEntryNotFoundBehavior RETURN_KEY

Returns the key itself.

RETURN_EMPTY_STRING

public static final DictionaryEntryNotFoundBehavior RETURN_EMPTY_STRING

Returns an empty string

Method Detail

values

public static DictionaryEntryNotFoundBehavior[] 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 (DictionaryEntryNotFoundBehavior c : DictionaryEntryNotFoundBehavior.values())
    System.out.println(c);

Returns:

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

valueOf

public static DictionaryEntryNotFoundBehavior 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