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>, java.lang.constant.Constable

@UnstableApi
public enum FieldRequirement
extends Enum<FieldRequirement>

The requirement level of a field.

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
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

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.

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

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 type, in the order they are declared.

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 name

NullPointerException - if the argument is null