public abstract class AbstractJavaCodegen extends DefaultCodegen implements CodegenConfig
additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoBaseURL, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, ignoreImportMapping, importMapping, inputSpec, instantiationTypes, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, releaseNote, removeOperationIdPrefix, reservedWords, reservedWordsMappings, skipAliasGeneration, 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() |
protected void |
checkDuplicatedModelNameIgnoringCase(io.swagger.models.Swagger swagger) |
boolean |
convertPropertyToBoolean(String propertyKey) |
boolean |
defaultIgnoreImportMappingOption() |
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
|
protected void |
fixUpParentAndInterfaces(CodegenModel codegenModel,
Map<String,CodegenModel> allModels)
Fix up all parent and interface CodegenModel references.
|
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
|
Map<String,Object> |
postProcessAllModels(Map<String,Object> objs) |
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() |
protected void |
replaceDuplicatedInModelProperties(Map<String,io.swagger.models.Model> definitions,
String modelName,
String newModelName) |
protected void |
replaceDuplicatedInPaths(Map<String,io.swagger.models.Path> paths,
String modelName,
String newModelName) |
String |
sanitizeTag(String tag)
Sanitize tag
|
void |
setAdditionalModelTypeAnnotations(List<String> additionalModelTypeAnnotations) |
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 |
setJava11Mode(boolean java11Mode) |
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, ensureUniqueName, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromModel, fromOperation, fromParameter, fromProperty, fromResponse, fromSecurity, generateExamplePath, getCommonTemplateDir, getExamples, getGitRepoBaseURL, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getIgnoreImportMapping, getInnerEnumAllowableValues, getInputSpec, getLibrary, getOrGenerateOperationId, getOutputDir, getParameterDataType, getReleaseNote, getSkipAliasGeneration, getSymbolName, getterAndSetterCapitalize, getTypeDeclaration, importMapping, initalizeSpecialCharacterMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isHideGenerationTimestamp, isModelObject, isPrimivite, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, isUsingFlattenSpec, languageSpecificPrimitives, modelDocTemplateFiles, modelFilename, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessModelProperties, postProcessModelsEnum, postProcessOperationsWithModels, postProcessSupportingFileData, processCompiler, processSwagger, readRefModelParameter, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoBaseURL, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setIgnoreImportMapping, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipAliasGeneration, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, titleCase, toApiImport, toApiVarName, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toGetter, toInstantiationType, toModelImport, toModelTestFilename, toSetter, typeMapping, underscore, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptionalclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitadditionalProperties, addOperationToGroup, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, fromModel, fromOperation, fromSecurity, generateExamplePath, getCommonTemplateDir, getGitRepoBaseURL, getGitRepoId, getGitUserId, getHelp, getHttpUserAgent, getIgnoreFilePathOverride, getIgnoreImportMapping, getInputSpec, getLibrary, getName, getOutputDir, getReleaseNote, getSkipAliasGeneration, getTag, getTypeDeclaration, importMapping, instantiationTypes, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, isUsingFlattenSpec, languageSpecificPrimitives, modelDocTemplateFiles, modelFilename, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessOperationsWithModels, postProcessSupportingFileData, processCompiler, processSwagger, reservedWords, reservedWordsMappings, sanitizeName, setGitRepoBaseURL, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setIgnoreImportMapping, setInputSpec, setLibrary, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipAliasGeneration, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toApiVarName, toGetter, toModelImport, toModelTestFilename, toSetter, typeMapping, vendorExtensionspublic 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 JAVA11_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
public static final String ERROR_ON_UNKNOWN_ENUM
public static final String CHECK_DUPLICATED_MODEL_NAME
public static final String ADDITIONAL_MODEL_TYPE_ANNOTATIONS
protected String dateLibrary
protected boolean supportAsync
protected boolean java8Mode
protected boolean java11Mode
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 CodegenConfigprocessOpts in class DefaultCodegenpublic Map<String,Object> postProcessAllModels(Map<String,Object> objs)
postProcessAllModels in interface CodegenConfigpostProcessAllModels in class DefaultCodegenpublic String escapeReservedWord(String name)
DefaultCodegenescapeReservedWord in interface CodegenConfigescapeReservedWord in class DefaultCodegenname - the name to be escapedpublic String apiFileFolder()
apiFileFolder in interface CodegenConfigapiFileFolder in class DefaultCodegenpublic String apiTestFileFolder()
apiTestFileFolder in interface CodegenConfigapiTestFileFolder in class DefaultCodegenpublic String modelFileFolder()
modelFileFolder in interface CodegenConfigmodelFileFolder in class DefaultCodegenpublic String apiDocFileFolder()
apiDocFileFolder in interface CodegenConfigapiDocFileFolder in class DefaultCodegenpublic String modelDocFileFolder()
modelDocFileFolder in interface CodegenConfigmodelDocFileFolder in class DefaultCodegenpublic String toApiDocFilename(String name)
DefaultCodegentoApiDocFilename in interface CodegenConfigtoApiDocFilename in class DefaultCodegenname - the file name of the Apipublic String toModelDocFilename(String name)
DefaultCodegentoModelDocFilename in interface CodegenConfigtoModelDocFilename in class DefaultCodegenname - the model namepublic String toApiTestFilename(String name)
DefaultCodegentoApiTestFilename in interface CodegenConfigtoApiTestFilename in class DefaultCodegenname - the file name of the Apipublic String toApiName(String name)
DefaultCodegentoApiName in interface CodegenConfigtoApiName in class DefaultCodegenname - the name of the Apipublic String toApiFilename(String name)
DefaultCodegentoApiFilename in interface CodegenConfigtoApiFilename in class DefaultCodegenname - the file name of the Apipublic String toVarName(String name)
DefaultCodegentoVarName in class DefaultCodegenname - the variable namepublic String toParamName(String name)
DefaultCodegentoParamName in interface CodegenConfigtoParamName in class DefaultCodegenname - Codegen property objectpublic String toModelName(String name)
DefaultCodegentoModelName in interface CodegenConfigtoModelName in class DefaultCodegenname - the name of the modelpublic String toModelFilename(String name)
DefaultCodegentoModelFilename in interface CodegenConfigtoModelFilename in class DefaultCodegenname - the model namepublic String getTypeDeclaration(io.swagger.models.properties.Property p)
DefaultCodegengetTypeDeclaration in interface CodegenConfiggetTypeDeclaration in class DefaultCodegenp - Swagger Property objectpublic String getAlias(String name)
DefaultCodegengetAlias in class DefaultCodegenname - The type name.public String toDefaultValue(io.swagger.models.properties.Property p)
DefaultCodegentoDefaultValue in class DefaultCodegenp - Swagger property objectpublic void setParameterExampleValue(CodegenParameter p)
DefaultCodegensetParameterExampleValue in class DefaultCodegenp - Swagger property objectpublic String toExampleValue(io.swagger.models.properties.Property p)
DefaultCodegentoExampleValue in class DefaultCodegenp - Swagger property objectpublic String getSwaggerType(io.swagger.models.properties.Property p)
DefaultCodegengetSwaggerType in class DefaultCodegenp - Swagger property objectpublic String toOperationId(String operationId)
DefaultCodegentoOperationId in class DefaultCodegenoperationId - operation IDpublic CodegenModel fromModel(String name, io.swagger.models.Model model, Map<String,io.swagger.models.Model> allDefinitions)
DefaultCodegenfromModel in interface CodegenConfigfromModel in class DefaultCodegenname - 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 CodegenConfigpostProcessModelProperty in class DefaultCodegenprotected void fixUpParentAndInterfaces(CodegenModel codegenModel, Map<String,CodegenModel> allModels)
DefaultCodegenfixUpParentAndInterfaces in class DefaultCodegenpublic void postProcessParameter(CodegenParameter parameter)
postProcessParameter in interface CodegenConfigpostProcessParameter in class DefaultCodegenpublic Map<String,Object> postProcessModels(Map<String,Object> objs)
postProcessModels in interface CodegenConfigpostProcessModels in class DefaultCodegenpublic Map<String,Object> postProcessOperations(Map<String,Object> objs)
postProcessOperations in interface CodegenConfigpostProcessOperations in class DefaultCodegenpublic void preprocessSwagger(io.swagger.models.Swagger swagger)
preprocessSwagger in interface CodegenConfigpreprocessSwagger in class DefaultCodegenprotected boolean needToImport(String type)
DefaultCodegenneedToImport in class DefaultCodegentype - name of the typeprotected void checkDuplicatedModelNameIgnoringCase(io.swagger.models.Swagger swagger)
protected void replaceDuplicatedInPaths(Map<String,io.swagger.models.Path> paths, String modelName, String newModelName)
protected void replaceDuplicatedInModelProperties(Map<String,io.swagger.models.Model> definitions, String modelName, String newModelName)
public String toEnumName(CodegenProperty property)
DefaultCodegentoEnumName in class DefaultCodegenproperty - Codegen propertypublic String toEnumVarName(String value, String datatype)
DefaultCodegentoEnumVarName in class DefaultCodegenvalue - enum variable namedatatype - data typepublic String toEnumValue(String value, String datatype)
DefaultCodegentoEnumValue in class DefaultCodegenvalue - 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)
DefaultCodegenfromOperation in interface CodegenConfigfromOperation in class DefaultCodegenpath - 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 setJava11Mode(boolean java11Mode)
public void setDisableHtmlEscaping(boolean disabled)
public void setSupportAsync(boolean enabled)
public void setAdditionalModelTypeAnnotations(List<String> additionalModelTypeAnnotations)
public String escapeQuotationMark(String input)
DefaultCodegenescapeQuotationMark in interface CodegenConfigescapeQuotationMark in class DefaultCodegeninput - String to be cleaned uppublic String escapeUnsafeCharacters(String input)
DefaultCodegenescapeUnsafeCharacters in interface CodegenConfigescapeUnsafeCharacters in class DefaultCodegeninput - String to be cleaned uppublic void setSupportJava6(boolean value)
public String toRegularExpression(String pattern)
DefaultCodegentoRegularExpression in class DefaultCodegenpattern - the pattern (regular expression)public boolean convertPropertyToBoolean(String propertyKey)
convertPropertyToBoolean in class DefaultCodegenpublic void writePropertyBack(String propertyKey, boolean value)
writePropertyBack in class DefaultCodegenpublic String toBooleanGetter(String name)
toBooleanGetter in interface CodegenConfigtoBooleanGetter in class DefaultCodegenname - the name of the propertypublic String sanitizeTag(String tag)
DefaultCodegensanitizeTag in interface CodegenConfigsanitizeTag in class DefaultCodegentag - Tagpublic boolean defaultIgnoreImportMappingOption()
defaultIgnoreImportMappingOption in interface CodegenConfigdefaultIgnoreImportMappingOption in class DefaultCodegenCopyright © 2022. All rights reserved.