Module org.basinmc.lavatory

Package org.basinmc.lavatory.rule

Enum Rule.Action

java.lang.Object

java.lang.Enum<Rule.Action>

org.basinmc.lavatory.rule.Rule.Action

All Implemented Interfaces:

Serializable, Comparable<Rule.Action>

Enclosing class:

Rule

public static enum Rule.Action
extends Enum<Rule.Action>

Provides a list of valid rule return values.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALLOW	Permit inclusion
DISALLOW	Deny inclusion

Method Summary

Modifier and Type	Method	Description
static Rule.Action	negate(Rule.Action action)	Retrieves the negated value of the supplied action.
static Rule.Action	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Rule.Action[]	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

ALLOW

public static final Rule.Action ALLOW

Permit inclusion

Indicates that the value to which this rule is attached may be included in the final result.

DISALLOW

public static final Rule.Action DISALLOW

Deny inclusion

Indicates that the value to which this rule is attached may NOT be included in the final result.

Method Detail

values

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

Returns:

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

valueOf

public static Rule.Action 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

negate

@NonNull
public static Rule.Action negate(@NonNull
                                 Rule.Action action)

Retrieves the negated value of the supplied action.

Parameters:

action - an action.

Returns:

a negated action.