Package org.openapitools.codegen.config

Class CodegenConfigurator

java.lang.Object

org.openapitools.codegen.config.CodegenConfigurator

public class CodegenConfigurator
extends Object

A class which manages the contextual configuration for code generation. This includes configuring the generator, templating, and the workflow which orchestrates these. This helper also enables the deserialization of GeneratorSettings via application-specific Jackson JSON usage (see DynamicSettings.

Field Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	LOGGER

Constructor Summary

Constructors

Constructor	Description
CodegenConfigurator()

Method Summary

Modifier and Type	Method	Description
CodegenConfigurator	addAdditionalProperty(String key, Object value)
CodegenConfigurator	addAdditionalReservedWordMapping(String key, String value)
CodegenConfigurator	addGlobalProperty(String key, String value)
CodegenConfigurator	addImportMapping(String key, String value)
CodegenConfigurator	addInlineSchemaNameDefault(String key, String value)
CodegenConfigurator	addInlineSchemaNameMapping(String key, String value)
CodegenConfigurator	addInstantiationType(String key, String value)
CodegenConfigurator	addLanguageSpecificPrimitive(String value)
CodegenConfigurator	addOpenAPINormalizer(String key, String value)
CodegenConfigurator	addSchemaMapping(String key, String value)
CodegenConfigurator	addServerVariable(String key, String value)
CodegenConfigurator	addTypeMapping(String key, String value)
static CodegenConfigurator	fromFile(String configFile, com.fasterxml.jackson.databind.Module... modules)
CodegenConfigurator	setAdditionalProperties(Map<String,Object> additionalProperties)
CodegenConfigurator	setApiNameSuffix(String suffix)
CodegenConfigurator	setApiPackage(String apiPackage)
CodegenConfigurator	setArtifactId(String artifactId)
CodegenConfigurator	setArtifactVersion(String artifactVersion)
CodegenConfigurator	setAuth(String auth)
CodegenConfigurator	setEnableMinimalUpdate(boolean enableMinimalUpdate)
CodegenConfigurator	setEnablePostProcessFile(boolean enablePostProcessFile)
CodegenConfigurator	setGenerateAliasAsModel(boolean generateAliasAsModel)
CodegenConfigurator	setGeneratorName(String generatorName)	Sets the name of the target generator.
CodegenConfigurator	setGitHost(String gitHost)
CodegenConfigurator	setGitRepoId(String gitRepoId)
CodegenConfigurator	setGitUserId(String gitUserId)
CodegenConfigurator	setGlobalProperties(Map<String,String> globalProperties)
CodegenConfigurator	setGroupId(String groupId)
CodegenConfigurator	setHttpUserAgent(String httpUserAgent)
CodegenConfigurator	setIgnoreFileOverride(String ignoreFileOverride)
CodegenConfigurator	setImportMappings(Map<String,String> importMappings)
CodegenConfigurator	setInlineSchemaNameDefaults(Map<String,String> inlineSchemaNameDefaults)
CodegenConfigurator	setInlineSchemaNameMappings(Map<String,String> inlineSchemaNameMappings)
CodegenConfigurator	setInputSpec(String inputSpec)
CodegenConfigurator	setInstantiationTypes(Map<String,String> instantiationTypes)
CodegenConfigurator	setInvokerPackage(String invokerPackage)
CodegenConfigurator	setLanguageSpecificPrimitives(Set<String> languageSpecificPrimitives)
CodegenConfigurator	setLibrary(String library)
CodegenConfigurator	setLogToStderr(boolean logToStderr)
CodegenConfigurator	setModelNamePrefix(String prefix)
CodegenConfigurator	setModelNameSuffix(String suffix)
CodegenConfigurator	setModelPackage(String modelPackage)
CodegenConfigurator	setOpenAPINormalizer(Map<String,String> openapiNormalizer)
CodegenConfigurator	setOutputDir(String outputDir)
CodegenConfigurator	setPackageName(String packageName)
CodegenConfigurator	setReleaseNote(String releaseNote)
CodegenConfigurator	setRemoveOperationIdPrefix(boolean removeOperationIdPrefix)
CodegenConfigurator	setReservedWordsMappings(Map<String,String> reservedWordsMappings)
CodegenConfigurator	setSchemaMappings(Map<String,String> schemaMappings)
CodegenConfigurator	setServerVariables(Map<String,String> serverVariables)
CodegenConfigurator	setSkipOperationExample(boolean skipOperationExample)
CodegenConfigurator	setSkipOverwrite(boolean skipOverwrite)
CodegenConfigurator	setStrictSpecBehavior(boolean strictSpecBehavior)
CodegenConfigurator	setTemplateDir(String templateDir)
CodegenConfigurator	setTemplatingEngineName(String templatingEngineName)
CodegenConfigurator	setTypeMappings(Map<String,String> typeMappings)
CodegenConfigurator	setValidateSpec(boolean validateSpec)
CodegenConfigurator	setVerbose(boolean verbose)
ClientOptInput	toClientOptInput()
Context<?>	toContext()

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

public static final org.slf4j.Logger LOGGER

Constructor Detail

CodegenConfigurator

public CodegenConfigurator()

Method Detail

fromFile

public static CodegenConfigurator fromFile(String configFile,
                                           com.fasterxml.jackson.databind.Module... modules)

addServerVariable

public CodegenConfigurator addServerVariable(String key,
                                             String value)

addAdditionalProperty

public CodegenConfigurator addAdditionalProperty(String key,
                                                 Object value)

addAdditionalReservedWordMapping

public CodegenConfigurator addAdditionalReservedWordMapping(String key,
                                                            String value)

addImportMapping

public CodegenConfigurator addImportMapping(String key,
                                            String value)

addSchemaMapping

public CodegenConfigurator addSchemaMapping(String key,
                                            String value)

addInlineSchemaNameMapping

public CodegenConfigurator addInlineSchemaNameMapping(String key,
                                                      String value)

addInlineSchemaNameDefault

public CodegenConfigurator addInlineSchemaNameDefault(String key,
                                                      String value)

addOpenAPINormalizer

public CodegenConfigurator addOpenAPINormalizer(String key,
                                                String value)

addInstantiationType

public CodegenConfigurator addInstantiationType(String key,
                                                String value)

addLanguageSpecificPrimitive

public CodegenConfigurator addLanguageSpecificPrimitive(String value)

addGlobalProperty

public CodegenConfigurator addGlobalProperty(String key,
                                             String value)

addTypeMapping

public CodegenConfigurator addTypeMapping(String key,
                                          String value)

setAdditionalProperties

public CodegenConfigurator setAdditionalProperties(Map<String,Object> additionalProperties)

setServerVariables

public CodegenConfigurator setServerVariables(Map<String,String> serverVariables)

setReservedWordsMappings

public CodegenConfigurator setReservedWordsMappings(Map<String,String> reservedWordsMappings)

setApiPackage

public CodegenConfigurator setApiPackage(String apiPackage)

setArtifactId

public CodegenConfigurator setArtifactId(String artifactId)

setArtifactVersion

public CodegenConfigurator setArtifactVersion(String artifactVersion)

setAuth

public CodegenConfigurator setAuth(String auth)

setEnableMinimalUpdate

public CodegenConfigurator setEnableMinimalUpdate(boolean enableMinimalUpdate)

setEnablePostProcessFile

public CodegenConfigurator setEnablePostProcessFile(boolean enablePostProcessFile)

setGenerateAliasAsModel

public CodegenConfigurator setGenerateAliasAsModel(boolean generateAliasAsModel)

setGeneratorName

public CodegenConfigurator setGeneratorName(String generatorName)

Sets the name of the target generator.

The generator's name is used to uniquely identify the generator as a mechanism to lookup the desired implementation at runtime.

Parameters:

generatorName - The name of the generator.

Returns:

The fluent instance of CodegenConfigurator

setGitRepoId

public CodegenConfigurator setGitRepoId(String gitRepoId)

setGitHost

public CodegenConfigurator setGitHost(String gitHost)

setGitUserId

public CodegenConfigurator setGitUserId(String gitUserId)

setGroupId

public CodegenConfigurator setGroupId(String groupId)

setHttpUserAgent

public CodegenConfigurator setHttpUserAgent(String httpUserAgent)

setIgnoreFileOverride

public CodegenConfigurator setIgnoreFileOverride(String ignoreFileOverride)

setImportMappings

public CodegenConfigurator setImportMappings(Map<String,String> importMappings)

setSchemaMappings

public CodegenConfigurator setSchemaMappings(Map<String,String> schemaMappings)

setInlineSchemaNameMappings

public CodegenConfigurator setInlineSchemaNameMappings(Map<String,String> inlineSchemaNameMappings)

setInlineSchemaNameDefaults

public CodegenConfigurator setInlineSchemaNameDefaults(Map<String,String> inlineSchemaNameDefaults)

setOpenAPINormalizer

public CodegenConfigurator setOpenAPINormalizer(Map<String,String> openapiNormalizer)

setInputSpec

public CodegenConfigurator setInputSpec(String inputSpec)

setInstantiationTypes

public CodegenConfigurator setInstantiationTypes(Map<String,String> instantiationTypes)

setInvokerPackage

public CodegenConfigurator setInvokerPackage(String invokerPackage)

setLanguageSpecificPrimitives

public CodegenConfigurator setLanguageSpecificPrimitives(Set<String> languageSpecificPrimitives)

setLibrary

public CodegenConfigurator setLibrary(String library)

setLogToStderr

public CodegenConfigurator setLogToStderr(boolean logToStderr)

setApiNameSuffix

public CodegenConfigurator setApiNameSuffix(String suffix)

setModelNamePrefix

public CodegenConfigurator setModelNamePrefix(String prefix)

setModelNameSuffix

public CodegenConfigurator setModelNameSuffix(String suffix)

setModelPackage

public CodegenConfigurator setModelPackage(String modelPackage)

setOutputDir

public CodegenConfigurator setOutputDir(String outputDir)

setPackageName

public CodegenConfigurator setPackageName(String packageName)

setReleaseNote

public CodegenConfigurator setReleaseNote(String releaseNote)

setRemoveOperationIdPrefix

public CodegenConfigurator setRemoveOperationIdPrefix(boolean removeOperationIdPrefix)

setSkipOperationExample

public CodegenConfigurator setSkipOperationExample(boolean skipOperationExample)

setSkipOverwrite

public CodegenConfigurator setSkipOverwrite(boolean skipOverwrite)

setStrictSpecBehavior

public CodegenConfigurator setStrictSpecBehavior(boolean strictSpecBehavior)

setGlobalProperties

public CodegenConfigurator setGlobalProperties(Map<String,String> globalProperties)

setTemplateDir

public CodegenConfigurator setTemplateDir(String templateDir)

setTemplatingEngineName

public CodegenConfigurator setTemplatingEngineName(String templatingEngineName)

setTypeMappings

public CodegenConfigurator setTypeMappings(Map<String,String> typeMappings)

setValidateSpec

public CodegenConfigurator setValidateSpec(boolean validateSpec)

setVerbose

public CodegenConfigurator setVerbose(boolean verbose)

toContext

public Context<?> toContext()

toClientOptInput

public ClientOptInput toClientOptInput()