Package io.swagger.codegen.v3.generators.kotlin

Class AbstractKotlinCodegen

java.lang.Object

io.swagger.codegen.v3.generators.DefaultCodegenConfig

io.swagger.codegen.v3.generators.kotlin.AbstractKotlinCodegen

All Implemented Interfaces:

io.swagger.codegen.v3.CodegenConfig

Direct Known Subclasses:

KotlinClientCodegen, KotlinServerCodegen

public abstract class AbstractKotlinCodegen
extends DefaultCodegenConfig

Field Summary

Fields

Modifier and Type	Field	Description
protected String	apiDocPath
protected String	artifactId
protected String	artifactVersion
protected String	groupId
protected String	modelDocPath
protected String	packageName
protected String	sourceFolder

Fields inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, configFiles, customTemplateDir, DEFAULT_CONTENT_TYPE, DEFAULT_TEMPLATE_DIR, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoBaseURL, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, ignoreImportMapping, importMapping, inputSpec, inputURL, instantiationTypes, IS_NULLABLE_FALSE, IS_NULLABLE_TRUE, languageArguments, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, outputFolder, releaseNote, removeOperationIdPrefix, REQUEST_BODY_NAME, reservedWords, reservedWordsMappings, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, templateDir, templateEngine, templateVersion, testPackage, typeAliases, typeMapping, unflattenedOpenAPI, useOas2, vendorExtensions

Constructor Summary

Constructors

Constructor	Description
AbstractKotlinCodegen()

Method Summary

Modifier and Type	Method	Description
void	addHandlebarHelpers(com.github.jknack.handlebars.Handlebars handlebars)
protected void	addOption(String key, String description)
protected void	addOption(String key, String description, String defaultValue)
protected void	addSwitch(String key, String description, Boolean defaultValue)
String	apiDocFileFolder()
String	apiFileFolder()
String	escapeQuotationMark(String input)	Escape single and/or double quote to avoid code injection
String	escapeReservedWord(String name)	Return the escaped name of the reserved word
String	escapeUnsafeCharacters(String input)	override with any special text escaping logic to handle unsafe characters so as to avoid code injection
String	getAlias(String name)	Determine the type alias for the given type if it exists.
String	getArgumentsLocation()
String	getSchemaType(io.swagger.v3.oas.models.media.Schema schema)	returns the swagger type for the property
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema propertySchema)	Output the type declaration of the property
boolean	isPrimivite(String datatype)
protected boolean	isReservedWord(String word)
String	modelDocFileFolder()
String	modelFileFolder()
protected boolean	needToImport(String type)	Check the type to see if it needs import the library/module/package
Map<String,Object>	postProcessModels(Map<String,Object> objs)
void	processOpts()
void	setArtifactId(String artifactId)
void	setArtifactVersion(String artifactVersion)
void	setGroupId(String groupId)
void	setPackageName(String packageName)
void	setSourceFolder(String sourceFolder)
String	toEnumName(io.swagger.codegen.v3.CodegenProperty property)	Return the Enum name (e.g.
String	toEnumValue(String value, String datatype)	Return the enum value in the language specified format e.g.
String	toEnumVarName(String value, String datatype)	Return the sanitized variable name for enum
String	toInstantiationType(io.swagger.v3.oas.models.media.Schema p)	Return the instantiation type of the property, especially for map and array
String	toModelImport(String name)	Return the fully-qualified "Model" name for import
String	toModelName(String name)	Output the proper model name (capitalized).
String	toVarName(String name)	Return the variable name by removing invalid characters and proper escaping if it's a reserved word.
protected void	updateCodegenModelEnumVars(io.swagger.codegen.v3.CodegenModel codegenModel)	update codegen property enum with proper naming convention and handling of numbers, special characters

Methods inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig

addAdditionPropertiesToCodeGenModel, addCodegenContentParameters, addConsumesInfo, addImport, additionalProperties, addOperationImports, addOperationToGroup, addParameters, addParentContainer, addProducesInfo, addProperties, addRegularExpressionDelimiter, addVars, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, configFiles, configureDataForTestTemplate, configuresParameterForMediaType, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, copyFirstAllOfProperties, customTemplateDir, dashize, defaultIgnoreImportMappingOption, defaultIncludes, detectParent, embeddedTemplateDir, ensureUniqueParameters, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fixUpParentAndInterfaces, fromModel, fromModel, fromOperation, fromOperation, fromParameter, fromProperty, fromRequestBody, fromResponse, fromSecurity, generateExamplePath, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getDefaultTemplateDir, getGitRepoBaseURL, getGitRepoId, getGitUserId, getHideGenerationTimestamp, getHttpUserAgent, getIgnoreFilePathOverride, getIgnoreImportMapping, getInnerEnumAllowableValues, getInputSpec, getInputURL, getLanguageArguments, getLibrary, getOpenAPI, getOptionValue, getOrGenerateOperationId, getOutputDir, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSchemaFromBody, getSchemaFromParameter, getSchemaFromResponse, getSchemaHandler, getSortParamsByRequiredFlag, getSymbolName, getTemplateDir, getTemplateEngine, getTemplateVersion, getterAndSetterCapitalize, getTypeDeclaration, hasSchemaProperties, hasTrueAdditionalProperties, importMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isFileTypeSchema, isObjectSchema, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needsUnflattenedSpec, outputFolder, postProcessAllCodegenModels, postProcessAllModels, postProcessModelProperty, postProcessModelsEnum, postProcessOperations, postProcessOperationsWithModels, postProcessParameter, postProcessSupportingFileData, preprocessOpenAPI, processCompiler, processMapSchema, processModelEnums, processOpenAPI, processPropertySchemaContainerTypes, processPropertySchemaTypes, readLanguageArguments, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoBaseURL, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setIgnoreImportMapping, setInputSpec, setInputURL, setLanguageArguments, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setParameterJson, setParameterNullable, setReleaseNote, setRemoveOperationIdPrefix, setReservedWords, setReservedWordsLowerCase, setSchemaProperties, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, setTemplateEngine, setTemplateVersion, setUnflattenedOpenAPI, setUseOas2, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toExampleValue, toGetter, toModelDocFilename, toModelFilename, toModelTestFilename, toOperationId, toParamName, toRegularExpression, toSetter, typeMapping, underscore, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writeOptional, writePropertyBack

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.swagger.codegen.v3.CodegenConfig

checkAliasModel, getCodeName, getHelp, getName, getPriority, getTag, isPrivileged

Field Details

artifactId

protected String artifactId

artifactVersion

protected String artifactVersion

groupId

protected String groupId

packageName

protected String packageName

sourceFolder

protected String sourceFolder

apiDocPath

protected String apiDocPath

modelDocPath

protected String modelDocPath

Constructor Details

AbstractKotlinCodegen

public AbstractKotlinCodegen()

Method Details

addOption

protected void addOption(String key,
 String description)

Overrides:

addOption in class DefaultCodegenConfig

addOption

protected void addOption(String key,
 String description,
 String defaultValue)

Overrides:

addOption in class DefaultCodegenConfig

addSwitch

protected void addSwitch(String key,
 String description,
 Boolean defaultValue)

Overrides:

addSwitch in class DefaultCodegenConfig

getArgumentsLocation

public String getArgumentsLocation()

Overrides:

getArgumentsLocation in class DefaultCodegenConfig

apiDocFileFolder

public String apiDocFileFolder()

Specified by:

apiDocFileFolder in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

apiDocFileFolder in class DefaultCodegenConfig

apiFileFolder

public String apiFileFolder()

Specified by:

apiFileFolder in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

apiFileFolder in class DefaultCodegenConfig

escapeQuotationMark

public String escapeQuotationMark(String input)

Description copied from class: DefaultCodegenConfig

Escape single and/or double quote to avoid code injection

Specified by:

escapeQuotationMark in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

escapeQuotationMark in class DefaultCodegenConfig

Parameters:

input - String to be cleaned up

Returns:

string with quotation mark removed or escaped

escapeReservedWord

public String escapeReservedWord(String name)

Description copied from class: DefaultCodegenConfig

Return the escaped name of the reserved word

Specified by:

escapeReservedWord in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

escapeReservedWord in class DefaultCodegenConfig

Parameters:

name - the name to be escaped

Returns:

the escaped reserved word throws Runtime exception as reserved word is not allowed (default behavior)

escapeUnsafeCharacters

public String escapeUnsafeCharacters(String input)

Description copied from class: DefaultCodegenConfig

override with any special text escaping logic to handle unsafe characters so as to avoid code injection

Specified by:

escapeUnsafeCharacters in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

escapeUnsafeCharacters in class DefaultCodegenConfig

Parameters:

input - String to be cleaned up

Returns:

string with unsafe characters removed or escaped

updateCodegenModelEnumVars

protected void updateCodegenModelEnumVars(io.swagger.codegen.v3.CodegenModel codegenModel)

Description copied from class: DefaultCodegenConfig

update codegen property enum with proper naming convention and handling of numbers, special characters

Overrides:

updateCodegenModelEnumVars in class DefaultCodegenConfig

getTypeDeclaration

public String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema propertySchema)

Output the type declaration of the property

Specified by:

getTypeDeclaration in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

getTypeDeclaration in class DefaultCodegenConfig

Parameters:

propertySchema - Swagger Property object

Returns:

a string presentation of the property type

getAlias

public String getAlias(String name)

Description copied from class: DefaultCodegenConfig

Determine the type alias for the given type if it exists. This feature is only used for Java, because the language does not have a aliasing mechanism of its own.

Overrides:

getAlias in class DefaultCodegenConfig

Parameters:

name - The type name.

Returns:

The alias of the given type, if it exists. If there is no alias for this type, then returns the input type name.

getSchemaType

public String getSchemaType(io.swagger.v3.oas.models.media.Schema schema)

Description copied from class: DefaultCodegenConfig

returns the swagger type for the property

Overrides:

getSchemaType in class DefaultCodegenConfig

Parameters:

schema - Schema property object

Returns:

string presentation of the type

modelDocFileFolder

public String modelDocFileFolder()

Specified by:

modelDocFileFolder in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

modelDocFileFolder in class DefaultCodegenConfig

modelFileFolder

public String modelFileFolder()

Specified by:

modelFileFolder in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

modelFileFolder in class DefaultCodegenConfig

postProcessModels

public Map<String,Object> postProcessModels(Map<String,Object> objs)

Specified by:

postProcessModels in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

postProcessModels in class DefaultCodegenConfig

processOpts

public void processOpts()

Specified by:

processOpts in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

processOpts in class DefaultCodegenConfig

setArtifactId

public void setArtifactId(String artifactId)

setArtifactVersion

public void setArtifactVersion(String artifactVersion)

setGroupId

public void setGroupId(String groupId)

setPackageName

public void setPackageName(String packageName)

setSourceFolder

public void setSourceFolder(String sourceFolder)

toEnumVarName

public String toEnumVarName(String value,
 String datatype)

Return the sanitized variable name for enum

Overrides:

toEnumVarName in class DefaultCodegenConfig

Parameters:

value - enum variable name

datatype - data type

Returns:

the sanitized variable name for enum

toEnumValue

public String toEnumValue(String value,
 String datatype)

Description copied from class: DefaultCodegenConfig

Return the enum value in the language specified format e.g. status becomes "status"

Overrides:

toEnumValue in class DefaultCodegenConfig

Parameters:

value - enum variable name

datatype - data type

Returns:

the sanitized value for enum

isPrimivite

public boolean isPrimivite(String datatype)

Overrides:

isPrimivite in class DefaultCodegenConfig

toInstantiationType

public String toInstantiationType(io.swagger.v3.oas.models.media.Schema p)

Description copied from class: DefaultCodegenConfig

Return the instantiation type of the property, especially for map and array

Overrides:

toInstantiationType in class DefaultCodegenConfig

Parameters:

p - Swagger property object

Returns:

string presentation of the instantiation type of the property

toModelImport

public String toModelImport(String name)

Return the fully-qualified "Model" name for import

Specified by:

toModelImport in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toModelImport in class DefaultCodegenConfig

Parameters:

name - the name of the "Model"

Returns:

the fully-qualified "Model" name for import

toModelName

public String toModelName(String name)

Output the proper model name (capitalized). In case the name belongs to the TypeSystem it won't be renamed.

Specified by:

toModelName in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toModelName in class DefaultCodegenConfig

Parameters:

name - the name of the model

Returns:

capitalized model name

toVarName

public String toVarName(String name)

Description copied from class: DefaultCodegenConfig

Return the variable name by removing invalid characters and proper escaping if it's a reserved word.

Overrides:

toVarName in class DefaultCodegenConfig

Parameters:

name - the variable name

Returns:

the sanitized variable name

toEnumName

public String toEnumName(io.swagger.codegen.v3.CodegenProperty property)

Description copied from class: DefaultCodegenConfig

Return the Enum name (e.g. StatusEnum given 'status')

Overrides:

toEnumName in class DefaultCodegenConfig

Parameters:

property - Codegen property

Returns:

the Enum name

addHandlebarHelpers

public void addHandlebarHelpers(com.github.jknack.handlebars.Handlebars handlebars)

Specified by:

addHandlebarHelpers in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

addHandlebarHelpers in class DefaultCodegenConfig

isReservedWord

protected boolean isReservedWord(String word)

Overrides:

isReservedWord in class DefaultCodegenConfig

needToImport

protected boolean needToImport(String type)

Check the type to see if it needs import the library/module/package

Overrides:

needToImport in class DefaultCodegenConfig

Parameters:

type - name of the type

Returns:

true if the library/module/package of the corresponding type needs to be imported