Enum Class FieldRequirement

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

@UnstableApi public enum FieldRequirement extends Enum<FieldRequirement>
The requirement level of a field.
  • Enum Constant Details

    • REQUIRED

      public static final FieldRequirement REQUIRED
      The field is required. The invocation will fail if the field is not specified.
    • OPTIONAL

      public static final FieldRequirement OPTIONAL
      The field is optional. The invocation will work even if the field is not specified.
    • UNSPECIFIED

      public static final FieldRequirement UNSPECIFIED
      The requirement level is unspecified and will be handled implicitly by the serialization layer.
  • Method Details

    • values

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