Module io.jooby.openapi

Package io.jooby.openapi

Enum Class OpenAPIGenerator.Format

java.lang.Object

java.lang.Enum<OpenAPIGenerator.Format>

io.jooby.openapi.OpenAPIGenerator.Format

All Implemented Interfaces:

Serializable, Comparable<OpenAPIGenerator.Format>, Constable

Enclosing class:

OpenAPIGenerator

public static enum OpenAPIGenerator.Format
extends Enum<OpenAPIGenerator.Format>

Supported 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.
YAML	YAML.

Method Summary

Modifier and Type	Method	Description
String	extension()	File extension.
abstract String	toString(OpenAPIGenerator tool, io.swagger.v3.oas.models.OpenAPI result)	Convert an OpenAPI model to the current format.
static OpenAPIGenerator.Format	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OpenAPIGenerator.Format[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, 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 OpenAPIGenerator.Format JSON

JSON.

YAML

public static final OpenAPIGenerator.Format YAML

YAML.

Method Details

values

public static OpenAPIGenerator.Format[] 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 OpenAPIGenerator.Format 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

extension

@NonNull
public String extension()

File extension.

Returns:

File extension.

toString

@NonNull
public abstract String toString(@NonNull
 OpenAPIGenerator tool,
 @NonNull
 io.swagger.v3.oas.models.OpenAPI result)

Convert an OpenAPI model to the current format.

Parameters:

tool - Generator.

result - Model.

Returns:

String (json or yaml content).