Enum Class FieldLocation

java.lang.Object
java.lang.Enum<FieldLocation>
com.linecorp.armeria.server.docs.FieldLocation
All Implemented Interfaces:
Serializable, Comparable<FieldLocation>, Constable

@UnstableApi public enum FieldLocation extends Enum<FieldLocation>
The location of a field.
  • Enum Constant Details

    • PATH

      public static final FieldLocation PATH
      The field is located in the path.
    • QUERY

      public static final FieldLocation QUERY
      The field is located in the query.
    • BODY

      public static final FieldLocation BODY
      The field is located in the request body.
    • UNSPECIFIED

      public static final FieldLocation UNSPECIFIED
      The location of the field is unspecified.
  • Method Details

    • values

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