Package com.codingchili.core.protocol

Enum Class Role

java.lang.Object

java.lang.Enum<Role>

com.codingchili.core.protocol.Role

All Implemented Interfaces:

RoleType, Serializable, Comparable<Role>, Constable

public enum Role
extends Enum<Role>
implements RoleType

Extend this interface to provide more role types. These values are used in annotations.

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
ADMIN
PUBLIC
UNSET
USER

Method Summary

Modifier and Type	Method	Description
int	getLevel()	Roles level of the role, a role with a higher access level gains the privilegies of all roles with a lesser level.
String	getName()	Returns the name of the role, must be unique.
static Role	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Role[]	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

ADMIN

public static final Role ADMIN

USER

public static final Role USER

PUBLIC

public static final Role PUBLIC

UNSET

public static final Role UNSET

Method Details

values

public static Role[] 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 Role 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

getName

public String getName()

Description copied from interface: RoleType

Returns the name of the role, must be unique.

Specified by:

getName in interface RoleType

Returns:

the name fo the role.

getLevel

public int getLevel()

Description copied from interface: RoleType

Roles level of the role, a role with a higher access level gains the privilegies of all roles with a lesser level.

To disable this feature set all levels to 0.

Specified by:

getLevel in interface RoleType

Returns:

the access level of the role.