Package net.solarnetwork.node.domain

Enum Class Setting.SettingFlag

java.lang.Object

java.lang.Enum<Setting.SettingFlag>

net.solarnetwork.node.domain.Setting.SettingFlag

All Implemented Interfaces:

Serializable, Comparable<Setting.SettingFlag>, Constable

Enclosing class:

Setting

public static enum Setting.SettingFlag
extends Enum<Setting.SettingFlag>

An enumeration of setting flags.

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
IgnoreModificationDate	Ignore the modification date.
Volatile	The setting is "volatile" and should not be persisted.

Method Summary

Modifier and Type	Method	Description
static Setting.SettingFlag	forKey(int key)	Get a SettingFlag for a given key.
int	getKey()	Get the key value.
static int	maskForSet(Set<Setting.SettingFlag> set)	Get a mask from a set of SettingFlag.
static Set<Setting.SettingFlag>	setForMask(int mask)	Create a set of SettingFlag from a mask.
static Setting.SettingFlag	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Setting.SettingFlag[]	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

IgnoreModificationDate

public static final Setting.SettingFlag IgnoreModificationDate

Ignore the modification date.

Volatile

public static final Setting.SettingFlag Volatile

The setting is "volatile" and should not be persisted.

Method Details

values

public static Setting.SettingFlag[] 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 Setting.SettingFlag 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

getKey

public int getKey()

Get the key value.

Returns:

the key

forKey

public static Setting.SettingFlag forKey(int key)

Get a SettingFlag for a given key.

Parameters:

key - the key

Returns:

the flag

Throws:

IllegalArgumentException - if the key is not valid

setForMask

public static Set<Setting.SettingFlag> setForMask(int mask)

Create a set of SettingFlag from a mask.

Parameters:

mask - the mask

Returns:

the set (never null)

maskForSet

public static int maskForSet(Set<Setting.SettingFlag> set)

Get a mask from a set of SettingFlag.

Parameters:

set - the set

Returns:

the mask