Package org.instancio.settings

Enum Setting

java.lang.Object

java.lang.Enum<Setting>

org.instancio.settings.Setting

All Implemented Interfaces:

Serializable, Comparable<Setting>, SettingKey

public enum Setting
extends Enum<Setting>
implements SettingKey

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARRAY_ELEMENTS_NULLABLE
ARRAY_MAX_LENGTH
ARRAY_MIN_LENGTH
ARRAY_NULLABLE
BOOLEAN_NULLABLE
BYTE_MAX
BYTE_MIN
BYTE_NULLABLE
CHARACTER_NULLABLE
COLLECTION_ELEMENTS_NULLABLE
COLLECTION_MAX_SIZE
COLLECTION_MIN_SIZE
COLLECTION_NULLABLE
DOUBLE_MAX
DOUBLE_MIN
DOUBLE_NULLABLE
FLOAT_MAX
FLOAT_MIN
FLOAT_NULLABLE
INTEGER_MAX
INTEGER_MIN
INTEGER_NULLABLE
LONG_MAX
LONG_MIN
LONG_NULLABLE
MAP_KEYS_NULLABLE
MAP_MAX_SIZE
MAP_MIN_SIZE
MAP_NULLABLE
MAP_VALUES_NULLABLE
SHORT_MAX
SHORT_MIN
SHORT_NULLABLE
STRING_ALLOW_EMPTY
STRING_MAX_LENGTH
STRING_MIN_LENGTH
STRING_NULLABLE

Method Summary

Modifier and Type	Method	Description
<T> T	defaultValue()	Default value for this key.
static Setting	getByKey(String key)
String	key()	A key used in the properties file.
Class<?>	type()	Type of the property value.
static Setting	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Setting[]	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

ARRAY_ELEMENTS_NULLABLE

public static final Setting ARRAY_ELEMENTS_NULLABLE

ARRAY_MAX_LENGTH

public static final Setting ARRAY_MAX_LENGTH

ARRAY_MIN_LENGTH

public static final Setting ARRAY_MIN_LENGTH

ARRAY_NULLABLE

public static final Setting ARRAY_NULLABLE

BOOLEAN_NULLABLE

public static final Setting BOOLEAN_NULLABLE

BYTE_MAX

public static final Setting BYTE_MAX

BYTE_MIN

public static final Setting BYTE_MIN

BYTE_NULLABLE

public static final Setting BYTE_NULLABLE

CHARACTER_NULLABLE

public static final Setting CHARACTER_NULLABLE

COLLECTION_ELEMENTS_NULLABLE

public static final Setting COLLECTION_ELEMENTS_NULLABLE

COLLECTION_MAX_SIZE

public static final Setting COLLECTION_MAX_SIZE

COLLECTION_MIN_SIZE

public static final Setting COLLECTION_MIN_SIZE

COLLECTION_NULLABLE

public static final Setting COLLECTION_NULLABLE

DOUBLE_MAX

public static final Setting DOUBLE_MAX

DOUBLE_MIN

public static final Setting DOUBLE_MIN

DOUBLE_NULLABLE

public static final Setting DOUBLE_NULLABLE

FLOAT_MAX

public static final Setting FLOAT_MAX

FLOAT_MIN

public static final Setting FLOAT_MIN

FLOAT_NULLABLE

public static final Setting FLOAT_NULLABLE

INTEGER_MAX

public static final Setting INTEGER_MAX

INTEGER_MIN

public static final Setting INTEGER_MIN

INTEGER_NULLABLE

public static final Setting INTEGER_NULLABLE

LONG_MAX

public static final Setting LONG_MAX

LONG_MIN

public static final Setting LONG_MIN

LONG_NULLABLE

public static final Setting LONG_NULLABLE

MAP_KEYS_NULLABLE

public static final Setting MAP_KEYS_NULLABLE

MAP_MAX_SIZE

public static final Setting MAP_MAX_SIZE

MAP_MIN_SIZE

public static final Setting MAP_MIN_SIZE

MAP_NULLABLE

public static final Setting MAP_NULLABLE

MAP_VALUES_NULLABLE

public static final Setting MAP_VALUES_NULLABLE

SHORT_MAX

public static final Setting SHORT_MAX

SHORT_MIN

public static final Setting SHORT_MIN

SHORT_NULLABLE

public static final Setting SHORT_NULLABLE

STRING_ALLOW_EMPTY

public static final Setting STRING_ALLOW_EMPTY

STRING_MAX_LENGTH

public static final Setting STRING_MAX_LENGTH

STRING_MIN_LENGTH

public static final Setting STRING_MIN_LENGTH

STRING_NULLABLE

public static final Setting STRING_NULLABLE

Method Detail

values

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

Returns:

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

valueOf

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

key

public String key()

Description copied from interface: SettingKey

A key used in the properties file.

Specified by:

key in interface SettingKey

Returns:

property key

type

public Class<?> type()

Description copied from interface: SettingKey

Type of the property value.

Specified by:

type in interface SettingKey

Returns:

value class

defaultValue

public <T> T defaultValue()

Description copied from interface: SettingKey

Default value for this key.

Specified by:

defaultValue in interface SettingKey

Type Parameters:

T - type of the value

Returns:

default value

getByKey

public static Setting getByKey(String key)