Module com.aoapps.servlet.firewall.api

Package com.aoapps.servlet.firewall.api

Enum Matcher.Result

java.lang.Object

java.lang.Enum<Matcher.Result>

com.aoapps.servlet.firewall.api.Matcher.Result

All Implemented Interfaces:

Serializable, Comparable<Matcher.Result>

Enclosing interface:

Matcher

public static enum Matcher.Result
extends Enum<Matcher.Result>

The set of matcher results.

Enum Constant Summary

Enum Constants

Enum Constant	Description
MATCH	Indicates matched.
NO_MATCH	Indicates no match.
TERMINATE	Indicates that a terminal action has been performed.

Method Summary

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

NO_MATCH

public static final Matcher.Result NO_MATCH

Indicates no match.

MATCH

public static final Matcher.Result MATCH

Indicates matched.

TERMINATE

public static final Matcher.Result TERMINATE

Indicates that a terminal action has been performed. Rule processing must stop. Valid from either Matcher or Action, however it must originate only from an Action and may be propagated up the stack through Matcher. We are favoring this propagation of return over exceptions.

See Also:

• Action.Result.TERMINATE

Method Details

values

public static Matcher.Result[] values()

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

Returns:

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

valueOf

public static Matcher.Result 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