Enum Class IStorage.StructureFlag

java.lang.Object

java.lang.Enum<IStorage.StructureFlag>

nl.pim16aap2.animatedarchitecture.core.storage.IStorage.StructureFlag

All Implemented Interfaces:

Serializable, Comparable<IStorage.StructureFlag>, Constable, IBitFlag

Enclosing interface:

IStorage

public static enum IStorage.StructureFlag
extends Enum<IStorage.StructureFlag>
implements IBitFlag

Set of bit flags to represent various properties of structures.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
IS_LOCKED	Consider a structure to be locked if this flag is enabled.

Method Summary

Modifier and Type	Method	Description
static long	getFlagValue(IStorage.StructureFlag flag)	Gets the flag value of a IStorage.StructureFlag.
static IStorage.StructureFlag	valueOf(String name)	Returns the enum constant of this class with the specified name.
static IStorage.StructureFlag[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

IS_LOCKED

public static final IStorage.StructureFlag IS_LOCKED

Consider a structure to be locked if this flag is enabled.

Method Details

values

public static IStorage.StructureFlag[] 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 IStorage.StructureFlag 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

getFlagValue

public static long getFlagValue(IStorage.StructureFlag flag)

Gets the flag value of a IStorage.StructureFlag.

Parameters:

flag - The IStorage.StructureFlag.

Returns:

The flag value of a IStorage.StructureFlag.