CodegenConfigurator (openapi-generator (core library) 4.0.0 API)

java.lang.Object
- org.openapitools.codegen.config.CodegenConfigurator

All Implemented Interfaces:

Serializable
```
public class CodegenConfigurator
extends Object
implements Serializable
```
A class that contains all codegen configuration properties a user would want to manipulate. An instance could be created by deserializing a JSON file or being populated from CLI or Maven plugin parameters. It also has a convenience method for creating a ClientOptInput class which is THE object DefaultGenerator.java needs to generate code.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static org.slf4j.Logger LOGGER

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

Constructor Summary

Constructors
Constructor and Description

CodegenConfigurator()

Constructors
Constructor and Description
`CodegenConfigurator()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`CodegenConfigurator`	`addAdditionalProperty(String key, Object value)`
`CodegenConfigurator`	`addAdditionalReservedWordMapping(String key, String value)`
`CodegenConfigurator`	`addDynamicProperty(String name, Object value)`
`CodegenConfigurator`	`addImportMapping(String key, String value)`
`CodegenConfigurator`	`addInstantiationType(String key, String value)`
`CodegenConfigurator`	`addLanguageSpecificPrimitive(String value)`
`CodegenConfigurator`	`addSystemProperty(String key, String value)`
`CodegenConfigurator`	`addTypeMapping(String key, String value)`
`static CodegenConfigurator`	`fromFile(String configFile)`
`Map<String,Object>`	`getAdditionalProperties()`
`String`	`getApiPackage()`
`String`	`getArtifactId()`
`String`	`getArtifactVersion()`
`String`	`getAuth()`
`Map<String,Object>`	`getDynamicProperties()`
`boolean`	`getEnableMinimalUpdate()`
`boolean`	`getEnablePostProcessFile()`
`String`	`getGeneratorName()`
`String`	`getGitRepoId()`
`String`	`getGitUserId()`
`String`	`getGroupId()`
`String`	`getHttpUserAgent()`
`String`	`getIgnoreFileOverride()`
`Map<String,String>`	`getImportMappings()`
`String`	`getInputSpec()`
`Map<String,String>`	`getInstantiationTypes()`
`String`	`getInvokerPackage()`
`String`	`getLang()` Deprecated. Please use `getGeneratorName()`, as generators are no longer identified only by language. We may reuse language in the future.
`Set<String>`	`getLanguageSpecificPrimitives()`
`String`	`getLibrary()`
`boolean`	`getLogToStderr()`
`String`	`getModelNamePrefix()`
`String`	`getModelNameSuffix()`
`String`	`getModelPackage()`
`String`	`getOutputDir()`
`String`	`getPackageName()`
`String`	`getReleaseNote()`
`boolean`	`getRemoveOperationIdPrefix()`
`Map<String,String>`	`getReservedWordsMappings()`
`Map<String,String>`	`getSystemProperties()`
`String`	`getTemplateDir()`
`Map<String,String>`	`getTypeMappings()`
`boolean`	`isGenerateAliasAsModel()`
`boolean`	`isSkipOverwrite()`
`boolean`	`isStrictSpecBehavior()`
`boolean`	`isValidateSpec()`
`boolean`	`isVerbose()`
`CodegenConfigurator`	`setAdditionalProperties(Map<String,Object> additionalProperties)`
`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`	`setGitRepoId(String gitRepoId)`
`CodegenConfigurator`	`setGitUserId(String gitUserId)`
`CodegenConfigurator`	`setGroupId(String groupId)`
`CodegenConfigurator`	`setHttpUserAgent(String httpUserAgent)`
`CodegenConfigurator`	`setIgnoreFileOverride(String ignoreFileOverride)`
`CodegenConfigurator`	`setImportMappings(Map<String,String> importMappings)`
`CodegenConfigurator`	`setInputSpec(String inputSpec)`
`CodegenConfigurator`	`setInstantiationTypes(Map<String,String> instantiationTypes)`
`CodegenConfigurator`	`setInvokerPackage(String invokerPackage)`
`CodegenConfigurator`	`setLang(String lang)` Deprecated. Please use `setGeneratorName(String)`, as generators are no longer identified only by language. We may reuse language in the future.
`CodegenConfigurator`	`setLanguageSpecificPrimitives(Set<String> languageSpecificPrimitives)`
`CodegenConfigurator`	`setLibrary(String library)`
`CodegenConfigurator`	`setLogToStderr(boolean logToStderrte)`
`CodegenConfigurator`	`setModelNamePrefix(String prefix)`
`CodegenConfigurator`	`setModelNameSuffix(String suffix)`
`CodegenConfigurator`	`setModelPackage(String modelPackage)`
`CodegenConfigurator`	`setOutputDir(String outputDir)`
`CodegenConfigurator`	`setPackageName(String packageName)`
`CodegenConfigurator`	`setReleaseNote(String releaseNote)`
`CodegenConfigurator`	`setRemoveOperationIdPrefix(boolean removeOperationIdPrefix)`
`CodegenConfigurator`	`setReservedWordsMappings(Map<String,String> reservedWordsMappings)`
`CodegenConfigurator`	`setSkipOverwrite(boolean skipOverwrite)`
`CodegenConfigurator`	`setStrictSpecBehavior(boolean strictSpecBehavior)`
`CodegenConfigurator`	`setSystemProperties(Map<String,String> systemProperties)`
`CodegenConfigurator`	`setTemplateDir(String templateDir)`
`CodegenConfigurator`	`setTemplatingEngineName(String templatingEngineName)`
`CodegenConfigurator`	`setTypeMappings(Map<String,String> typeMappings)`
`CodegenConfigurator`	`setValidateSpec(boolean validateSpec)`
`CodegenConfigurator`	`setVerbose(boolean verbose)`
`ClientOptInput`	`toClientOptInput()`

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

setLang
```
@Deprecated
public CodegenConfigurator setLang(String lang)
```
Deprecated. Please use setGeneratorName(String), as generators are no longer identified only by language. We may reuse language in the future.

Set the "language". This has drifted away from language-only to include framework and hyphenated generator types as well as language.
NOTE: This will eventually become language only again. It is deprecated in its current state.

Parameters:

lang - The generator name. Previously, language name only.

Returns:

The fluent instance of CodegenConfigurator

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

setInputSpec

public CodegenConfigurator setInputSpec(String inputSpec)

getInputSpec
```
public String getInputSpec()
```

getOutputDir
```
public String getOutputDir()
```

setOutputDir

public CodegenConfigurator setOutputDir(String outputDir)

getModelPackage
```
public String getModelPackage()
```

setModelPackage

public CodegenConfigurator setModelPackage(String modelPackage)

getModelNamePrefix
```
public String getModelNamePrefix()
```

setModelNamePrefix

public CodegenConfigurator setModelNamePrefix(String prefix)

getRemoveOperationIdPrefix

public boolean getRemoveOperationIdPrefix()

setRemoveOperationIdPrefix

public CodegenConfigurator setRemoveOperationIdPrefix(boolean removeOperationIdPrefix)

getEnablePostProcessFile

public boolean getEnablePostProcessFile()

setEnablePostProcessFile

public CodegenConfigurator setEnablePostProcessFile(boolean enablePostProcessFile)

getLogToStderr
```
public boolean getLogToStderr()
```

setLogToStderr

public CodegenConfigurator setLogToStderr(boolean logToStderrte)

getEnableMinimalUpdate

public boolean getEnableMinimalUpdate()

setEnableMinimalUpdate

public CodegenConfigurator setEnableMinimalUpdate(boolean enableMinimalUpdate)

isGenerateAliasAsModel

public boolean isGenerateAliasAsModel()

setGenerateAliasAsModel

public CodegenConfigurator setGenerateAliasAsModel(boolean generateAliasAsModel)

getModelNameSuffix
```
public String getModelNameSuffix()
```

setModelNameSuffix

public CodegenConfigurator setModelNameSuffix(String suffix)

isStrictSpecBehavior
```
public boolean isStrictSpecBehavior()
```

setStrictSpecBehavior

public CodegenConfigurator setStrictSpecBehavior(boolean strictSpecBehavior)

isVerbose
```
public boolean isVerbose()
```

setVerbose

public CodegenConfigurator setVerbose(boolean verbose)

isValidateSpec
```
public boolean isValidateSpec()
```

setValidateSpec

public CodegenConfigurator setValidateSpec(boolean validateSpec)

isSkipOverwrite
```
public boolean isSkipOverwrite()
```

setSkipOverwrite

public CodegenConfigurator setSkipOverwrite(boolean skipOverwrite)

getLang
```
@Deprecated
public String getLang()
```
Deprecated. Please use getGeneratorName(), as generators are no longer identified only by language. We may reuse language in the future.

Gets the "language". This has drifted away from language-only to include framework and hyphenated generator types as well as language.
NOTE: This will eventually become language only again. It is deprecated in its current state.

Returns:

A string which defines the generator.

getGeneratorName
```
public String getGeneratorName()
```

getTemplateDir
```
public String getTemplateDir()
```

setTemplateDir

public CodegenConfigurator setTemplateDir(String templateDir)

getAuth
```
public String getAuth()
```

setAuth

public CodegenConfigurator setAuth(String auth)

getApiPackage
```
public String getApiPackage()
```

setApiPackage

public CodegenConfigurator setApiPackage(String apiPackage)

getInvokerPackage
```
public String getInvokerPackage()
```

setInvokerPackage

public CodegenConfigurator setInvokerPackage(String invokerPackage)

getPackageName
```
public String getPackageName()
```

setPackageName

public CodegenConfigurator setPackageName(String packageName)

getGroupId
```
public String getGroupId()
```

setGroupId

public CodegenConfigurator setGroupId(String groupId)

getArtifactId
```
public String getArtifactId()
```

setArtifactId

public CodegenConfigurator setArtifactId(String artifactId)

getArtifactVersion
```
public String getArtifactVersion()
```

setArtifactVersion

public CodegenConfigurator setArtifactVersion(String artifactVersion)

getSystemProperties

public Map<String,String> getSystemProperties()

setSystemProperties

public CodegenConfigurator setSystemProperties(Map<String,String> systemProperties)

addSystemProperty

public CodegenConfigurator addSystemProperty(String key,
                                             String value)

getInstantiationTypes

public Map<String,String> getInstantiationTypes()

setInstantiationTypes

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

addInstantiationType

public CodegenConfigurator addInstantiationType(String key,
                                                String value)

getTypeMappings

public Map<String,String> getTypeMappings()

setTypeMappings

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

addTypeMapping

public CodegenConfigurator addTypeMapping(String key,
                                          String value)

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperties

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

addAdditionalProperty

public CodegenConfigurator addAdditionalProperty(String key,
                                                 Object value)

getImportMappings

public Map<String,String> getImportMappings()

setImportMappings

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

addImportMapping

public CodegenConfigurator addImportMapping(String key,
                                            String value)

getLanguageSpecificPrimitives

public Set<String> getLanguageSpecificPrimitives()

setLanguageSpecificPrimitives

public CodegenConfigurator setLanguageSpecificPrimitives(Set<String> languageSpecificPrimitives)

addLanguageSpecificPrimitive

public CodegenConfigurator addLanguageSpecificPrimitive(String value)

getLibrary
```
public String getLibrary()
```

setLibrary

public CodegenConfigurator setLibrary(String library)

getGitUserId
```
public String getGitUserId()
```

setGitUserId

public CodegenConfigurator setGitUserId(String gitUserId)

getGitRepoId
```
public String getGitRepoId()
```

setGitRepoId

public CodegenConfigurator setGitRepoId(String gitRepoId)

getReleaseNote
```
public String getReleaseNote()
```

setReleaseNote

public CodegenConfigurator setReleaseNote(String releaseNote)

getHttpUserAgent
```
public String getHttpUserAgent()
```

setHttpUserAgent

public CodegenConfigurator setHttpUserAgent(String httpUserAgent)

getReservedWordsMappings

public Map<String,String> getReservedWordsMappings()

setReservedWordsMappings

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

addAdditionalReservedWordMapping

public CodegenConfigurator addAdditionalReservedWordMapping(String key,
                                                            String value)

getIgnoreFileOverride
```
public String getIgnoreFileOverride()
```

setIgnoreFileOverride

public CodegenConfigurator setIgnoreFileOverride(String ignoreFileOverride)

toClientOptInput

public ClientOptInput toClientOptInput()

addDynamicProperty

public CodegenConfigurator addDynamicProperty(String name,
                                              Object value)

getDynamicProperties

public Map<String,Object> getDynamicProperties()

fromFile

public static CodegenConfigurator fromFile(String configFile)

setTemplatingEngineName

public CodegenConfigurator setTemplatingEngineName(String templatingEngineName)

Class CodegenConfigurator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOGGER

Constructor Detail

CodegenConfigurator

Method Detail

setLang

setGeneratorName

setInputSpec

getInputSpec

getOutputDir

setOutputDir

getModelPackage

setModelPackage

getModelNamePrefix

setModelNamePrefix

getRemoveOperationIdPrefix

setRemoveOperationIdPrefix

getEnablePostProcessFile

setEnablePostProcessFile

getLogToStderr

setLogToStderr

getEnableMinimalUpdate

setEnableMinimalUpdate

isGenerateAliasAsModel

setGenerateAliasAsModel

getModelNameSuffix

setModelNameSuffix

isStrictSpecBehavior

setStrictSpecBehavior

isVerbose

setVerbose

isValidateSpec

setValidateSpec

isSkipOverwrite

setSkipOverwrite

getLang

getGeneratorName

getTemplateDir

setTemplateDir

getAuth

setAuth

getApiPackage

setApiPackage

getInvokerPackage

setInvokerPackage

getPackageName

setPackageName

getGroupId

setGroupId

getArtifactId

setArtifactId

getArtifactVersion

setArtifactVersion

getSystemProperties

setSystemProperties

addSystemProperty

getInstantiationTypes

setInstantiationTypes

addInstantiationType

getTypeMappings

setTypeMappings

addTypeMapping

getAdditionalProperties

setAdditionalProperties

addAdditionalProperty

getImportMappings

setImportMappings

addImportMapping

getLanguageSpecificPrimitives

setLanguageSpecificPrimitives

addLanguageSpecificPrimitive

getLibrary

setLibrary

getGitUserId

setGitUserId