Package org.apache.juneau.rest.swagger

Class SwaggerProvider.Builder

java.lang.Object

org.apache.juneau.rest.swagger.SwaggerProvider.Builder

Enclosing interface:

SwaggerProvider

public static class SwaggerProvider.Builder
extends Object

Builder class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(BeanStore beanStore)	Constructor.

Method Summary

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

Creates a new SwaggerProvider object from this builder.

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

Returns:

A new SwaggerProvider object.

fileFinder

public Optional<FileFinder> fileFinder()

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

Returns:

The file finder.

fileFinder

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

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

Parameters:

value - The new value for this setting.

Returns:

This object.

impl

public SwaggerProvider.Builder impl(SwaggerProvider value)

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

Parameters:

value - The new value for this setting.

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 SwaggerProvider.Builder jsonSchemaGenerator(Supplier<JsonSchemaGenerator> value)

Specifies the JSON-schema generator to use for the SwaggerProvider 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 SwaggerProvider.Builder messages(Supplier<Messages> value)

Specifies the messages to use for the SwaggerProvider object.

Parameters:

value - The new value for this setting.

Returns:

This object.

type

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

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

Parameters:

value - The new value for this setting.

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 SwaggerProvider.Builder varResolver(Supplier<VarResolver> value)

Specifies the variable resolver to use for the SwaggerProvider object.

Parameters:

value - The new value for this setting.

Returns:

This object.

getDefaultType

protected Class<? extends SwaggerProvider> getDefaultType()

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

Returns:

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