public abstract class AbstractJavaCodegen extends DefaultCodegenConfig
additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, copyFistAllOfProperties, customTemplateDir, DEFAULT_CONTENT_TYPE, DEFAULT_TEMPLATE_DIR, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, ignoreImportMapping, importMapping, inputSpec, inputURL, instantiationTypes, 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 and Description |
---|
AbstractJavaCodegen() |
Modifier and Type | Method and Description |
---|---|
protected void |
addAdditionPropertiesToCodeGenModel(io.swagger.codegen.v3.CodegenModel codegenModel,
io.swagger.v3.oas.models.media.Schema schema) |
void |
addHandlebarHelpers(com.github.jknack.handlebars.Handlebars handlebars) |
String |
apiDocFileFolder() |
String |
apiFileFolder() |
String |
apiTestFileFolder() |
String |
camelizeVarName(String word,
boolean lowercaseFirstLetter) |
boolean |
checkAliasModel() |
protected void |
checkDuplicatedModelNameIgnoringCase(io.swagger.v3.oas.models.OpenAPI openAPI) |
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(io.swagger.codegen.v3.CodegenModel codegenModel,
Map<String,io.swagger.codegen.v3.CodegenModel> allModels)
Fix up all parent and interface CodegenModel references.
|
io.swagger.codegen.v3.CodegenModel |
fromModel(String name,
io.swagger.v3.oas.models.media.Schema schema,
Map<String,io.swagger.v3.oas.models.media.Schema> allSchemas)
Convert Swagger Model object to Codegen Model object
|
io.swagger.codegen.v3.CodegenOperation |
fromOperation(String path,
String httpMethod,
io.swagger.v3.oas.models.Operation operation,
Map<String,io.swagger.v3.oas.models.media.Schema> schemas,
io.swagger.v3.oas.models.OpenAPI openAPI)
Convert Swagger Operation object to Codegen Operation object
|
String |
getAlias(String name)
Determine the type alias for the given type if it exists.
|
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
|
protected static boolean |
isSameEnum(io.swagger.codegen.v3.CodegenProperty actual,
io.swagger.codegen.v3.CodegenProperty other) |
String |
modelDocFileFolder() |
String |
modelFileFolder() |
protected boolean |
needToImport(String type)
Check the type to see if it needs import the library/module/package
|
void |
postProcessModelProperty(io.swagger.codegen.v3.CodegenModel model,
io.swagger.codegen.v3.CodegenProperty property) |
Map<String,Object> |
postProcessModels(Map<String,Object> objs) |
Map<String,Object> |
postProcessOperations(Map<String,Object> objs) |
void |
postProcessParameter(io.swagger.codegen.v3.CodegenParameter parameter) |
void |
preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI) |
void |
processOpts() |
protected void |
replaceDuplicatedInModelProperties(Map<String,io.swagger.v3.oas.models.media.Schema> definitions,
String modelName,
String newModelName) |
protected void |
replaceDuplicatedInPaths(io.swagger.v3.oas.models.Paths paths,
String modelName,
String newModelName) |
String |
sanitizeTag(String tag)
Sanitize tag
|
String |
sanitizeVarName(String name) |
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 |
setFullJavaUtil(boolean fullJavaUtil) |
void |
setGroupId(String groupId) |
void |
setInvokerPackage(String invokerPackage) |
void |
setJava8Mode(boolean enabled) |
void |
setLanguageArguments(List<io.swagger.codegen.v3.CodegenArgument> languageArguments) |
void |
setLicenseName(String licenseName) |
void |
setLicenseUrl(String licenseUrl) |
void |
setLocalVariablePrefix(String localVariablePrefix) |
void |
setParameterExampleValue(io.swagger.codegen.v3.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 |
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 Getter name for boolean property, e.g.
|
String |
toDefaultValue(io.swagger.v3.oas.models.media.Schema schema)
Return the default value of the property
|
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 |
toExampleValue(io.swagger.v3.oas.models.media.Schema schemaProperty)
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) |
addCodegenContentParameters, addConsumesInfo, addHasMore, addImport, additionalProperties, addOperationToGroup, addOption, addOption, addParameters, addParentContainer, addProducesInfo, addProperties, addRegularExpressionDelimiter, addSwitch, addVars, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, configureDataForTestTemplate, configuresParameterForMediaType, convertPropertyToBooleanAndWriteBack, customTemplateDir, dashize, defaultIncludes, detectParent, embeddedTemplateDir, ensureUniqueParameters, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromModel, fromOperation, fromParameter, fromProperty, fromRequestBody, fromResponse, fromSecurity, generateExamplePath, getArgumentsLocation, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getDefaultTemplateDir, 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, isObjectSchema, isPrimivite, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needsUnflattenedSpec, outputFolder, postProcessAllCodegenModels, postProcessAllModels, postProcessModelsEnum, postProcessOperationsWithModels, postProcessSupportingFileData, processCompiler, processModelEnums, processOpenAPI, readLanguageArguments, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setIgnoreImportMapping, setInputSpec, setInputURL, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterNullable, setReleaseNote, setRemoveOperationIdPrefix, setReservedWords, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, setTemplateEngine, setTemplateVersion, setUnflattenedOpenAPI, setUseOas2, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toApiVarName, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toGetter, toInstantiationType, toModelImport, toModelTestFilename, toSetter, typeMapping, underscore, updateCodegenModelEnumVars, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional
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 WITH_XML
public static final String SUPPORT_JAVA6
public static final String ERROR_ON_UNKNOWN_ENUM
public static final String CHECK_DUPLICATED_MODEL_NAME
protected String dateLibrary
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
public void processOpts()
processOpts
in interface io.swagger.codegen.v3.CodegenConfig
processOpts
in class DefaultCodegenConfig
public String escapeReservedWord(String name)
DefaultCodegenConfig
escapeReservedWord
in interface io.swagger.codegen.v3.CodegenConfig
escapeReservedWord
in class DefaultCodegenConfig
name
- the name to be escapedpublic String apiFileFolder()
apiFileFolder
in interface io.swagger.codegen.v3.CodegenConfig
apiFileFolder
in class DefaultCodegenConfig
public String apiTestFileFolder()
apiTestFileFolder
in interface io.swagger.codegen.v3.CodegenConfig
apiTestFileFolder
in class DefaultCodegenConfig
public String modelFileFolder()
modelFileFolder
in interface io.swagger.codegen.v3.CodegenConfig
modelFileFolder
in class DefaultCodegenConfig
public String apiDocFileFolder()
apiDocFileFolder
in interface io.swagger.codegen.v3.CodegenConfig
apiDocFileFolder
in class DefaultCodegenConfig
public String modelDocFileFolder()
modelDocFileFolder
in interface io.swagger.codegen.v3.CodegenConfig
modelDocFileFolder
in class DefaultCodegenConfig
public String toApiDocFilename(String name)
DefaultCodegenConfig
toApiDocFilename
in interface io.swagger.codegen.v3.CodegenConfig
toApiDocFilename
in class DefaultCodegenConfig
name
- the file name of the Apipublic String toModelDocFilename(String name)
DefaultCodegenConfig
toModelDocFilename
in interface io.swagger.codegen.v3.CodegenConfig
toModelDocFilename
in class DefaultCodegenConfig
name
- the model namepublic String toApiTestFilename(String name)
DefaultCodegenConfig
toApiTestFilename
in interface io.swagger.codegen.v3.CodegenConfig
toApiTestFilename
in class DefaultCodegenConfig
name
- the file name of the Apipublic String toApiName(String name)
DefaultCodegenConfig
toApiName
in interface io.swagger.codegen.v3.CodegenConfig
toApiName
in class DefaultCodegenConfig
name
- the name of the Apipublic String toApiFilename(String name)
DefaultCodegenConfig
toApiFilename
in interface io.swagger.codegen.v3.CodegenConfig
toApiFilename
in class DefaultCodegenConfig
name
- the file name of the Apipublic String toVarName(String name)
DefaultCodegenConfig
toVarName
in class DefaultCodegenConfig
name
- the variable namepublic String toParamName(String name)
DefaultCodegenConfig
toParamName
in interface io.swagger.codegen.v3.CodegenConfig
toParamName
in class DefaultCodegenConfig
name
- Codegen property objectpublic String toModelName(String name)
DefaultCodegenConfig
toModelName
in interface io.swagger.codegen.v3.CodegenConfig
toModelName
in class DefaultCodegenConfig
name
- the name of the modelpublic String toModelFilename(String name)
DefaultCodegenConfig
toModelFilename
in interface io.swagger.codegen.v3.CodegenConfig
toModelFilename
in class DefaultCodegenConfig
name
- the model namepublic String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema propertySchema)
DefaultCodegenConfig
getTypeDeclaration
in interface io.swagger.codegen.v3.CodegenConfig
getTypeDeclaration
in class DefaultCodegenConfig
propertySchema
- Schema Property objectpublic String getAlias(String name)
DefaultCodegenConfig
getAlias
in class DefaultCodegenConfig
name
- The type name.public String toDefaultValue(io.swagger.v3.oas.models.media.Schema schema)
DefaultCodegenConfig
toDefaultValue
in class DefaultCodegenConfig
schema
- Schema property objectpublic void setParameterExampleValue(io.swagger.codegen.v3.CodegenParameter p)
DefaultCodegenConfig
setParameterExampleValue
in class DefaultCodegenConfig
p
- Swagger property objectpublic String toExampleValue(io.swagger.v3.oas.models.media.Schema schemaProperty)
DefaultCodegenConfig
toExampleValue
in class DefaultCodegenConfig
schemaProperty
- Schema property objectpublic String getSchemaType(io.swagger.v3.oas.models.media.Schema schema)
DefaultCodegenConfig
getSchemaType
in class DefaultCodegenConfig
schema
- Schema property objectpublic String toOperationId(String operationId)
DefaultCodegenConfig
toOperationId
in class DefaultCodegenConfig
operationId
- operation IDpublic io.swagger.codegen.v3.CodegenModel fromModel(String name, io.swagger.v3.oas.models.media.Schema schema, Map<String,io.swagger.v3.oas.models.media.Schema> allSchemas)
DefaultCodegenConfig
fromModel
in interface io.swagger.codegen.v3.CodegenConfig
fromModel
in class DefaultCodegenConfig
name
- the name of the modelschema
- Swagger Model objectallSchemas
- a map of all Swagger models from the specprotected void addAdditionPropertiesToCodeGenModel(io.swagger.codegen.v3.CodegenModel codegenModel, io.swagger.v3.oas.models.media.Schema schema)
addAdditionPropertiesToCodeGenModel
in class DefaultCodegenConfig
public void postProcessModelProperty(io.swagger.codegen.v3.CodegenModel model, io.swagger.codegen.v3.CodegenProperty property)
postProcessModelProperty
in interface io.swagger.codegen.v3.CodegenConfig
postProcessModelProperty
in class DefaultCodegenConfig
protected void fixUpParentAndInterfaces(io.swagger.codegen.v3.CodegenModel codegenModel, Map<String,io.swagger.codegen.v3.CodegenModel> allModels)
DefaultCodegenConfig
fixUpParentAndInterfaces
in class DefaultCodegenConfig
public void postProcessParameter(io.swagger.codegen.v3.CodegenParameter parameter)
postProcessParameter
in interface io.swagger.codegen.v3.CodegenConfig
postProcessParameter
in class DefaultCodegenConfig
public Map<String,Object> postProcessModels(Map<String,Object> objs)
postProcessModels
in interface io.swagger.codegen.v3.CodegenConfig
postProcessModels
in class DefaultCodegenConfig
public Map<String,Object> postProcessOperations(Map<String,Object> objs)
postProcessOperations
in interface io.swagger.codegen.v3.CodegenConfig
postProcessOperations
in class DefaultCodegenConfig
public void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
preprocessOpenAPI
in interface io.swagger.codegen.v3.CodegenConfig
preprocessOpenAPI
in class DefaultCodegenConfig
protected boolean needToImport(String type)
DefaultCodegenConfig
needToImport
in class DefaultCodegenConfig
type
- name of the typeprotected void checkDuplicatedModelNameIgnoringCase(io.swagger.v3.oas.models.OpenAPI openAPI)
protected void replaceDuplicatedInPaths(io.swagger.v3.oas.models.Paths paths, String modelName, String newModelName)
protected void replaceDuplicatedInModelProperties(Map<String,io.swagger.v3.oas.models.media.Schema> definitions, String modelName, String newModelName)
public String toEnumName(io.swagger.codegen.v3.CodegenProperty property)
DefaultCodegenConfig
toEnumName
in class DefaultCodegenConfig
property
- Codegen propertypublic String toEnumVarName(String value, String datatype)
DefaultCodegenConfig
toEnumVarName
in class DefaultCodegenConfig
value
- enum variable namedatatype
- data typepublic String toEnumValue(String value, String datatype)
DefaultCodegenConfig
toEnumValue
in class DefaultCodegenConfig
value
- enum variable namedatatype
- data typepublic io.swagger.codegen.v3.CodegenOperation fromOperation(String path, String httpMethod, io.swagger.v3.oas.models.Operation operation, Map<String,io.swagger.v3.oas.models.media.Schema> schemas, io.swagger.v3.oas.models.OpenAPI openAPI)
DefaultCodegenConfig
fromOperation
in interface io.swagger.codegen.v3.CodegenConfig
fromOperation
in class DefaultCodegenConfig
path
- the path of the operationhttpMethod
- HTTP methodoperation
- Swagger operation objectschemas
- a map of schemasopenAPI
- a OpenAPI object representing the specprotected static boolean isSameEnum(io.swagger.codegen.v3.CodegenProperty actual, io.swagger.codegen.v3.CodegenProperty other)
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 String escapeQuotationMark(String input)
DefaultCodegenConfig
escapeQuotationMark
in interface io.swagger.codegen.v3.CodegenConfig
escapeQuotationMark
in class DefaultCodegenConfig
input
- String to be cleaned uppublic String escapeUnsafeCharacters(String input)
DefaultCodegenConfig
escapeUnsafeCharacters
in interface io.swagger.codegen.v3.CodegenConfig
escapeUnsafeCharacters
in class DefaultCodegenConfig
input
- String to be cleaned uppublic void setSupportJava6(boolean value)
public String toRegularExpression(String pattern)
DefaultCodegenConfig
toRegularExpression
in class DefaultCodegenConfig
pattern
- the pattern (regular expression)public boolean convertPropertyToBoolean(String propertyKey)
convertPropertyToBoolean
in class DefaultCodegenConfig
public void writePropertyBack(String propertyKey, boolean value)
writePropertyBack
in class DefaultCodegenConfig
public String toBooleanGetter(String name)
toBooleanGetter
in interface io.swagger.codegen.v3.CodegenConfig
toBooleanGetter
in class DefaultCodegenConfig
name
- the name of the propertypublic String sanitizeTag(String tag)
DefaultCodegenConfig
sanitizeTag
in interface io.swagger.codegen.v3.CodegenConfig
sanitizeTag
in class DefaultCodegenConfig
tag
- Tagpublic void addHandlebarHelpers(com.github.jknack.handlebars.Handlebars handlebars)
addHandlebarHelpers
in interface io.swagger.codegen.v3.CodegenConfig
addHandlebarHelpers
in class DefaultCodegenConfig
public void setLanguageArguments(List<io.swagger.codegen.v3.CodegenArgument> languageArguments)
setLanguageArguments
in interface io.swagger.codegen.v3.CodegenConfig
setLanguageArguments
in class DefaultCodegenConfig
public boolean defaultIgnoreImportMappingOption()
defaultIgnoreImportMappingOption
in interface io.swagger.codegen.v3.CodegenConfig
defaultIgnoreImportMappingOption
in class DefaultCodegenConfig
public boolean checkAliasModel()
Copyright © 2021. All rights reserved.