Package com.atlassian.plugin.servlet.filter

Enum Class FilterLocation

java.lang.Object
java.lang.Enum<FilterLocation>
com.atlassian.plugin.servlet.filter.FilterLocation
All Implemented Interfaces:
Serializable, Comparable<FilterLocation>, Constable
public enum FilterLocation extends 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 Details

  • Method Details

    • values

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

    • parse

      @Nonnull public static FilterLocation parse(String value)
      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 matching filter location. Will never be null.
      Throws:
      IllegalArgumentException - If the filter string is null or can't be matched to a filter location enum