public abstract class AbstractJavaCodegen extends DefaultCodegen implements CodegenConfig
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 and Description |
---|
AbstractJavaCodegen() |
Modifier and Type | Method and Description |
---|---|
String |
apiDocFileFolder() |
String |
apiFileFolder() |
String |
apiTestFileFolder() |
boolean |
convertPropertyToBoolean(String propertyKey) |
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 |
getAlias(String name)
Determine the type alias for the given type if it exists.
|
String |
getInvokerPackage() |
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() |
String |
sanitizeTag(String tag)
Sanitize tag
|
void |
setArtifactDescription(String artifactDescription) |
void |
setArtifactId(String artifactId) |
void |
setArtifactUrl(String artifactUrl) |
void |
setArtifactVersion(String artifactVersion) |
void |
setDateLibrary(String library) |
void |
setDeveloperEmail(String developerEmail) |
void |
setDeveloperName(String developerName) |
void |
setDeveloperOrganization(String developerOrganization) |
void |
setDeveloperOrganizationUrl(String developerOrganizationUrl) |
void |
setDisableHtmlEscaping(boolean disabled) |
void |
setFullJavaUtil(boolean fullJavaUtil) |
void |
setGroupId(String groupId) |
void |
setInvokerPackage(String invokerPackage) |
void |
setJava8Mode(boolean enabled) |
void |
setLicenseName(String licenseName) |
void |
setLicenseUrl(String licenseUrl) |
void |
setLocalVariablePrefix(String localVariablePrefix) |
void |
setParameterExampleValue(CodegenParameter p)
Return the example value of the parameter.
|
void |
setScmConnection(String scmConnection) |
void |
setScmDeveloperConnection(String scmDeveloperConnection) |
void |
setScmUrl(String scmUrl) |
void |
setSerializableModel(Boolean serializableModel) |
void |
setSerializeBigDecimalAsString(boolean s) |
void |
setSourceFolder(String sourceFolder) |
void |
setSupportAsync(boolean enabled) |
void |
setSupportJava6(boolean value) |
void |
setTestFolder(String testFolder) |
void |
setWithXml(boolean withXml) |
String |
toApiDocFilename(String name)
Return the file name of the Api Documentation
|
String |
toApiFilename(String name)
Return the file name of the Api Test
|
String |
toApiName(String name)
Output the API (class) name (capitalized) ending with "Api"
Return DefaultApi if name is empty
|
String |
toApiTestFilename(String name)
Return the file name of the Api Test
|
String |
toBooleanGetter(String name)
Output the partial Getter name for boolean property, e.g.
|
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 specified format
e.g.
|
String |
toEnumVarName(String value,
String datatype)
Return the sanitized variable name for enum
|
String |
toExampleValue(io.swagger.models.properties.Property p)
Return the example value of the property
|
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 |
toRegularExpression(String pattern)
Return the regular expression/JSON schema pattern (http://json-schema.org/latest/json-schema-validation.html#anchor33)
|
String |
toVarName(String name)
Return the variable name by removing invalid characters and proper escaping if
it's a reserved word.
|
void |
writePropertyBack(String propertyKey,
boolean value) |
addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOperationToGroup, addOption, addOption, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, configureDataForTestTemplate, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromModel, fromOperation, fromParameter, fromProperty, fromResponse, fromSecurity, generateExamplePath, getCommonTemplateDir, getExamples, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getOrGenerateOperationId, getOutputDir, getParameterDataType, getReleaseNote, getSymbolName, getterAndSetterCapitalize, getTypeDeclaration, importMapping, initalizeSpecialCharacterMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isHideGenerationTimestamp, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelsEnum, postProcessOperationsWithModels, postProcessSupportingFileData, processCompiler, processSwagger, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toApiVarName, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toGetter, toInstantiationType, toModelImport, toModelTestFilename, toSetter, typeMapping, underscore, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
additionalProperties, addOperationToGroup, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, fromModel, fromOperation, fromSecurity, generateExamplePath, getCommonTemplateDir, getGitRepoId, getGitUserId, getHelp, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getName, getOutputDir, getReleaseNote, getTag, getTypeDeclaration, importMapping, instantiationTypes, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessOperationsWithModels, postProcessSupportingFileData, processCompiler, processSwagger, reservedWords, reservedWordsMappings, sanitizeName, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toApiVarName, toGetter, toModelImport, toModelTestFilename, toSetter, typeMapping, vendorExtensions
public static final String FULL_JAVA_UTIL
public static final String DEFAULT_LIBRARY
public static final String DATE_LIBRARY
public static final String JAVA8_MODE
public static final String SUPPORT_ASYNC
public static final String WITH_XML
public static final String SUPPORT_JAVA6
public static final String DISABLE_HTML_ESCAPING
protected String dateLibrary
protected boolean supportAsync
protected boolean java8Mode
protected boolean withXml
protected String invokerPackage
protected String groupId
protected String artifactId
protected String artifactVersion
protected String artifactUrl
protected String artifactDescription
protected String developerName
protected String developerEmail
protected String developerOrganization
protected String developerOrganizationUrl
protected String scmConnection
protected String scmDeveloperConnection
protected String scmUrl
protected String licenseName
protected String licenseUrl
protected String projectFolder
protected String projectTestFolder
protected String sourceFolder
protected String testFolder
protected String localVariablePrefix
protected boolean fullJavaUtil
protected String javaUtilPrefix
protected Boolean serializableModel
protected boolean serializeBigDecimalAsString
protected String apiDocPath
protected String modelDocPath
protected boolean supportJava6
protected boolean disableHtmlEscaping
public void processOpts()
processOpts
in interface CodegenConfig
processOpts
in class DefaultCodegen
public String escapeReservedWord(String name)
DefaultCodegen
escapeReservedWord
in interface CodegenConfig
escapeReservedWord
in class DefaultCodegen
name
- the name to be escapedpublic String apiFileFolder()
apiFileFolder
in interface CodegenConfig
apiFileFolder
in class DefaultCodegen
public String apiTestFileFolder()
apiTestFileFolder
in interface CodegenConfig
apiTestFileFolder
in class DefaultCodegen
public String modelFileFolder()
modelFileFolder
in interface CodegenConfig
modelFileFolder
in class DefaultCodegen
public String apiDocFileFolder()
apiDocFileFolder
in interface CodegenConfig
apiDocFileFolder
in class DefaultCodegen
public String modelDocFileFolder()
modelDocFileFolder
in interface CodegenConfig
modelDocFileFolder
in class DefaultCodegen
public String toApiDocFilename(String name)
DefaultCodegen
toApiDocFilename
in interface CodegenConfig
toApiDocFilename
in class DefaultCodegen
name
- the file name of the Apipublic String toModelDocFilename(String name)
DefaultCodegen
toModelDocFilename
in interface CodegenConfig
toModelDocFilename
in class DefaultCodegen
name
- the model namepublic String toApiTestFilename(String name)
DefaultCodegen
toApiTestFilename
in interface CodegenConfig
toApiTestFilename
in class DefaultCodegen
name
- the file name of the Apipublic String toApiName(String name)
DefaultCodegen
toApiName
in interface CodegenConfig
toApiName
in class DefaultCodegen
name
- the name of the Apipublic String toApiFilename(String name)
DefaultCodegen
toApiFilename
in interface CodegenConfig
toApiFilename
in class DefaultCodegen
name
- the file name of the Apipublic String toVarName(String name)
DefaultCodegen
toVarName
in class DefaultCodegen
name
- the variable namepublic String toParamName(String name)
DefaultCodegen
toParamName
in interface CodegenConfig
toParamName
in class DefaultCodegen
name
- Codegen property objectpublic String toModelName(String name)
DefaultCodegen
toModelName
in interface CodegenConfig
toModelName
in class DefaultCodegen
name
- the name of the modelpublic String toModelFilename(String name)
DefaultCodegen
toModelFilename
in interface CodegenConfig
toModelFilename
in class DefaultCodegen
name
- the model namepublic String getTypeDeclaration(io.swagger.models.properties.Property p)
DefaultCodegen
getTypeDeclaration
in interface CodegenConfig
getTypeDeclaration
in class DefaultCodegen
p
- Swagger Property objectpublic String getAlias(String name)
DefaultCodegen
getAlias
in class DefaultCodegen
name
- The type name.public String toDefaultValue(io.swagger.models.properties.Property p)
DefaultCodegen
toDefaultValue
in class DefaultCodegen
p
- Swagger property objectpublic void setParameterExampleValue(CodegenParameter p)
DefaultCodegen
setParameterExampleValue
in class DefaultCodegen
p
- Swagger property objectpublic String toExampleValue(io.swagger.models.properties.Property p)
DefaultCodegen
toExampleValue
in class DefaultCodegen
p
- Swagger property objectpublic String getSwaggerType(io.swagger.models.properties.Property p)
DefaultCodegen
getSwaggerType
in class DefaultCodegen
p
- Swagger property objectpublic String toOperationId(String operationId)
DefaultCodegen
toOperationId
in class DefaultCodegen
operationId
- operation IDpublic CodegenModel fromModel(String name, io.swagger.models.Model model, Map<String,io.swagger.models.Model> allDefinitions)
DefaultCodegen
fromModel
in interface CodegenConfig
fromModel
in class DefaultCodegen
name
- the name of the modelmodel
- Swagger Model objectallDefinitions
- a map of all Swagger models from the specpublic void postProcessModelProperty(CodegenModel model, CodegenProperty property)
postProcessModelProperty
in interface CodegenConfig
postProcessModelProperty
in class DefaultCodegen
public void postProcessParameter(CodegenParameter parameter)
postProcessParameter
in interface CodegenConfig
postProcessParameter
in class DefaultCodegen
public Map<String,Object> postProcessModels(Map<String,Object> objs)
postProcessModels
in interface CodegenConfig
postProcessModels
in class DefaultCodegen
public Map<String,Object> postProcessOperations(Map<String,Object> objs)
postProcessOperations
in interface CodegenConfig
postProcessOperations
in class DefaultCodegen
public void preprocessSwagger(io.swagger.models.Swagger swagger)
preprocessSwagger
in interface CodegenConfig
preprocessSwagger
in class DefaultCodegen
protected boolean needToImport(String type)
DefaultCodegen
needToImport
in class DefaultCodegen
type
- name of the typepublic String toEnumName(CodegenProperty property)
DefaultCodegen
toEnumName
in class DefaultCodegen
property
- Codegen propertypublic String toEnumVarName(String value, String datatype)
DefaultCodegen
toEnumVarName
in class DefaultCodegen
value
- enum variable namedatatype
- data typepublic String toEnumValue(String value, String datatype)
DefaultCodegen
toEnumValue
in class DefaultCodegen
value
- enum variable namedatatype
- data typepublic CodegenOperation fromOperation(String path, String httpMethod, io.swagger.models.Operation operation, Map<String,io.swagger.models.Model> definitions, io.swagger.models.Swagger swagger)
DefaultCodegen
fromOperation
in interface CodegenConfig
fromOperation
in class DefaultCodegen
path
- the path of the operationhttpMethod
- HTTP methodoperation
- Swagger operation objectdefinitions
- a map of Swagger modelsswagger
- a Swagger object representing the specpublic String getInvokerPackage()
public void setInvokerPackage(String invokerPackage)
public void setGroupId(String groupId)
public void setArtifactId(String artifactId)
public void setArtifactVersion(String artifactVersion)
public void setArtifactUrl(String artifactUrl)
public void setArtifactDescription(String artifactDescription)
public void setScmConnection(String scmConnection)
public void setScmDeveloperConnection(String scmDeveloperConnection)
public void setScmUrl(String scmUrl)
public void setDeveloperName(String developerName)
public void setDeveloperEmail(String developerEmail)
public void setDeveloperOrganization(String developerOrganization)
public void setDeveloperOrganizationUrl(String developerOrganizationUrl)
public void setLicenseName(String licenseName)
public void setLicenseUrl(String licenseUrl)
public void setSourceFolder(String sourceFolder)
public void setTestFolder(String testFolder)
public void setLocalVariablePrefix(String localVariablePrefix)
public void setSerializeBigDecimalAsString(boolean s)
public void setSerializableModel(Boolean serializableModel)
public void setFullJavaUtil(boolean fullJavaUtil)
public void setWithXml(boolean withXml)
public void setDateLibrary(String library)
public void setJava8Mode(boolean enabled)
public void setDisableHtmlEscaping(boolean disabled)
public void setSupportAsync(boolean enabled)
public String escapeQuotationMark(String input)
DefaultCodegen
escapeQuotationMark
in interface CodegenConfig
escapeQuotationMark
in class DefaultCodegen
input
- String to be cleaned uppublic String escapeUnsafeCharacters(String input)
DefaultCodegen
escapeUnsafeCharacters
in interface CodegenConfig
escapeUnsafeCharacters
in class DefaultCodegen
input
- String to be cleaned uppublic void setSupportJava6(boolean value)
public String toRegularExpression(String pattern)
DefaultCodegen
toRegularExpression
in class DefaultCodegen
pattern
- the pattern (regular expression)public boolean convertPropertyToBoolean(String propertyKey)
convertPropertyToBoolean
in class DefaultCodegen
public void writePropertyBack(String propertyKey, boolean value)
writePropertyBack
in class DefaultCodegen
public String toBooleanGetter(String name)
toBooleanGetter
in interface CodegenConfig
toBooleanGetter
in class DefaultCodegen
name
- the name of the propertypublic String sanitizeTag(String tag)
DefaultCodegen
sanitizeTag
in interface CodegenConfig
sanitizeTag
in class DefaultCodegen
tag
- TagCopyright © 2019. All rights reserved.