Package io.swagger.codegen.v3.config

Class CodegenConfigurator

java.lang.Object

io.swagger.codegen.v3.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	Description
static final 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	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()
List<HostAccessControl>	getAllowedAuthHosts()
String	getApiPackage()
String	getArtifactId()
String	getArtifactVersion()
String	getAuth()
io.swagger.v3.parser.core.models.AuthorizationValue	getAuthorizationValue()
List<CodegenArgument>	getCodegenArguments()
List<HostAccessControl>	getDeniedAuthHosts()
Map<String,Object>	getDynamicProperties()
String	getGitRepoBaseURL()
String	getGitRepoId()
String	getGitUserId()
String	getGroupId()
String	getHttpUserAgent()
String	getIgnoreFileOverride()
Map<String,String>	getImportMappings()
String	getInputSpec()
String	getInputSpecURL()
Map<String,String>	getInstantiationTypes()
String	getInvokerPackage()
String	getLang()
Set<String>	getLanguageSpecificPrimitives()
String	getLibrary()
String	getModelNamePrefix()
String	getModelNameSuffix()
String	getModelPackage()
String	getOutputDir()
String	getReleaseNote()
boolean	getRemoveOperationIdPrefix()
Map<String,String>	getReservedWordsMappings()
boolean	getSkipInlineModelMatches()
Map<String,String>	getSystemProperties()
String	getTemplateDir()
String	getTemplateVersion()
Map<String,String>	getTypeMappings()
boolean	isFlattenInlineSchem()
boolean	isResolveFully()
boolean	isSkipOverwrite()
boolean	isVerbose()
protected CodegenConfig	loadCodegenConfig()
String	loadSpecContent(String location, List<io.swagger.v3.parser.core.models.AuthorizationValue> auths)
CodegenConfigurator	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAllowedAuthHosts(List<HostAccessControl> allowedAuthHosts)
CodegenConfigurator	setApiPackage(String apiPackage)
CodegenConfigurator	setArtifactId(String artifactId)
CodegenConfigurator	setArtifactVersion(String artifactVersion)
CodegenConfigurator	setAuth(String auth)
void	setAuthorizationValue(io.swagger.v3.parser.core.models.AuthorizationValue authorizationValue)
void	setCodegenArguments(List<CodegenArgument> codegenArguments)
void	setDeniedAuthHosts(List<HostAccessControl> deniedAuthHosts)
void	setFlattenInlineSchema(boolean flattenInlineComposedSchemas)
CodegenConfigurator	setGitRepoBaseURL(String gitRepoBaseURL)
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	setInputSpecURL(String inputSpecURL)
CodegenConfigurator	setInstantiationTypes(Map<String,String> instantiationTypes)
CodegenConfigurator	setInvokerPackage(String invokerPackage)
CodegenConfigurator	setLang(String lang)
CodegenConfigurator	setLanguageSpecificPrimitives(Set<String> languageSpecificPrimitives)
CodegenConfigurator	setLibrary(String library)
CodegenConfigurator	setModelNamePrefix(String prefix)
CodegenConfigurator	setModelNameSuffix(String suffix)
CodegenConfigurator	setModelPackage(String modelPackage)
CodegenConfigurator	setOutputDir(String outputDir)
CodegenConfigurator	setReleaseNote(String releaseNote)
CodegenConfigurator	setRemoveOperationIdPrefix(boolean removeOperationIdPrefix)
CodegenConfigurator	setReservedWordsMappings(Map<String,String> reservedWordsMappings)
CodegenConfigurator	setResolveFully(boolean resolveFully)
CodegenConfigurator	setSkipInlineModelMatches(boolean skipInlineModelMatches)
CodegenConfigurator	setSkipOverwrite(boolean skipOverwrite)
CodegenConfigurator	setSystemProperties(Map<String,String> systemProperties)
CodegenConfigurator	setTemplateDir(String templateDir)
CodegenConfigurator	setTemplateVersion(String templateVersion)
CodegenConfigurator	setTypeMappings(Map<String,String> typeMappings)
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 Details

LOGGER

public static final org.slf4j.Logger LOGGER

Constructor Details

CodegenConfigurator

public CodegenConfigurator()

Method Details

getAllowedAuthHosts

public List<HostAccessControl> getAllowedAuthHosts()

setAllowedAuthHosts

public void setAllowedAuthHosts(List<HostAccessControl> allowedAuthHosts)

getDeniedAuthHosts

public List<HostAccessControl> getDeniedAuthHosts()

setDeniedAuthHosts

public void setDeniedAuthHosts(List<HostAccessControl> deniedAuthHosts)

setLang

public CodegenConfigurator setLang(String lang)

setInputSpec

public CodegenConfigurator setInputSpec(String inputSpec)

getInputSpec

public String getInputSpec()

getInputSpecURL

public String getInputSpecURL()

setInputSpecURL

public CodegenConfigurator setInputSpecURL(String inputSpecURL)

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)

getSkipInlineModelMatches

public boolean getSkipInlineModelMatches()

setSkipInlineModelMatches

public CodegenConfigurator setSkipInlineModelMatches(boolean skipInlineModelMatches)

getModelNameSuffix

public String getModelNameSuffix()

setModelNameSuffix

public CodegenConfigurator setModelNameSuffix(String suffix)

isVerbose

public boolean isVerbose()

setVerbose

public CodegenConfigurator setVerbose(boolean verbose)

isSkipOverwrite

public boolean isSkipOverwrite()

setSkipOverwrite

public CodegenConfigurator setSkipOverwrite(boolean skipOverwrite)

getLang

public String getLang()

getTemplateDir

public String getTemplateDir()

setTemplateDir

public CodegenConfigurator setTemplateDir(String templateDir)

getTemplateVersion

public String getTemplateVersion()

setTemplateVersion

public CodegenConfigurator setTemplateVersion(String templateVersion)

getAuth

public String getAuth()

setAuth

public CodegenConfigurator setAuth(String auth)

getAuthorizationValue

public io.swagger.v3.parser.core.models.AuthorizationValue getAuthorizationValue()

setAuthorizationValue

public void setAuthorizationValue(io.swagger.v3.parser.core.models.AuthorizationValue authorizationValue)

getApiPackage

public String getApiPackage()

setApiPackage

public CodegenConfigurator setApiPackage(String apiPackage)

getInvokerPackage

public String getInvokerPackage()

setInvokerPackage

public CodegenConfigurator setInvokerPackage(String invokerPackage)

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)

getGitRepoBaseURL

public String getGitRepoBaseURL()

setGitRepoBaseURL

public CodegenConfigurator setGitRepoBaseURL(String gitRepoBaseURL)

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)

isResolveFully

public boolean isResolveFully()

setResolveFully

public CodegenConfigurator setResolveFully(boolean resolveFully)

loadSpecContent

public String loadSpecContent(String location,
 List<io.swagger.v3.parser.core.models.AuthorizationValue> auths)
                       throws Exception

Throws:

Exception

toClientOptInput

public ClientOptInput toClientOptInput()

loadCodegenConfig

protected CodegenConfig loadCodegenConfig()

addDynamicProperty

public CodegenConfigurator addDynamicProperty(String name,
 Object value)

getDynamicProperties

public Map<String,Object> getDynamicProperties()

setCodegenArguments

public void setCodegenArguments(List<CodegenArgument> codegenArguments)

getCodegenArguments

public List<CodegenArgument> getCodegenArguments()

fromFile

public static CodegenConfigurator fromFile(String configFile)

isFlattenInlineSchem

public boolean isFlattenInlineSchem()

setFlattenInlineSchema

public void setFlattenInlineSchema(boolean flattenInlineComposedSchemas)