org.xwiki.security.authorization
Enum RuleState

java.lang.Object
  java.lang.Enum<RuleState>
      org.xwiki.security.authorization.RuleState

All Implemented Interfaces:

Serializable, Comparable<RuleState>

public enum RuleState
extends Enum<RuleState>

The state of a particular right as determined by a security rule.

Since:

4.0M2

Version:

$Id$

Enum Constant Summary

ALLOW
Right is allowed.

DENY
Right is denied.

UNDETERMINED
Right state undetermined.

Method Summary

int	getValue()
static RuleState	valueOf(String name) Returns the enum constant of this type with the specified name.
static RuleState[]	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

UNDETERMINED

public static final RuleState UNDETERMINED

Right state undetermined.

DENY

public static final RuleState DENY

Right is denied.

ALLOW

public static final RuleState ALLOW

Right is allowed.

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public int getValue()

Returns:

state of a rule.