io.swagger.codegen.languages

Class AbstractGoCodegen

java.lang.Object

io.swagger.codegen.DefaultCodegen

io.swagger.codegen.languages.AbstractGoCodegen

All Implemented Interfaces:

CodegenConfig

Direct Known Subclasses:

GoClientCodegen, GoServerCodegen

public abstract class AbstractGoCodegen
extends DefaultCodegen
implements CodegenConfig

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOGGER
protected String	packageName

Fields inherited from class io.swagger.codegen.DefaultCodegen

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importMapping, inputSpec, instantiationTypes, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, releaseNote, removeOperationIdPrefix, reservedWords, reservedWordsMappings, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, templateDir, testPackage, typeAliases, typeMapping, vendorExtensions

Constructor Summary

Constructors

Constructor and Description
AbstractGoCodegen()

Method Summary

Modifier and Type	Method and Description
Map<String,String>	createMapping(String key, String value)
String	escapeQuotationMark(String input) Escape single and/or double quote to avoid code injection
String	escapeReservedWord(String name) Escapes a reserved word as defined in the `reservedWords` array.
String	escapeUnsafeCharacters(String input) override with any special text escaping logic to handle unsafe characters so as to avoid code injection
String	getSwaggerType(io.swagger.models.properties.Property p) returns the swagger type for the property
String	getTypeDeclaration(io.swagger.models.properties.Property p) Output the type declaration of the property
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)
Map<String,Object>	postProcessOperations(Map<String,Object> objs)
void	postProcessParameter(CodegenParameter parameter) Overrides postProcessParameter to add a vendor extension "x-exportParamName".
Map<String,Object>	postProcessSupportingFileData(Map<String,Object> objs)
void	setPackageName(String packageName)
String	toApiFilename(String name) Return the file name of the Api Test
String	toEnumDefaultValue(String value, String datatype) Return the enum default value in the language specified format
String	toEnumName(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 name, String datatype) Return the sanitized variable name for enum
String	toModelFilename(String name) Return the capitalized file name of the model
String	toModelName(String name) Output the proper model name (capitalized).
String	toOperationId(String operationId) Return the operation ID (method name)
String	toParamName(String name) Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.
String	toVarName(String name) Return the variable name by removing invalid characters and proper escaping if it's a reserved word.

Methods inherited from class io.swagger.codegen.DefaultCodegen

addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOperationToGroup, addProperties, addRegularExpressionDelimiter, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFileFolder, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromModel, fromModel, fromOperation, fromOperation, fromParameter, fromProperty, fromResponse, fromSecurity, generateExamplePath, getAlias, getCommonTemplateDir, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getOrGenerateOperationId, getOutputDir, getReleaseNote, getSymbolName, getterAndSetterCapitalize, getTypeDeclaration, importMapping, initalizeSpecialCharacterMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessModelsEnum, postProcessOperationsWithModels, preprocessSwagger, processCompiler, processOpts, processSwagger, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoId, setGitUserId, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toDefaultValue, toDefaultValueWithParam, toExamples, toExampleValue, toGetter, toInstantiationType, toModelDocFilename, toModelImport, toModelTestFilename, toRegularExpression, toSetter, typeMapping, underscore, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, 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.CodegenConfig

additionalProperties, addOperationToGroup, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFileFolder, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, fromModel, fromModel, fromOperation, fromOperation, fromSecurity, generateExamplePath, getCommonTemplateDir, getGitRepoId, getGitUserId, getHelp, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getName, getOutputDir, getReleaseNote, getTag, getTypeDeclaration, importMapping, instantiationTypes, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessOperationsWithModels, preprocessSwagger, processCompiler, processOpts, processSwagger, reservedWords, reservedWordsMappings, sanitizeTag, setGitRepoId, setGitUserId, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelImport, toModelTestFilename, toSetter, typeMapping, vendorExtensions

Field Detail

LOGGER

protected static org.slf4j.Logger LOGGER

packageName

protected String packageName

Constructor Detail

AbstractGoCodegen

public AbstractGoCodegen()

Method Detail

escapeReservedWord

public String escapeReservedWord(String name)

Escapes a reserved word as defined in the `reservedWords` array. Handle escaping those terms here. This logic is only called if a variable matches the reserved words

Specified by:

escapeReservedWord in interface CodegenConfig

Overrides:

escapeReservedWord in class DefaultCodegen

Parameters:

name - the name to be escaped

Returns:

the escaped term

toVarName

public String toVarName(String name)

Description copied from class: DefaultCodegen

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

Overrides:

toVarName in class DefaultCodegen

Parameters:

name - the variable name

Returns:

the sanitized variable name

toParamName

public String toParamName(String name)

Description copied from class: DefaultCodegen

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

Specified by:

toParamName in interface CodegenConfig

Overrides:

toParamName in class DefaultCodegen

Parameters:

name - Codegen property object

Returns:

the sanitized parameter name

toModelName

public String toModelName(String name)

Description copied from class: DefaultCodegen

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

Specified by:

toModelName in interface CodegenConfig

Overrides:

toModelName in class DefaultCodegen

Parameters:

name - the name of the model

Returns:

capitalized model name

toModelFilename

public String toModelFilename(String name)

Description copied from class: DefaultCodegen

Return the capitalized file name of the model

Specified by:

toModelFilename in interface CodegenConfig

Overrides:

toModelFilename in class DefaultCodegen

Parameters:

name - the model name

Returns:

the file name of the model

toApiFilename

public String toApiFilename(String name)

Description copied from class: DefaultCodegen

Return the file name of the Api Test

Specified by:

toApiFilename in interface CodegenConfig

Overrides:

toApiFilename in class DefaultCodegen

Parameters:

name - the file name of the Api

Returns:

the file name of the Api

postProcessParameter

public void postProcessParameter(CodegenParameter parameter)

Overrides postProcessParameter to add a vendor extension "x-exportParamName". This is useful when paramName starts with a lowercase letter, but we need that param to be exportable (starts with an Uppercase letter).

Specified by:

postProcessParameter in interface CodegenConfig

Overrides:

postProcessParameter in class DefaultCodegen

Parameters:

parameter - CodegenParameter object to be processed.

getTypeDeclaration

public String getTypeDeclaration(io.swagger.models.properties.Property p)

Description copied from class: DefaultCodegen

Output the type declaration of the property

Specified by:

getTypeDeclaration in interface CodegenConfig

Overrides:

getTypeDeclaration in class DefaultCodegen

Parameters:

p - Swagger Property object

Returns:

a string presentation of the property type

getSwaggerType

public String getSwaggerType(io.swagger.models.properties.Property p)

Description copied from class: DefaultCodegen

returns the swagger type for the property

Overrides:

getSwaggerType in class DefaultCodegen

Parameters:

p - Swagger property object

Returns:

string presentation of the type

toOperationId

public String toOperationId(String operationId)

Description copied from class: DefaultCodegen

Return the operation ID (method name)

Overrides:

toOperationId in class DefaultCodegen

Parameters:

operationId - operation ID

Returns:

the sanitized method name

postProcessOperations

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

Specified by:

postProcessOperations in interface CodegenConfig

Overrides:

postProcessOperations in class DefaultCodegen

postProcessModels

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

Specified by:

postProcessModels in interface CodegenConfig

Overrides:

postProcessModels in class DefaultCodegen

postProcessSupportingFileData

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

Specified by:

postProcessSupportingFileData in interface CodegenConfig

Overrides:

postProcessSupportingFileData in class DefaultCodegen

needToImport

protected boolean needToImport(String type)

Description copied from class: DefaultCodegen

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

Overrides:

needToImport in class DefaultCodegen

Parameters:

type - name of the type

Returns:

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

setPackageName

public void setPackageName(String packageName)

escapeQuotationMark

public String escapeQuotationMark(String input)

Description copied from class: DefaultCodegen

Escape single and/or double quote to avoid code injection

Specified by:

escapeQuotationMark in interface CodegenConfig

Overrides:

escapeQuotationMark in class DefaultCodegen

Parameters:

input - String to be cleaned up

Returns:

string with quotation mark removed or escaped

escapeUnsafeCharacters

public String escapeUnsafeCharacters(String input)

Description copied from class: DefaultCodegen

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

Specified by:

escapeUnsafeCharacters in interface CodegenConfig

Overrides:

escapeUnsafeCharacters in class DefaultCodegen

Parameters:

input - String to be cleaned up

Returns:

string with unsafe characters removed or escaped

createMapping

public Map<String,String> createMapping(String key,
                                        String value)

toEnumValue

public String toEnumValue(String value,
                          String datatype)

Description copied from class: DefaultCodegen

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

Overrides:

toEnumValue in class DefaultCodegen

Parameters:

value - enum variable name

datatype - data type

Returns:

the sanitized value for enum

toEnumDefaultValue

public String toEnumDefaultValue(String value,
                                 String datatype)

Description copied from class: DefaultCodegen

Return the enum default value in the language specified format

Overrides:

toEnumDefaultValue in class DefaultCodegen

Parameters:

value - enum variable name

datatype - data type

Returns:

the default value for the enum

toEnumVarName

public String toEnumVarName(String name,
                            String datatype)

Description copied from class: DefaultCodegen

Return the sanitized variable name for enum

Overrides:

toEnumVarName in class DefaultCodegen

Parameters:

name - enum variable name

datatype - data type

Returns:

the sanitized variable name for enum

toEnumName

public String toEnumName(CodegenProperty property)

Description copied from class: DefaultCodegen

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

Overrides:

toEnumName in class DefaultCodegen

Parameters:

property - Codegen property

Returns:

the Enum name