io.swagger.codegen.languages

Class AbstractJavaCodegen

java.lang.Object

io.swagger.codegen.DefaultCodegen

io.swagger.codegen.languages.AbstractJavaCodegen

All Implemented Interfaces:

CodegenConfig

Direct Known Subclasses:

AbstractJavaJAXRSServerCodegen, GroovyClientCodegen, JavaClientCodegen, JavaInflectorServerCodegen, SpringCodegen

public abstract class AbstractJavaCodegen
extends DefaultCodegen
implements CodegenConfig

Field Summary

Fields

Modifier and Type	Field and Description
protected String	apiDocPath
protected String	artifactId
protected String	artifactVersion
static String	DATE_LIBRARY
protected String	dateLibrary
static String	DEFAULT_LIBRARY
static String	FULL_JAVA_UTIL
protected boolean	fullJavaUtil
protected String	groupId
protected boolean	hideGenerationTimestamp
protected String	invokerPackage
protected String	javaUtilPrefix
protected String	localVariablePrefix
protected String	modelDocPath
protected String	projectFolder
protected String	projectTestFolder
protected Boolean	serializableModel
protected boolean	serializeBigDecimalAsString
protected String	sourceFolder
protected String	testFolder

Fields inherited from class io.swagger.codegen.DefaultCodegen

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

Constructor Summary

Constructors

Constructor and Description
AbstractJavaCodegen()

Method Summary

Methods

Modifier and Type	Method and Description
String	apiDocFileFolder()
String	apiFileFolder()
String	apiTestFileFolder()
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
CodegenModel	fromModel(String name, io.swagger.models.Model model, Map<String,io.swagger.models.Model> allDefinitions) Convert Swagger Model object to Codegen Model object
CodegenOperation	fromOperation(String path, String httpMethod, io.swagger.models.Operation operation, Map<String,io.swagger.models.Model> definitions, io.swagger.models.Swagger swagger) Convert Swagger Operation object to Codegen Operation object
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
String	modelDocFileFolder()
String	modelFileFolder()
protected boolean	needToImport(String type) Check the type to see if it needs import the library/module/package
void	postProcessModelProperty(CodegenModel model, CodegenProperty property)
Map<String,Object>	postProcessModels(Map<String,Object> objs)
Map<String,Object>	postProcessOperations(Map<String,Object> objs)
void	postProcessParameter(CodegenParameter parameter)
void	preprocessSwagger(io.swagger.models.Swagger swagger)
void	processOpts()
void	setArtifactId(String artifactId)
void	setArtifactVersion(String artifactVersion)
void	setDateLibrary(String library)
void	setFullJavaUtil(boolean fullJavaUtil)
void	setGroupId(String groupId)
void	setInvokerPackage(String invokerPackage)
void	setLocalVariablePrefix(String localVariablePrefix)
void	setParameterExampleValue(CodegenParameter p) Return the example value of the parameter.
void	setSerializableModel(Boolean serializableModel)
void	setSerializeBigDecimalAsString(boolean s)
void	setSourceFolder(String sourceFolder)
String	toApiDocFilename(String name) Return the file name of the Api Documentation
String	toApiTestFilename(String name) Return the file name of the Api Test
String	toDefaultValue(io.swagger.models.properties.Property p) Return the default value of the property
String	toEnumName(CodegenProperty property) Return the Enum name (e.g.
String	toEnumValue(String value, String datatype) Return the enum value in the language specifed format e.g.
String	toEnumVarName(String value, String datatype) Return the sanitized variable name for enum
String	toModelDocFilename(String name) Return the capitalized file name of the model documentation
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, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, dashize, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromModel, fromOperation, fromParameter, fromProperty, fromResponse, fromSecurity, generateExamplePath, getCommonTemplateDir, getGitRepoId, getGitUserId, getHttpUserAgent, getInnerEnumAllowableValues, getLibrary, getOrGenerateOperationId, getOutputDir, getReleaseNote, getSymbolName, getterAndSetterCapitalize, getTypeDeclaration, importMapping, initalizeSpecialCharacterMapping, initialCaps, instantiationTypes, isDataTypeBinary, isPropertyInnerMostEnum, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelsEnum, postProcessSupportingFileData, processSwagger, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, sanitizeName, sanitizeTag, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoId, setGitUserId, setHttpUserAgent, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setReleaseNote, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiFilename, toApiImport, toApiName, toApiVarName, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toExampleValue, toInstantiationType, toModelImport, toModelTestFilename, toRegularExpression, typeMapping, underscore, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional

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, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, fromModel, fromOperation, fromSecurity, generateExamplePath, getCommonTemplateDir, getGitRepoId, getGitUserId, getHelp, getHttpUserAgent, getLibrary, getName, getOutputDir, getReleaseNote, getTag, getTypeDeclaration, importMapping, instantiationTypes, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessSupportingFileData, processSwagger, reservedWords, sanitizeTag, setGitRepoId, setGitUserId, setHttpUserAgent, setLibrary, setOutputDir, setReleaseNote, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiFilename, toApiImport, toApiName, toApiVarName, toModelImport, toModelTestFilename, typeMapping, vendorExtensions

Field Detail

FULL_JAVA_UTIL

public static final String FULL_JAVA_UTIL

See Also:

Constant Field Values

DEFAULT_LIBRARY

public static final String DEFAULT_LIBRARY

See Also:

Constant Field Values

DATE_LIBRARY

public static final String DATE_LIBRARY

See Also:

Constant Field Values

dateLibrary

protected String dateLibrary

invokerPackage

protected String invokerPackage

groupId

protected String groupId

artifactId

protected String artifactId

artifactVersion

protected String artifactVersion

projectFolder

protected String projectFolder

projectTestFolder

protected String projectTestFolder

sourceFolder

protected String sourceFolder

testFolder

protected String testFolder

localVariablePrefix

protected String localVariablePrefix

fullJavaUtil

protected boolean fullJavaUtil

javaUtilPrefix

protected String javaUtilPrefix

serializableModel

protected Boolean serializableModel

serializeBigDecimalAsString

protected boolean serializeBigDecimalAsString

hideGenerationTimestamp

protected boolean hideGenerationTimestamp

apiDocPath

protected String apiDocPath

modelDocPath

protected String modelDocPath

Constructor Detail

AbstractJavaCodegen

public AbstractJavaCodegen()

Method Detail

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class DefaultCodegen

escapeReservedWord

public String escapeReservedWord(String name)

Description copied from class: DefaultCodegen

Return the escaped name of the reserved word

Specified by:

escapeReservedWord in interface CodegenConfig

Overrides:

escapeReservedWord in class DefaultCodegen

Parameters:

name - the name to be escaped

Returns:

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

apiFileFolder

public String apiFileFolder()

Specified by:

apiFileFolder in interface CodegenConfig

Overrides:

apiFileFolder in class DefaultCodegen

apiTestFileFolder

public String apiTestFileFolder()

Specified by:

apiTestFileFolder in interface CodegenConfig

Overrides:

apiTestFileFolder in class DefaultCodegen

modelFileFolder

public String modelFileFolder()

Specified by:

modelFileFolder in interface CodegenConfig

Overrides:

modelFileFolder in class DefaultCodegen

apiDocFileFolder

public String apiDocFileFolder()

Specified by:

apiDocFileFolder in interface CodegenConfig

Overrides:

apiDocFileFolder in class DefaultCodegen

modelDocFileFolder

public String modelDocFileFolder()

Specified by:

modelDocFileFolder in interface CodegenConfig

Overrides:

modelDocFileFolder in class DefaultCodegen

toApiDocFilename

public String toApiDocFilename(String name)

Description copied from class: DefaultCodegen

Return the file name of the Api Documentation

Specified by:

toApiDocFilename in interface CodegenConfig

Overrides:

toApiDocFilename in class DefaultCodegen

Parameters:

name - the file name of the Api

Returns:

the file name of the Api

toModelDocFilename

public String toModelDocFilename(String name)

Description copied from class: DefaultCodegen

Return the capitalized file name of the model documentation

Specified by:

toModelDocFilename in interface CodegenConfig

Overrides:

toModelDocFilename in class DefaultCodegen

Parameters:

name - the model name

Returns:

the file name of the model

toApiTestFilename

public String toApiTestFilename(String name)

Description copied from class: DefaultCodegen

Return the file name of the Api Test

Specified by:

toApiTestFilename in interface CodegenConfig

Overrides:

toApiTestFilename in class DefaultCodegen

Parameters:

name - the file name of the Api

Returns:

the file name of the Api

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)

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

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

toDefaultValue

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

Description copied from class: DefaultCodegen

Return the default value of the property

Overrides:

toDefaultValue in class DefaultCodegen

Parameters:

p - Swagger property object

Returns:

string presentation of the default value of the property

setParameterExampleValue

public void setParameterExampleValue(CodegenParameter p)

Description copied from class: DefaultCodegen

Return the example value of the parameter.

Overrides:

setParameterExampleValue in class DefaultCodegen

Parameters:

p - Swagger property object

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

fromModel

public CodegenModel fromModel(String name,
                     io.swagger.models.Model model,
                     Map<String,io.swagger.models.Model> allDefinitions)

Description copied from class: DefaultCodegen

Convert Swagger Model object to Codegen Model object

Specified by:

fromModel in interface CodegenConfig

Overrides:

fromModel in class DefaultCodegen

Parameters:

name - the name of the model

model - Swagger Model object

allDefinitions - a map of all Swagger models from the spec

Returns:

Codegen Model object

postProcessModelProperty

public void postProcessModelProperty(CodegenModel model,
                            CodegenProperty property)

Specified by:

postProcessModelProperty in interface CodegenConfig

Overrides:

postProcessModelProperty in class DefaultCodegen

postProcessParameter

public void postProcessParameter(CodegenParameter parameter)

Specified by:

postProcessParameter in interface CodegenConfig

Overrides:

postProcessParameter in class DefaultCodegen

postProcessModels

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

Specified by:

postProcessModels in interface CodegenConfig

Overrides:

postProcessModels in class DefaultCodegen

postProcessOperations

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

Specified by:

postProcessOperations in interface CodegenConfig

Overrides:

postProcessOperations in class DefaultCodegen

preprocessSwagger

public void preprocessSwagger(io.swagger.models.Swagger swagger)

Specified by:

preprocessSwagger in interface CodegenConfig

Overrides:

preprocessSwagger 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

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

toEnumVarName

public String toEnumVarName(String value,
                   String datatype)

Description copied from class: DefaultCodegen

Return the sanitized variable name for enum

Overrides:

toEnumVarName in class DefaultCodegen

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: DefaultCodegen

Return the enum value in the language specifed 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

fromOperation

public CodegenOperation fromOperation(String path,
                             String httpMethod,
                             io.swagger.models.Operation operation,
                             Map<String,io.swagger.models.Model> definitions,
                             io.swagger.models.Swagger swagger)

Description copied from class: DefaultCodegen

Convert Swagger Operation object to Codegen Operation object

Specified by:

fromOperation in interface CodegenConfig

Overrides:

fromOperation in class DefaultCodegen

Parameters:

path - the path of the operation

httpMethod - HTTP method

operation - Swagger operation object

definitions - a map of Swagger models

swagger - a Swagger object representing the spec

Returns:

Codegen Operation object

setInvokerPackage

public void setInvokerPackage(String invokerPackage)

setGroupId

public void setGroupId(String groupId)

setArtifactId

public void setArtifactId(String artifactId)

setArtifactVersion

public void setArtifactVersion(String artifactVersion)

setSourceFolder

public void setSourceFolder(String sourceFolder)

setLocalVariablePrefix

public void setLocalVariablePrefix(String localVariablePrefix)

setSerializeBigDecimalAsString

public void setSerializeBigDecimalAsString(boolean s)

setSerializableModel

public void setSerializableModel(Boolean serializableModel)

setFullJavaUtil

public void setFullJavaUtil(boolean fullJavaUtil)

setDateLibrary

public void setDateLibrary(String library)

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