Package org.springframework.boot.web.servlet

Enum Class DispatcherType

java.lang.Object

java.lang.Enum<DispatcherType>

org.springframework.boot.web.servlet.DispatcherType

All Implemented Interfaces:

Serializable, Comparable<DispatcherType>, Constable

public enum DispatcherType
extends Enum<DispatcherType>

Enumeration of filter dispatcher types, identical to DispatcherType and used in configuration as the servlet API may not be present.

Since:

2.0.0

Author:

Stephane Nicoll

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASYNC	Apply the filter under calls dispatched from an AsyncContext.
ERROR	Apply the filter when an error is handled.
FORWARD	Apply the filter on "RequestDispatcher.forward()" calls.
INCLUDE	Apply the filter on "RequestDispatcher.include()" calls.
REQUEST	Apply the filter on ordinary client calls.

Method Summary

Modifier and Type	Method	Description
static DispatcherType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DispatcherType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FORWARD

public static final DispatcherType FORWARD

Apply the filter on "RequestDispatcher.forward()" calls.

INCLUDE

public static final DispatcherType INCLUDE

Apply the filter on "RequestDispatcher.include()" calls.

REQUEST

public static final DispatcherType REQUEST

Apply the filter on ordinary client calls.

ASYNC

public static final DispatcherType ASYNC

Apply the filter under calls dispatched from an AsyncContext.

ERROR

public static final DispatcherType ERROR

Apply the filter when an error is handled.

Method Details

values

public static DispatcherType[] values()

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

Returns:

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

valueOf

public static DispatcherType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null