Package org.cyclos.model.system.channelconfigurations

Enum UserChannelAccess

java.lang.Object

java.lang.Enum<UserChannelAccess>

org.cyclos.model.system.channelconfigurations.UserChannelAccess

All Implemented Interfaces:

Serializable, Comparable<UserChannelAccess>, HasMessageKey

public enum UserChannelAccess
extends Enum<UserChannelAccess>
implements HasMessageKey

Defines how a user access a channel

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFAULT_DISABLED	New users cannot access the channel by default, but can enable the access
DEFAULT_ENABLED	New users can access the channel by default, but can disable the access
ENFORCED_ENABLED	Users in this configuration always access the channel

Method Summary

Modifier and Type	Method	Description
MessageKey	getMessageKey()
static UserChannelAccess	valueOf(String name)	Returns the enum constant of this type with the specified name.
static UserChannelAccess[]	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

DEFAULT_ENABLED

public static final UserChannelAccess DEFAULT_ENABLED

New users can access the channel by default, but can disable the access

DEFAULT_DISABLED

public static final UserChannelAccess DEFAULT_DISABLED

New users cannot access the channel by default, but can enable the access

ENFORCED_ENABLED

public static final UserChannelAccess ENFORCED_ENABLED

Users in this configuration always access the channel

Method Detail

values

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

Returns:

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

valueOf

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

getMessageKey

public MessageKey getMessageKey()

Specified by:

getMessageKey in interface HasMessageKey