Package io.micronaut.openapi.generator

Interface MicronautCodeGeneratorBuilder

public interface MicronautCodeGeneratorBuilder

A code generator builder.

Method Summary

Modifier and Type	Method	Description
MicronautCodeGeneratorEntryPoint	build()	Returns a configured code generator.
default MicronautCodeGeneratorBuilder	forClient()	Configures the code generator to create a client.
MicronautCodeGeneratorBuilder	forClient(Consumer<? super JavaMicronautClientOptionsBuilder> clientOptionsSpec)	Configures the code generator to create a client.
<B extends GeneratorOptionsBuilder, G extends MicronautCodeGenerator<B>> MicronautCodeGeneratorBuilder	forCodeGenerator(G generator, Consumer<? super B> configuration)	Sets the code generator which should be used (e.g server or client).
default MicronautCodeGeneratorBuilder	forServer()	Configures the code generator to create a server.
MicronautCodeGeneratorBuilder	forServer(Consumer<? super JavaMicronautServerOptionsBuilder> serverOptionsSpec)	Configures the code generator to create a server.
MicronautCodeGeneratorBuilder	withDefinitionFile(URI definitionFile)	Sets the URI to the OpenAPI definition file.
MicronautCodeGeneratorBuilder	withOptions(Consumer<? super MicronautCodeGeneratorOptionsBuilder> optionsConfigurer)	Configures the code generation options.
MicronautCodeGeneratorBuilder	withOutputDirectory(File outputDirectory)	Sets the directory where to output the generated sources.
MicronautCodeGeneratorBuilder	withOutputs(MicronautCodeGeneratorEntryPoint.OutputKind... elements)	Sets which output files should be generated.

Method Details

forCodeGenerator

<B extends GeneratorOptionsBuilder,
G extends MicronautCodeGenerator<B>>
MicronautCodeGeneratorBuilder forCodeGenerator(G generator,
 Consumer<? super B> configuration)

Sets the code generator which should be used (e.g server or client).

Type Parameters:

B - the type of the builder used to configure the options specific to this generator

G - the type of the generator

Parameters:

generator - the generator

configuration - the configuration block for this generator

Returns:

this builder

forClient

default MicronautCodeGeneratorBuilder forClient()

Configures the code generator to create a client.

Returns:

this builder

forClient

MicronautCodeGeneratorBuilder forClient(Consumer<? super JavaMicronautClientOptionsBuilder> clientOptionsSpec)

Configures the code generator to create a client.

Parameters:

clientOptionsSpec - the client options

Returns:

this builder

forServer

default MicronautCodeGeneratorBuilder forServer()

Configures the code generator to create a server.

Returns:

this builder

forServer

MicronautCodeGeneratorBuilder forServer(Consumer<? super JavaMicronautServerOptionsBuilder> serverOptionsSpec)

Configures the code generator to create a server.

Parameters:

serverOptionsSpec - the server options

Returns:

this builder

withDefinitionFile

MicronautCodeGeneratorBuilder withDefinitionFile(URI definitionFile)

Sets the URI to the OpenAPI definition file. It is recommended to use a local path instead of using a remote URI.

Parameters:

definitionFile - the definition file

Returns:

this builder

withOutputDirectory

MicronautCodeGeneratorBuilder withOutputDirectory(File outputDirectory)

Sets the directory where to output the generated sources.

Parameters:

outputDirectory - the generated sources output directory

Returns:

this builder

withOutputs

MicronautCodeGeneratorBuilder withOutputs(MicronautCodeGeneratorEntryPoint.OutputKind... elements)

Sets which output files should be generated.

Parameters:

elements - the different elements to generate

Returns:

this builder

withOptions

MicronautCodeGeneratorBuilder withOptions(Consumer<? super MicronautCodeGeneratorOptionsBuilder> optionsConfigurer)

Configures the code generation options.

Parameters:

optionsConfigurer - the configuration

Returns:

this builder

build

MicronautCodeGeneratorEntryPoint build()

Returns a configured code generator.

Returns:

the configured code generator