Class OpenApiExtensionProvider

java.lang.Object

io.helidon.declarative.codegen.openapi.OpenApiExtensionProvider

All Implemented Interfaces:

CodegenProvider, RegistryCodegenExtensionProvider

public class OpenApiExtensionProvider
extends Object
implements RegistryCodegenExtensionProvider

Java ServiceLoader provider implementation for declarative OpenAPI code generation.

Constructor Summary

Constructors

Constructor	Description
OpenApiExtensionProvider()	Required public constructor for ServiceLoader.

Method Summary

Modifier and Type	Method	Description
RegistryCodegenExtension	create(RegistryCodegenContext ctx)	Create a new extension based on the context.
Set<TypeName>	supportedAnnotations()	Annotations that are supported.
boolean	supportsServiceContractAnnotations()	Whether this extension should also process services whose service contracts contain annotations supported by this extension.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface CodegenProvider

supportedAnnotationPackages, supportedMetaAnnotations, supportedOptions

Modifier and Type	Method	Description
default Set<String>	supportedAnnotationPackages()	Supported packages of annotations.
default Set<TypeName>	supportedMetaAnnotations()	Inherited annotations that are supported.
default Set<Option<?>>	supportedOptions()	Configuration options that are supported.

Methods inherited from interface RegistryCodegenExtensionProvider

supportsFactoryProvidedServiceContractAnnotations

Modifier and Type	Method	Description
default boolean	supportsFactoryProvidedServiceContractAnnotations()	Whether this extension should also process factory services whose provided service contracts contain annotations supported by this extension.

Constructor Details

OpenApiExtensionProvider

public OpenApiExtensionProvider()

Required public constructor for ServiceLoader.

Method Details

supportedAnnotations

public Set<TypeName> supportedAnnotations()

Description copied from interface: CodegenProvider

Annotations that are supported.

Specified by:

supportedAnnotations in interface CodegenProvider

Returns:

set of annotation types

See Also:

• RoundContext.annotatedTypes(io.helidon.common.types.TypeName)
• RoundContext.annotatedElements(io.helidon.common.types.TypeName)

supportsServiceContractAnnotations

public boolean supportsServiceContractAnnotations()

Description copied from interface: RegistryCodegenExtensionProvider

Whether this extension should also process services whose service contracts contain annotations supported by this extension.

Service contracts include contracts discovered for the service type. Contract annotations are discovered from nested contract metadata, including annotations on the contract type, methods, method parameters, parameter and return type arguments, and annotations matched through CodegenProvider.supportedMetaAnnotations(). Factory-provided contracts are controlled separately by RegistryCodegenExtensionProvider.supportsFactoryProvidedServiceContractAnnotations().

Matching services are passed to the extension through RoundContext.types().

Contract annotations do not make the implementation itself appear from RoundContext.annotatedTypes(io.helidon.common.types.TypeName) unless the implementation also has that annotation directly or through normal annotation inheritance.

Specified by:

supportsServiceContractAnnotations in interface RegistryCodegenExtensionProvider

Returns:

whether services with supported service-contract annotations should be processed

create

public RegistryCodegenExtension create(RegistryCodegenContext ctx)

Description copied from interface: RegistryCodegenExtensionProvider

Create a new extension based on the context.

Specified by:

create in interface RegistryCodegenExtensionProvider

Parameters:

ctx - injection code generation context

Returns:

a new extension