Interface DocumentationProviderFeatures
-
- All Known Implementing Classes:
AbstractJavaCodegen
,AbstractJavaJAXRSServerCodegen
,GroovyClientCodegen
,JavaCamelServerCodegen
,JavaClientCodegen
,JavaCXFClientCodegen
,JavaCXFExtServerCodegen
,JavaCXFServerCodegen
,JavaHelidonClientCodegen
,JavaHelidonCommonCodegen
,JavaHelidonServerCodegen
,JavaInflectorServerCodegen
,JavaJAXRSCXFCDIServerCodegen
,JavaJAXRSSpecServerCodegen
,JavaJerseyServerCodegen
,JavaMicronautAbstractCodegen
,JavaMicronautClientCodegen
,JavaMicronautServerCodegen
,JavaMSF4JServerCodegen
,JavaPKMSTServerCodegen
,JavaPlayFrameworkCodegen
,JavaResteasyEapServerCodegen
,JavaResteasyServerCodegen
,JavaUndertowServerCodegen
,JavaVertXServerCodegen
,JavaVertXWebServerCodegen
,KotlinSpringServerCodegen
,SpringCodegen
public interface DocumentationProviderFeatures
The DocumentationProvider Features support to additional properties to select the documentation provider and the annotation library to use during code generation.- Since:
- 5.4.0
- Author:
- cachescrubber, 2022-01-08
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
DocumentationProviderFeatures.AnnotationLibrary
static class
DocumentationProviderFeatures.DocumentationProvider
-
Field Summary
Fields Modifier and Type Field Description static String
ANNOTATION_LIBRARY
static String
DOCUMENTATION_PROVIDER
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default DocumentationProviderFeatures.DocumentationProvider
defaultDocumentationProvider()
Define the default documentation Provider for CliOpts processing.DocumentationProviderFeatures.AnnotationLibrary
getAnnotationLibrary()
DocumentationProviderFeatures.DocumentationProvider
getDocumentationProvider()
void
setAnnotationLibrary(DocumentationProviderFeatures.AnnotationLibrary annotationLibrary)
void
setDocumentationProvider(DocumentationProviderFeatures.DocumentationProvider documentationProvider)
default List<DocumentationProviderFeatures.AnnotationLibrary>
supportedAnnotationLibraries()
Define the list of supported annotation libraries for CliOpts processing.default List<DocumentationProviderFeatures.DocumentationProvider>
supportedDocumentationProvider()
Define the List of supported documentation Provider for CliOpts processing.
-
-
-
Field Detail
-
DOCUMENTATION_PROVIDER
static final String DOCUMENTATION_PROVIDER
- See Also:
- Constant Field Values
-
ANNOTATION_LIBRARY
static final String ANNOTATION_LIBRARY
- See Also:
- Constant Field Values
-
-
Method Detail
-
defaultDocumentationProvider
default DocumentationProviderFeatures.DocumentationProvider defaultDocumentationProvider()
Define the default documentation Provider for CliOpts processing. A NULL return value will disable the documentation provider support. Override in subclasses to customize.- Returns:
- the default documentation provider
-
supportedDocumentationProvider
default List<DocumentationProviderFeatures.DocumentationProvider> supportedDocumentationProvider()
Define the List of supported documentation Provider for CliOpts processing. Override in subclasses to customize.- Returns:
- the list of supported documentation provider
-
supportedAnnotationLibraries
default List<DocumentationProviderFeatures.AnnotationLibrary> supportedAnnotationLibraries()
Define the list of supported annotation libraries for CliOpts processing. Override in subclasses to customize.- Returns:
- the list of supported annotation libraries
-
getDocumentationProvider
DocumentationProviderFeatures.DocumentationProvider getDocumentationProvider()
-
setDocumentationProvider
void setDocumentationProvider(DocumentationProviderFeatures.DocumentationProvider documentationProvider)
-
getAnnotationLibrary
DocumentationProviderFeatures.AnnotationLibrary getAnnotationLibrary()
-
setAnnotationLibrary
void setAnnotationLibrary(DocumentationProviderFeatures.AnnotationLibrary annotationLibrary)
-
-