io.javadog.cws.api.common

Enum TrustLevel

java.lang.Object

java.lang.Enum<TrustLevel>

io.javadog.cws.api.common.TrustLevel

All Implemented Interfaces:

Serializable, Comparable<TrustLevel>

public enum TrustLevel
extends Enum<TrustLevel>

Different Levels of trust, used by the action checks to see if a given Member may perform a specific function.

Since:

CWS 1.0

Author:

Kim Jensen

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADMIN
ALL
READ
SYSOP
WRITE

Method Summary

Modifier and Type	Method and Description
static Set<TrustLevel>	getLevels(TrustLevel level) Returns the explicit list of TrustLevels, which is permitted or contained by the given TrustLevel.
static boolean	isAllowed(TrustLevel level, TrustLevel expected) Checks the given Trust Level against an expected, to verify if the given level may perform an action.
static TrustLevel	valueOf(String name) Returns the enum constant of this type with the specified name.
static TrustLevel[]	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

ALL

public static final TrustLevel ALL

READ

public static final TrustLevel READ

WRITE

public static final TrustLevel WRITE

ADMIN

public static final TrustLevel ADMIN

SYSOP

public static final TrustLevel SYSOP

Method Detail

values

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

Returns:

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

valueOf

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

isAllowed

public static boolean isAllowed(TrustLevel level,
                                TrustLevel expected)

Checks the given Trust Level against an expected, to verify if the given level may perform an action. If the given Trust Level is the same or higher than the expected, then a trust is returned, otherwise a false is returned.

Parameters:

level - The Trust Level to check against the expected

expected - The expected Trust Level

Returns:

True, if the given trust level is allowed, otherwise false

getLevels

public static Set<TrustLevel> getLevels(TrustLevel level)

Returns the explicit list of TrustLevels, which is permitted or contained by the given TrustLevel.

Parameters:

level - The TrustLevel to fetch the set of permitted TrustLevel's for

Returns:

Set with all permitted TrustLevel's