Package org.openapitools.codegen.languages.features

Enum DocumentationProviderFeatures.DocumentationProvider

java.lang.Object

java.lang.Enum<DocumentationProviderFeatures.DocumentationProvider>

org.openapitools.codegen.languages.features.DocumentationProviderFeatures.DocumentationProvider

All Implemented Interfaces:

Serializable, Comparable<DocumentationProviderFeatures.DocumentationProvider>

Enclosing interface:

DocumentationProviderFeatures

public static enum DocumentationProviderFeatures.DocumentationProvider
extends Enum<DocumentationProviderFeatures.DocumentationProvider>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NONE
SOURCE
SPRINGDOC
SPRINGFOX
SWAGGER1
SWAGGER2

Method Summary

Modifier and Type	Method	Description
String	getDescription()
DocumentationProviderFeatures.AnnotationLibrary	getPreferredAnnotationLibrary()
String	getPropertyName()	The property name should be used in the codegen model as a boolean property.
DocumentationProviderFeatures.AnnotationLibrary[]	getSupportedAnnotationLibraries()
static DocumentationProviderFeatures.DocumentationProvider	ofCliOption(String optVal)
List<DocumentationProviderFeatures.AnnotationLibrary>	supportedAnnotationLibraries()
String	toCliOptValue()
static DocumentationProviderFeatures.DocumentationProvider	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DocumentationProviderFeatures.DocumentationProvider[]	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

NONE

public static final DocumentationProviderFeatures.DocumentationProvider NONE

SOURCE

public static final DocumentationProviderFeatures.DocumentationProvider SOURCE

SWAGGER1

public static final DocumentationProviderFeatures.DocumentationProvider SWAGGER1

SWAGGER2

public static final DocumentationProviderFeatures.DocumentationProvider SWAGGER2

SPRINGFOX

public static final DocumentationProviderFeatures.DocumentationProvider SPRINGFOX

SPRINGDOC

public static final DocumentationProviderFeatures.DocumentationProvider SPRINGDOC

Method Detail

values

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

Returns:

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

valueOf

public static DocumentationProviderFeatures.DocumentationProvider 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

ofCliOption

public static DocumentationProviderFeatures.DocumentationProvider ofCliOption(String optVal)

getPropertyName

public String getPropertyName()

The property name should be used in the codegen model as a boolean property.

Returns:

the property name for this documentation provider

getDescription

public String getDescription()

getPreferredAnnotationLibrary

public DocumentationProviderFeatures.AnnotationLibrary getPreferredAnnotationLibrary()

getSupportedAnnotationLibraries

public DocumentationProviderFeatures.AnnotationLibrary[] getSupportedAnnotationLibraries()

supportedAnnotationLibraries

public List<DocumentationProviderFeatures.AnnotationLibrary> supportedAnnotationLibraries()

toCliOptValue

public String toCliOptValue()