org.springframework.boot.web.servlet

Enum DispatcherType

  • java.lang.Object
    • java.lang.Enum<DispatcherType>
      • org.springframework.boot.web.servlet.DispatcherType
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<DispatcherType>

    public enum DispatcherType
extends java.lang.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

    • Enum Constant Summary

      Enum Constants 
      Enum Constant and 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

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method and Description
      static DispatcherType valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static DispatcherType[] 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

      • 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 Detail

      • values

        public static DispatcherType[] 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 (DispatcherType c : DispatcherType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

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