Enum Class OpenApi.Required

java.lang.Object

java.lang.Enum<OpenApi.Required>

io.helidon.openapi.OpenApi.Required

All Implemented Interfaces:

Serializable, Comparable<OpenApi.Required>, Constable

Enclosing class:

OpenApi

public static enum OpenApi.Required
extends Enum<OpenApi.Required>

Requiredness override.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FALSE	Document the item as optional.
TRUE	Document the item as required.
UNSPECIFIED	Infer requiredness from the HTTP binding and Java type.

Method Summary

Modifier and Type	Method	Description
static OpenApi.Required	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OpenApi.Required[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNSPECIFIED

public static final OpenApi.Required UNSPECIFIED

Infer requiredness from the HTTP binding and Java type.

TRUE

public static final OpenApi.Required TRUE

Document the item as required.

FALSE

public static final OpenApi.Required FALSE

Document the item as optional.

Method Details

values

public static OpenApi.Required[] 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 OpenApi.Required 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