Package org.springdoc.core

Enum SpringDocConfigProperties.ApiDocs.OpenApiVersion

java.lang.Object

java.lang.Enum<SpringDocConfigProperties.ApiDocs.OpenApiVersion>

org.springdoc.core.SpringDocConfigProperties.ApiDocs.OpenApiVersion

All Implemented Interfaces:

Serializable, Comparable<SpringDocConfigProperties.ApiDocs.OpenApiVersion>

Enclosing class:

SpringDocConfigProperties.ApiDocs

public static enum SpringDocConfigProperties.ApiDocs.OpenApiVersion
extends Enum<SpringDocConfigProperties.ApiDocs.OpenApiVersion>

The enum OpenApiVersion.

Enum Constant Summary

Enum Constants

Enum Constant	Description
OPENAPI_3_0	Openapi 3.0.1 version.
OPENAPI_3_1	Openapi 3.1.0 version.

Method Summary

Modifier and Type	Method	Description
String	getVersion()	Gets open api version.
static SpringDocConfigProperties.ApiDocs.OpenApiVersion	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SpringDocConfigProperties.ApiDocs.OpenApiVersion[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OPENAPI_3_0

public static final SpringDocConfigProperties.ApiDocs.OpenApiVersion OPENAPI_3_0

Openapi 3.0.1 version.

OPENAPI_3_1

public static final SpringDocConfigProperties.ApiDocs.OpenApiVersion OPENAPI_3_1

Openapi 3.1.0 version.

Method Detail

values

public static SpringDocConfigProperties.ApiDocs.OpenApiVersion[] 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 (SpringDocConfigProperties.ApiDocs.OpenApiVersion c : SpringDocConfigProperties.ApiDocs.OpenApiVersion.values())
    System.out.println(c);

Returns:

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

valueOf

public static SpringDocConfigProperties.ApiDocs.OpenApiVersion 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

getVersion

public String getVersion()

Gets open api version.

Returns:

the open api version