org.openapitools.codegen

Class DefaultGenerator

java.lang.Object

org.openapitools.codegen.AbstractGenerator

org.openapitools.codegen.DefaultGenerator

All Implemented Interfaces:

TemplatingGenerator, Generator

public class DefaultGenerator
extends AbstractGenerator
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 TemplatingEngineAdapter	templatingEngine

Fields inherited from class org.openapitools.codegen.AbstractGenerator

dryRun, dryRunStatusMap

Constructor Summary

Constructors

Constructor and Description
DefaultGenerator()
DefaultGenerator(Boolean dryRun)

Method Summary

Modifier and Type	Method and Description
List<File>	generate()
boolean	getEnableMinimalUpdate() Is the minimal-file-update option enabled?
String	getFullTemplateContents(String templateName)
Path	getFullTemplatePath(String name) Returns the path of a template, allowing access to the template where consuming literal contents aren't desirable or possible.
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)
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.
protected File	writeInputStreamToFile(String filename, InputStream in, String templateFile)
File	writeToFile(String filename, byte[] contents) Write bytes to a file

Methods inherited from class org.openapitools.codegen.AbstractGenerator

embeddedTemplateExists, getCPResourcePath, getFullTemplateFile, getTemplateReader, readResourceContents, readTemplate, writeToFile

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

templatingEngine

protected TemplatingEngineAdapter templatingEngine

Constructor Detail

DefaultGenerator

public DefaultGenerator()

DefaultGenerator

public DefaultGenerator(Boolean dryRun)

Method Detail

getEnableMinimalUpdate

public boolean getEnableMinimalUpdate()

Description copied from class: AbstractGenerator

Is the minimal-file-update option enabled?

Specified by:

getEnableMinimalUpdate in class AbstractGenerator

Returns:

Option value

opts

public Generator opts(ClientOptInput opts)

Specified by:

opts in interface Generator

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

getFullTemplateContents

public String getFullTemplateContents(String templateName)

Specified by:

getFullTemplateContents in interface TemplatingGenerator

getFullTemplatePath

public Path getFullTemplatePath(String name)

Returns the path of a template, allowing access to the template where consuming literal contents aren't desirable or possible.

Specified by:

getFullTemplatePath in interface TemplatingGenerator

Parameters:

name - the template name (e.g. model.mustache)

Returns:

The Path to the template

processTemplateToFile

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

Throws:

IOException

processPaths

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

writeInputStreamToFile

protected File writeInputStreamToFile(String filename,
                                      InputStream in,
                                      String templateFile)
                               throws IOException

Throws:

IOException

writeToFile

public File writeToFile(String filename,
                        byte[] contents)
                 throws IOException

Write bytes to a file

Overrides:

writeToFile in class AbstractGenerator

Parameters:

filename - The name of file to write

contents - The contents bytes. Typically this is a UTF-8 formatted string.

Returns:

File representing the written file.

Throws:

IOException - If file cannot be written.