Package org.apache.juneau.rest.server.openapi

Class OpenApiProvider.Builder

java.lang.Object

org.apache.juneau.rest.server.openapi.OpenApiProvider.Builder

Enclosing interface:

OpenApiProvider

public static class OpenApiProvider.Builder
extends Object

Builder class for OpenApiProvider instances.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(BeanStore beanStore)	Constructor.

Method Summary

Modifier and Type	Method	Description
OpenApiProvider	build()	Creates a new OpenApiProvider object from this builder.
Optional<FileFinder>	fileFinder()	Returns the file finder in this builder if it's been specified.
OpenApiProvider.Builder	fileFinder(Supplier<FileFinder> value)	Specifies the file-finder to use for the OpenApiProvider object.
protected Class<? extends OpenApiProvider>	getDefaultType()	Specifies the default implementation class if not specified via type(Class).
OpenApiProvider.Builder	impl(OpenApiProvider value)	Specifies an already-instantiated bean for the build() method to return.
Optional<JsonSchemaGenerator>	jsonSchemaGenerator()	Returns the JSON schema generator in this builder if it's been specified.
OpenApiProvider.Builder	jsonSchemaGenerator(Supplier<JsonSchemaGenerator> value)	Specifies the JSON-schema generator to use for the OpenApiProvider object.
Optional<Messages>	messages()	Returns the messages in this builder if it's been specified.
OpenApiProvider.Builder	messages(Supplier<Messages> value)	Specifies the messages to use for the OpenApiProvider object.
OpenApiProvider.Builder	type(Class<? extends OpenApiProvider> value)	Specifies a subclass of OpenApiProvider to create when the build() method is called.
Optional<VarResolver>	varResolver()	Returns the var resolver in this builder if it's been specified.
OpenApiProvider.Builder	varResolver(Supplier<VarResolver> value)	Specifies the variable resolver to use for the OpenApiProvider object.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder(BeanStore beanStore)

Constructor.

Parameters:

beanStore - The bean store to use for creating beans.

Method Details

build

public OpenApiProvider build()

Creates a new OpenApiProvider object from this builder.

Instantiates an instance of the implementation class or else BasicOpenApiProvider if implementation class was not specified.

Returns:

A new OpenApiProvider object.

fileFinder

public Optional<FileFinder> fileFinder()

Returns the file finder in this builder if it's been specified.

Returns:

The file finder.

fileFinder

public OpenApiProvider.Builder fileFinder(Supplier<FileFinder> value)

Specifies the file-finder to use for the OpenApiProvider object.

Parameters:

value - The new value for this setting.

Returns:

This object.

impl

public OpenApiProvider.Builder impl(OpenApiProvider value)

Specifies an already-instantiated bean for the build() method to return.

Parameters:

value - The new value for this setting.
Can be null (the build() method instantiates the type instead).

Returns:

This object.

jsonSchemaGenerator

public Optional<JsonSchemaGenerator> jsonSchemaGenerator()

Returns the JSON schema generator in this builder if it's been specified.

Returns:

The JSON schema generator.

jsonSchemaGenerator

public OpenApiProvider.Builder jsonSchemaGenerator(Supplier<JsonSchemaGenerator> value)

Specifies the JSON-schema generator to use for the OpenApiProvider object.

Parameters:

value - The new value for this setting.

Returns:

This object.

messages

public Optional<Messages> messages()

Returns the messages in this builder if it's been specified.

Returns:

The messages.

messages

public OpenApiProvider.Builder messages(Supplier<Messages> value)

Specifies the messages to use for the OpenApiProvider object.

Parameters:

value - The new value for this setting.

Returns:

This object.

type

public OpenApiProvider.Builder type(Class<? extends OpenApiProvider> value)

Specifies a subclass of OpenApiProvider to create when the build() method is called.

Parameters:

value - The new value for this setting.
Can be null (defaults to BasicOpenApiProvider).

Returns:

This object.

varResolver

public Optional<VarResolver> varResolver()

Returns the var resolver in this builder if it's been specified.

Returns:

The var resolver.

varResolver

public OpenApiProvider.Builder varResolver(Supplier<VarResolver> value)

Specifies the variable resolver to use for the OpenApiProvider object.

Parameters:

value - The new value for this setting.

Returns:

This object.

getDefaultType

protected Class<? extends OpenApiProvider> getDefaultType()

Specifies the default implementation class if not specified via type(Class).

Returns:

The default implementation class if not specified via type(Class).