Package jakarta.servlet.http

Enum Class MappingMatch

java.lang.Object
java.lang.Enum<MappingMatch>
jakarta.servlet.http.MappingMatch
All Implemented Interfaces:
Serializable, Comparable<MappingMatch>, Constable
public enum MappingMatch extends Enum<MappingMatch>

Enumeration of Servlet mapping types.

Since:
4.0

  • 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
    CONTEXT_ROOT
    This is used when the mapping was achieved with an exact match to the application's context root.
    DEFAULT
    This is used when the mapping was achieved with an exact match to the default servlet of the application, the '/' character.
    EXACT
    This is used when the mapping was achieved with an exact match to the incoming request.
    EXTENSION
    This is used when the mapping was achieved using an extension, such as "*.xhtml".
    PATH
    This is used when the mapping was achieved using a path, such as "/faces/*".

  • Method Summary

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

    • CONTEXT_ROOT

      public static final MappingMatch CONTEXT_ROOT

      This is used when the mapping was achieved with an exact match to the application's context root.

    • DEFAULT

      public static final MappingMatch DEFAULT

      This is used when the mapping was achieved with an exact match to the default servlet of the application, the '/' character.

    • EXACT

      public static final MappingMatch EXACT

      This is used when the mapping was achieved with an exact match to the incoming request.

    • EXTENSION

      public static final MappingMatch EXTENSION

      This is used when the mapping was achieved using an extension, such as "*.xhtml".

    • PATH

      public static final MappingMatch PATH

      This is used when the mapping was achieved using a path, such as "/faces/*".

  • Method Details

    • values

      public static MappingMatch[] 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 MappingMatch 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