io.jooby.openapi

Enum OpenAPIGenerator.Format

java.lang.Object

java.lang.Enum<OpenAPIGenerator.Format>

io.jooby.openapi.OpenAPIGenerator.Format

All Implemented Interfaces:

Serializable, Comparable<OpenAPIGenerator.Format>

Enclosing class:

OpenAPIGenerator

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

Supported formats.

Enum Constant Summary

Enum Constants

Enum Constant and Description
JSON JSON.
YAML YAML.

Method Summary

Modifier and Type	Method and 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 type with the specified name.
static OpenAPIGenerator.Format[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

JSON

public static final OpenAPIGenerator.Format JSON

JSON.

YAML

public static final OpenAPIGenerator.Format YAML

YAML.

Method Detail

values

public static OpenAPIGenerator.Format[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OpenAPIGenerator.Format c : OpenAPIGenerator.Format.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

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

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