Class OpenApiFeatureConfig.Builder

java.lang.Object

io.helidon.openapi.OpenApiFeatureConfig.BuilderBase<OpenApiFeatureConfig.Builder, OpenApiFeatureConfig>

io.helidon.openapi.OpenApiFeatureConfig.Builder

All Implemented Interfaces:

Prototype.Builder<OpenApiFeatureConfig.Builder, OpenApiFeatureConfig>, Builder<OpenApiFeatureConfig.Builder, OpenApiFeature>, ConfigBuilderSupport.ConfiguredBuilder<OpenApiFeatureConfig.Builder, OpenApiFeatureConfig>, Supplier<OpenApiFeature>

Enclosing interface:

OpenApiFeatureConfig

public static class OpenApiFeatureConfig.Builder
extends OpenApiFeatureConfig.BuilderBase<OpenApiFeatureConfig.Builder, OpenApiFeatureConfig>
implements Builder<OpenApiFeatureConfig.Builder, OpenApiFeature>

Fluent API builder for OpenApiFeature.

Nested Class Summary

Nested classes/interfaces inherited from class OpenApiFeatureConfig.BuilderBase

OpenApiFeatureConfig.BuilderBase.OpenApiFeatureConfigImpl

Modifier and Type	Class	Description
protected static class	OpenApiFeatureConfig.BuilderBase.OpenApiFeatureConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Method Summary

Modifier and Type	Method	Description
OpenApiFeature	build()	Create an instance from this builder.
OpenApiFeatureConfig	buildPrototype()	Create an instance of the prototype.

Methods inherited from class OpenApiFeatureConfig.BuilderBase

addGeneratedDocumentSource, addGeneratedDocumentSources, addGeneratedOperationIds, addRoles, addService, addServices, addSocket, addSockets, clearGeneratedDocumentSources, clearManager, clearOpenApiVersion, clearRoles, clearServices, clearSockets, clearStaticFile, config, config, from, from, generatedDocumentSources, generatedDocumentSources, generatedMode, generatedMode, generatedOperationIds, generatedOperationIds, generatedResolveConfigExpressions, generatedResolveConfigExpressions, isEnabled, isEnabled, manager, manager, managerDiscoverServices, managerDiscoverServices, name, name, openApiVersion, openApiVersion, openApiVersionDiscoverServices, openApiVersionDiscoverServices, permitAll, permitAll, preBuildPrototype, roles, roles, serviceRegistry, serviceRegistry, services, services, servicesDiscoverServices, servicesDiscoverServices, sockets, sockets, staticFile, staticFile, toString, validatePrototype, webContext, webContext, weight, weight

Modifier and Type	Method	Description
OpenApiFeatureConfig.Builder	addGeneratedDocumentSource(String generatedDocumentSource)	Named generated document metadata sources to use, in the order configured.
OpenApiFeatureConfig.Builder	addGeneratedDocumentSources(List<String> generatedDocumentSources)	Named generated document metadata sources to use, in the order configured.
OpenApiFeatureConfig.Builder	addGeneratedOperationIds(Map<String,String> generatedOperationIds)	Operation ids to use for generated Java methods.
OpenApiFeatureConfig.Builder	addRoles(List<String> roles)	Hints for role names the user is expected to be in.
OpenApiFeatureConfig.Builder	addService(OpenApiService service)	OpenAPI services.
OpenApiFeatureConfig.Builder	addServices(List<? extends OpenApiService> services)	OpenAPI services.
OpenApiFeatureConfig.Builder	addSocket(String socket)	List of sockets to register this feature on.
OpenApiFeatureConfig.Builder	addSockets(Set<String> sockets)	List of sockets to register this feature on.
OpenApiFeatureConfig.Builder	clearGeneratedDocumentSources()	Clear all generatedDocumentSources.
OpenApiFeatureConfig.Builder	clearManager()	Clear existing value of manager.
OpenApiFeatureConfig.Builder	clearOpenApiVersion()	Clear existing value of openApiVersion.
OpenApiFeatureConfig.Builder	clearRoles()	Clear all roles.
OpenApiFeatureConfig.Builder	clearServices()	Clear all services.
OpenApiFeatureConfig.Builder	clearSockets()	Clear all sockets.
OpenApiFeatureConfig.Builder	clearStaticFile()	Clear existing value of staticFile.
protected Optional<Config>	config()	Configuration used to configure this instance.
OpenApiFeatureConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
OpenApiFeatureConfig.Builder	from(OpenApiFeatureConfig prototype)	Update this builder from an existing prototype instance.
OpenApiFeatureConfig.Builder	from(OpenApiFeatureConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
List<String>	generatedDocumentSources()	Named generated document metadata sources to use, in the order configured.
OpenApiFeatureConfig.Builder	generatedDocumentSources(List<String> generatedDocumentSources)	Named generated document metadata sources to use, in the order configured.
OpenApiGeneratedMode	generatedMode()	Generated document source handling mode.
OpenApiFeatureConfig.Builder	generatedMode(OpenApiGeneratedMode generatedMode)	Generated document source handling mode.
Map<String,String>	generatedOperationIds()	Operation ids to use for generated Java methods.
OpenApiFeatureConfig.Builder	generatedOperationIds(Map<String,String> generatedOperationIds)	Operation ids to use for generated Java methods.
boolean	generatedResolveConfigExpressions()	Whether generated document sources resolve annotation string values as Helidon config expressions at runtime.
OpenApiFeatureConfig.Builder	generatedResolveConfigExpressions(boolean generatedResolveConfigExpressions)	Whether generated document sources resolve annotation string values as Helidon config expressions at runtime.
boolean	isEnabled()	Sets whether the feature should be enabled.
OpenApiFeatureConfig.Builder	isEnabled(boolean isEnabled)	Sets whether the feature should be enabled.
Optional<OpenApiManager<?>>	manager()	OpenAPI manager.
OpenApiFeatureConfig.Builder	manager(OpenApiManager<?> manager)	OpenAPI manager.
boolean	managerDiscoverServices()	Service discovery flag for OpenApiFeatureConfig.BuilderBase.manager().
OpenApiFeatureConfig.Builder	managerDiscoverServices(boolean managerDiscoverServices)	Service discovery flag for OpenApiFeatureConfig.BuilderBase.manager().
String	name()	Name of this instance.
OpenApiFeatureConfig.Builder	name(String name)	Name of this instance.
Optional<OpenApiVersion>	openApiVersion()	OpenAPI version implementation for rendered generated or merged documents.
OpenApiFeatureConfig.Builder	openApiVersion(OpenApiVersion openApiVersion)	OpenAPI version implementation for rendered generated or merged documents.
boolean	openApiVersionDiscoverServices()	Service discovery flag for OpenApiFeatureConfig.BuilderBase.openApiVersion().
OpenApiFeatureConfig.Builder	openApiVersionDiscoverServices(boolean openApiVersionDiscoverServices)	Service discovery flag for OpenApiFeatureConfig.BuilderBase.openApiVersion().
boolean	permitAll()	Whether to allow anybody to access the endpoint.
OpenApiFeatureConfig.Builder	permitAll(boolean permitAll)	Whether to allow anybody to access the endpoint.
protected void	preBuildPrototype()	Handles providers and decorators.
List<String>	roles()	Hints for role names the user is expected to be in.
OpenApiFeatureConfig.Builder	roles(List<String> roles)	Hints for role names the user is expected to be in.
Optional<ServiceRegistry>	serviceRegistry()	Service registry used to discover providers and services.
OpenApiFeatureConfig.Builder	serviceRegistry(ServiceRegistry serviceRegistry)	Service registry used to discover providers and services.
List<OpenApiService>	services()	OpenAPI services.
OpenApiFeatureConfig.Builder	services(List<? extends OpenApiService> services)	OpenAPI services.
boolean	servicesDiscoverServices()	Service discovery flag for OpenApiFeatureConfig.BuilderBase.services().
OpenApiFeatureConfig.Builder	servicesDiscoverServices(boolean servicesDiscoverServices)	Service discovery flag for OpenApiFeatureConfig.BuilderBase.services().
Set<String>	sockets()	List of sockets to register this feature on.
OpenApiFeatureConfig.Builder	sockets(Set<String> sockets)	List of sockets to register this feature on.
Optional<String>	staticFile()	Path of the static OpenAPI document file.
OpenApiFeatureConfig.Builder	staticFile(String staticFile)	Path of the static OpenAPI document file.
String	toString()
protected void	validatePrototype()	Validates required properties.
String	webContext()	Web context path for the OpenAPI endpoint.
OpenApiFeatureConfig.Builder	webContext(String webContext)	Web context path for the OpenAPI endpoint.
double	weight()	Weight of the OpenAPI feature.
OpenApiFeatureConfig.Builder	weight(double weight)	Weight of the OpenAPI feature.

Methods inherited from class Object

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

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default OpenApiFeature	get()
default OpenApiFeatureConfig.Builder	identity()	Instance of this builder as the correct type.
default OpenApiFeatureConfig.Builder	update(Consumer<OpenApiFeatureConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

Modifier and Type	Method	Description
default OpenApiFeatureConfig.Builder	self()	Instance of this builder as the correct type.

Method Details

buildPrototype

public OpenApiFeatureConfig buildPrototype()

Create an instance of the prototype. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

buildPrototype in interface Prototype.Builder<OpenApiFeatureConfig.Builder, OpenApiFeatureConfig>

Returns:

an instance of the setup object created from this builder

build

public OpenApiFeature build()

Create an instance from this builder. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

build in interface Builder<OpenApiFeatureConfig.Builder, OpenApiFeature>

Returns:

instance of the built type