Module io.helidon.openapi

Package io.helidon.openapi

Enum Class OpenApiFormat

java.lang.Object

java.lang.Enum<OpenApiFormat>

io.helidon.openapi.OpenApiFormat

All Implemented Interfaces:

Serializable, Comparable<OpenApiFormat>, Constable

public enum OpenApiFormat
extends Enum<OpenApiFormat>

Supported OpenApi formats.

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
JSON	JSON.
UNSUPPORTED	Unsupported format.
YAML	YAML.

Method Summary

Modifier and Type	Method	Description
List<String>	fileTypes()	File types usable with this format.
static OpenApiFormat	valueOf(MediaType mediaType)	Find OpenAPI media type by media type.
static OpenApiFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OpenApiFormat[]	values()	Returns an array containing the constants of this enum class, 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

JSON

public static final OpenApiFormat JSON

JSON.

YAML

public static final OpenApiFormat YAML

YAML.

UNSUPPORTED

public static final OpenApiFormat UNSUPPORTED

Unsupported format.

Method Details

values

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

fileTypes

public List<String> fileTypes()

File types usable with this format.

Returns:

file types

valueOf

public static OpenApiFormat valueOf(MediaType mediaType)

Find OpenAPI media type by media type.

Parameters:

mediaType - media type

Returns:

OpenAPI media type