Package com.linecorp.armeria.server.docs
Enum FieldRequirement
- java.lang.Object
-
- java.lang.Enum<FieldRequirement>
-
- com.linecorp.armeria.server.docs.FieldRequirement
-
- All Implemented Interfaces:
Serializable
,Comparable<FieldRequirement>
public enum FieldRequirement extends Enum<FieldRequirement>
The requirement level of a field.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description OPTIONAL
The field is optional.REQUIRED
The field is required.UNSPECIFIED
The requirement level is unspecified and will be handled implicitly by the serialization layer.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static FieldRequirement
valueOf(String name)
Returns the enum constant of this type with the specified name.static FieldRequirement[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
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 Detail
-
values
public static FieldRequirement[] 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 (FieldRequirement c : FieldRequirement.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static FieldRequirement valueOf(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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
-