com.terracotta.management.user
Enum UserRole

java.lang.Object
  java.lang.Enum<UserRole>
      com.terracotta.management.user.UserRole

All Implemented Interfaces:

Serializable, Comparable<UserRole>

public enum UserRole
extends Enum<UserRole>

An enumeration describing what are currently implicitly defined user roles for the application.

Author:

brandony

Enum Constant Summary

ADMIN

OPERATOR

TERRACOTTA

Method Summary

static UserRole	byName(String roleName) A convenience method for getting a UserRole by its role name.
static Set<UserRole>	convertRoleNames(Collection<String> roleNames) A convenience method for converting a collection of role names to a Set of UserRole enums.
static Set<String>	convertRoles(Collection<UserRole> roles) A convenience method for converting a collection of UserRoles to a Set of role names.
String	toString()
static UserRole	valueOf(String name) Returns the enum constant of this type with the specified name.
static UserRole[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ADMIN

public static final UserRole ADMIN

OPERATOR

public static final UserRole OPERATOR

TERRACOTTA

public static final UserRole TERRACOTTA

Method Detail

values

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

Returns:

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

valueOf

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

byName

public static UserRole byName(String roleName)

A convenience method for getting a UserRole by its role name.

Parameters:

roleName - to use for lookup

Returns:

the associated UserRole

convertRoleNames

public static Set<UserRole> convertRoleNames(Collection<String> roleNames)

A convenience method for converting a collection of role names to a Set of UserRole enums.

Parameters:

roleNames - to convert

Returns:

the Set of UserRoles

convertRoles

public static Set<String> convertRoles(Collection<UserRole> roles)

A convenience method for converting a collection of UserRoles to a Set of role names.

Parameters:

roles - to convert

Returns:

the Set of role names

toString

public String toString()

Overrides:

toString in class Enum<UserRole>