com.atlassian.plugin.servlet.filter
Enum FilterLocation

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

All Implemented Interfaces:

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

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

An enumeration defining the places plugin filters can appear in an applications filter stack. The locations are defined by what operations they immediate precede or follow.

Since:

2.1.0

Enum Constant Summary

AFTER_ENCODING

BEFORE_DECORATION

BEFORE_DISPATCH

BEFORE_LOGIN

Method Summary

static FilterLocation	parse(java.lang.String value) Parses a filter location from a string.
static FilterLocation	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FilterLocation[]	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

AFTER_ENCODING

public static final FilterLocation AFTER_ENCODING

BEFORE_LOGIN

public static final FilterLocation BEFORE_LOGIN

BEFORE_DECORATION

public static final FilterLocation BEFORE_DECORATION

BEFORE_DISPATCH

public static final FilterLocation BEFORE_DISPATCH

Method Detail

values

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

Returns:

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

valueOf

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

parse

public static FilterLocation parse(java.lang.String value)
                            throws java.lang.IllegalArgumentException

Parses a filter location from a string. Characters are converted to uppercase, and dashes into underscores.

Parameters:

value - The filter location as a string

Returns:

The The matching filter location. Will never be null.

Throws:

java.lang.IllegalArgumentException - If the filter string is null or can't be matched to a filter location enum