Enum Class OpenApiGeneratedMode

java.lang.Object

java.lang.Enum<OpenApiGeneratedMode>

io.helidon.openapi.OpenApiGeneratedMode

All Implemented Interfaces:

Serializable, Comparable<OpenApiGeneratedMode>, Constable

public enum OpenApiGeneratedMode
extends Enum<OpenApiGeneratedMode>

Generated OpenAPI document source handling mode.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GENERATED_ONLY	Use only generated document sources, even when a static document is present.
MERGE	Strictly merge generated document sources into a static document.
STATIC_FIRST	Use a static document when present, otherwise use generated document sources.
STATIC_ONLY	Use only a static document and ignore generated document sources.

Method Summary

Modifier and Type	Method	Description
static OpenApiGeneratedMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OpenApiGeneratedMode[]	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

STATIC_FIRST

public static final OpenApiGeneratedMode STATIC_FIRST

Use a static document when present, otherwise use generated document sources.

STATIC_ONLY

public static final OpenApiGeneratedMode STATIC_ONLY

Use only a static document and ignore generated document sources.

MERGE

public static final OpenApiGeneratedMode MERGE

Strictly merge generated document sources into a static document.

Static and generated content must be non-conflicting; composition fails if both sides define incompatible document values, the same path operation, or duplicate operationId values.

GENERATED_ONLY

public static final OpenApiGeneratedMode GENERATED_ONLY

Use only generated document sources, even when a static document is present.

Method Details

values

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