com.helger.photon.basic.security.lock

Enum ELocked

java.lang.Object

java.lang.Enum<ELocked>

com.helger.photon.basic.security.lock.ELocked

All Implemented Interfaces:

ILockedIndicator, Serializable, Comparable<ELocked>

public enum ELocked
extends Enum<ELocked>
implements ILockedIndicator

Locked enumeration

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOCKED
NOT_LOCKED

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isLocked()
boolean	isNotLocked()
static ELocked	valueOf(boolean bLocked)
static ELocked	valueOf(ILockedIndicator eLockingIndicator)
static ELocked	valueOf(String name) Returns the enum constant of this type with the specified name.
static ELocked[]	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

LOCKED

public static final ELocked LOCKED

NOT_LOCKED

public static final ELocked NOT_LOCKED

Method Detail

values

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

Returns:

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

valueOf

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

isLocked

public boolean isLocked()

Specified by:

isLocked in interface ILockedIndicator

Returns:

true if locked and false if not locked.

isNotLocked

public boolean isNotLocked()

Specified by:

isNotLocked in interface ILockedIndicator

Returns:

true if not locked and false if locked.

valueOf

@Nonnull
public static ELocked valueOf(boolean bLocked)

valueOf

@Nonnull
public static ELocked valueOf(@Nonnull
                      ILockedIndicator eLockingIndicator)