org.openapitools.codegen

Class DefaultGenerator

java.lang.Object

org.openapitools.codegen.DefaultGenerator

All Implemented Interfaces:

Generator

public class DefaultGenerator
extends Object
implements Generator

Field Summary

Fields

Modifier and Type	Field and Description
protected CodegenConfig	config
protected CodegenIgnoreProcessor	ignoreProcessor
protected org.slf4j.Logger	LOGGER
protected io.swagger.v3.oas.models.OpenAPI	openAPI
protected ClientOptInput	opts
protected TemplateProcessor	templateProcessor

Constructor Summary

Constructors

Constructor and Description
DefaultGenerator()
DefaultGenerator(Boolean dryRun)

Method Summary

Modifier and Type	Method and Description
List<File>	generate()
TemplateProcessor	getTemplateProcessor() Retrieves an instance to the configured template processor, available after user-defined options are applied via opts(ClientOptInput).
Generator	opts(ClientOptInput opts)
Map<String,List<CodegenOperation>>	processPaths(io.swagger.v3.oas.models.Paths paths)
protected File	processTemplateToFile(Map<String,Object> templateData, String templateName, String outputFilename, boolean shouldGenerate, String skippedByOption)
void	setGenerateMetadata(Boolean generateMetadata) Programmatically disable the output of .openapi-generator/VERSION, .openapi-generator-ignore, or other metadata files used by OpenAPI Generator.
void	setGeneratorPropertyDefault(String key, String value) Set generator properties otherwise pulled from system properties.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected final org.slf4j.Logger LOGGER

config

protected CodegenConfig config

opts

protected ClientOptInput opts

openAPI

protected io.swagger.v3.oas.models.OpenAPI openAPI

ignoreProcessor

protected CodegenIgnoreProcessor ignoreProcessor

templateProcessor

protected TemplateProcessor templateProcessor

Constructor Detail

DefaultGenerator

public DefaultGenerator()

DefaultGenerator

public DefaultGenerator(Boolean dryRun)

Method Detail

opts

public Generator opts(ClientOptInput opts)

Specified by:

opts in interface Generator

getTemplateProcessor

public TemplateProcessor getTemplateProcessor()

Retrieves an instance to the configured template processor, available after user-defined options are applied via opts(ClientOptInput).

Returns:

A configured TemplateProcessor, or null.

setGenerateMetadata

public void setGenerateMetadata(Boolean generateMetadata)

Programmatically disable the output of .openapi-generator/VERSION, .openapi-generator-ignore, or other metadata files used by OpenAPI Generator.

Parameters:

generateMetadata - true: enable outputs, false: disable outputs

setGeneratorPropertyDefault

public void setGeneratorPropertyDefault(String key,
                                        String value)

Set generator properties otherwise pulled from system properties. Useful for running tests in parallel without relying on System.properties.

Parameters:

key - The system property key

value - The system property value

generate

public List<File> generate()

Specified by:

generate in interface Generator

processTemplateToFile

protected File processTemplateToFile(Map<String,Object> templateData,
                                     String templateName,
                                     String outputFilename,
                                     boolean shouldGenerate,
                                     String skippedByOption)
                              throws IOException

Throws:

IOException

processPaths

public Map<String,List<CodegenOperation>> processPaths(io.swagger.v3.oas.models.Paths paths)