com.atlassian.plugin.servlet.filter
Enum FilterDispatcherCondition

java.lang.Object
  java.lang.Enum<FilterDispatcherCondition>
      com.atlassian.plugin.servlet.filter.FilterDispatcherCondition

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FilterDispatcherCondition>

public enum FilterDispatcherCondition
extends java.lang.Enum<FilterDispatcherCondition>

The dispatching conditions that are taken into account when deciding to match a filter. These match to the dispatcher values allowed in the Servlet API version 2.4.

Since:

2.5.0

Enum Constant Summary

ERROR

FORWARD

INCLUDE

REQUEST

Method Summary

static boolean	contains(java.lang.String dispatcher) Determines if a dispatcher value is a valid condition
static FilterDispatcherCondition	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FilterDispatcherCondition[]	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

REQUEST

public static final FilterDispatcherCondition REQUEST

INCLUDE

public static final FilterDispatcherCondition INCLUDE

FORWARD

public static final FilterDispatcherCondition FORWARD

ERROR

public static final FilterDispatcherCondition ERROR

Method Detail

values

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

Returns:

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

valueOf

public static FilterDispatcherCondition valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

contains

public static boolean contains(java.lang.String dispatcher)

Determines if a dispatcher value is a valid condition

Parameters:

dispatcher - The dispatcher value. Null allowed.

Returns:

True if valid, false otherwise