public abstract class AbstractJavaCodegen extends DefaultCodegen implements CodegenConfig
additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, defaultIncludes, docExtension, embeddedTemplateDir, enablePostProcessFile, ensureUniqueParams, fileSuffix, gitRepoId, gitUserId, globalOpenAPI, globalSchemas, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importMapping, inputSpec, instantiationTypes, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, prependFormOrBodyParameters, releaseNote, removeOperationIdPrefix, reservedWords, reservedWordsMappings, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, templateDir, testPackage, typeAliases, typeMapping, vendorExtensions| 构造器和说明 |
|---|
AbstractJavaCodegen() |
| 限定符和类型 | 方法和说明 |
|---|---|
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.v3.oas.models.media.Schema model,
Map<String,io.swagger.v3.oas.models.media.Schema> allDefinitions)
Convert OAS Model object to Codegen Model object
|
CodegenOperation |
fromOperation(String path,
String httpMethod,
io.swagger.v3.oas.models.Operation operation,
Map<String,io.swagger.v3.oas.models.media.Schema> definitions,
io.swagger.v3.oas.models.OpenAPI openAPI)
Convert OAS Operation object to Codegen Operation object
|
protected static String |
getAccept(io.swagger.v3.oas.models.OpenAPI openAPI,
io.swagger.v3.oas.models.Operation operation) |
String |
getAlias(String name)
Determine the type alias for the given type if it exists.
|
String |
getInvokerPackage() |
String |
getSchemaType(io.swagger.v3.oas.models.media.Schema p)
returns the OpenAPI type for the property.
|
String |
getTypeDeclaration(io.swagger.v3.oas.models.media.Schema 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 |
postProcessFile(File file,
String fileType)
Post-process the auto-generated file, e.g. using go-fmt to format the Go code.
|
void |
postProcessModelProperty(CodegenModel model,
CodegenProperty property) |
Map<String,Object> |
postProcessModels(Map<String,Object> objs) |
Map<String,Object> |
postProcessOperationsWithModels(Map<String,Object> objs,
List<Object> allModels) |
void |
postProcessParameter(CodegenParameter parameter) |
void |
preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI) |
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 |
setBooleanGetterPrefix(String booleanGetterPrefix) |
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 |
setParentArtifactId(String parentArtifactId) |
void |
setParentGroupId(String parentGroupId) |
void |
setParentOverridden(boolean parentOverridden) |
void |
setParentVersion(String parentVersion) |
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 |
setUseNullForUnknownEnumValue(boolean useNullForUnknownEnumValue) |
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. isActive
|
String |
toDefaultValue(io.swagger.v3.oas.models.media.Schema 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. status becomes "status"
|
String |
toEnumVarName(String value,
String datatype)
Return the sanitized variable name for enum
|
String |
toExampleValue(io.swagger.v3.oas.models.media.Schema 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, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, embeddedTemplateDir, escapeSpecialCharacters, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromOperation, fromParameter, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getDocExtension, getGitRepoId, getGitUserId, getHelp, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getMostInnerItems, getName, getOrGenerateOperationId, getOutputDir, getParameterDataType, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSymbolName, getTag, getterAndSetterCapitalize, getTypeDeclaration, hasBodyParameter, hasFormParameter, importMapping, initalizeSpecialCharacterMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnablePostProcessFile, isHideGenerationTimestamp, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelsEnum, postProcessOperations, postProcessSupportingFileData, processCompiler, processOpenAPI, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setDocExtension, setEnablePostProcessFile, setEnsureUniqueParams, setGitRepoId, setGitUserId, setGlobalOpenAPI, setGlobalSchemas, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setParameterExampleValue, setPrependFormOrBodyParameters, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toApiVarName, toArrayModelParamName, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toGetter, toGetter, toInstantiationType, toModelImport, toModelTestFilename, toSetter, 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, escapeTextWhileAllowingNewLines, fileSuffix, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getCommonTemplateDir, getDocExtension, getGitRepoId, getGitUserId, getHelp, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getName, getOutputDir, getReleaseNote, getTag, getTypeDeclaration, importMapping, instantiationTypes, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessOperations, postProcessSupportingFileData, processCompiler, processOpenAPI, reservedWords, reservedWordsMappings, sanitizeName, setDocExtension, setEnablePostProcessFile, setGitRepoId, setGitUserId, setGlobalOpenAPI, setGlobalSchemas, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toApiVarName, toGetter, toModelImport, toModelTestFilename, toSetter, typeMapping, vendorExtensionspublic static final String USE_NULL_FOR_UNKNOWN_ENUM_VALUE
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
protected String booleanGetterPrefix
protected boolean useNullForUnknownEnumValue
protected String parentGroupId
protected String parentArtifactId
protected String parentVersion
protected boolean parentOverridden
public void processOpts()
processOpts 在接口中 CodegenConfigprocessOpts 在类中 DefaultCodegenpublic String escapeReservedWord(String name)
DefaultCodegenescapeReservedWord 在接口中 CodegenConfigescapeReservedWord 在类中 DefaultCodegenname - the name to be escapedthrows Runtime exception as reserved word is not allowed (default behavior)
public String apiFileFolder()
apiFileFolder 在接口中 CodegenConfigapiFileFolder 在类中 DefaultCodegenpublic String apiTestFileFolder()
apiTestFileFolder 在接口中 CodegenConfigapiTestFileFolder 在类中 DefaultCodegenpublic String modelFileFolder()
modelFileFolder 在接口中 CodegenConfigmodelFileFolder 在类中 DefaultCodegenpublic String apiDocFileFolder()
apiDocFileFolder 在接口中 CodegenConfigapiDocFileFolder 在类中 DefaultCodegenpublic String modelDocFileFolder()
modelDocFileFolder 在接口中 CodegenConfigmodelDocFileFolder 在类中 DefaultCodegenpublic String toApiDocFilename(String name)
DefaultCodegentoApiDocFilename 在接口中 CodegenConfigtoApiDocFilename 在类中 DefaultCodegenname - the file name of the Apipublic String toModelDocFilename(String name)
DefaultCodegentoModelDocFilename 在接口中 CodegenConfigtoModelDocFilename 在类中 DefaultCodegenname - the model namepublic String toApiTestFilename(String name)
DefaultCodegentoApiTestFilename 在接口中 CodegenConfigtoApiTestFilename 在类中 DefaultCodegenname - the file name of the Apipublic String toApiName(String name)
DefaultCodegentoApiName 在接口中 CodegenConfigtoApiName 在类中 DefaultCodegenname - the name of the Apipublic String toApiFilename(String name)
DefaultCodegentoApiFilename 在接口中 CodegenConfigtoApiFilename 在类中 DefaultCodegenname - the file name of the Apipublic String toVarName(String name)
DefaultCodegentoVarName 在类中 DefaultCodegenname - the variable namepublic String toParamName(String name)
DefaultCodegentoParamName 在接口中 CodegenConfigtoParamName 在类中 DefaultCodegenname - Codegen property objectpublic String toModelName(String name)
DefaultCodegentoModelName 在接口中 CodegenConfigtoModelName 在类中 DefaultCodegenname - the name of the modelpublic String toModelFilename(String name)
DefaultCodegentoModelFilename 在接口中 CodegenConfigtoModelFilename 在类中 DefaultCodegenname - the model namepublic String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)
DefaultCodegengetTypeDeclaration 在接口中 CodegenConfiggetTypeDeclaration 在类中 DefaultCodegenp - property schemapublic String getAlias(String name)
DefaultCodegengetAlias 在类中 DefaultCodegenname - The type name.public String toDefaultValue(io.swagger.v3.oas.models.media.Schema p)
DefaultCodegentoDefaultValue 在类中 DefaultCodegenp - Property schemapublic void setParameterExampleValue(CodegenParameter p)
DefaultCodegensetParameterExampleValue 在类中 DefaultCodegenp - Codegen parameterpublic String toExampleValue(io.swagger.v3.oas.models.media.Schema p)
DefaultCodegentoExampleValue 在类中 DefaultCodegenp - Property schemapublic String getSchemaType(io.swagger.v3.oas.models.media.Schema p)
DefaultCodegengetSchemaType 在类中 DefaultCodegenp - property schemapublic String toOperationId(String operationId)
DefaultCodegentoOperationId 在类中 DefaultCodegenoperationId - operation IDpublic CodegenModel fromModel(String name, io.swagger.v3.oas.models.media.Schema model, Map<String,io.swagger.v3.oas.models.media.Schema> allDefinitions)
DefaultCodegenfromModel 在接口中 CodegenConfigfromModel 在类中 DefaultCodegenname - the name of the modelmodel - OAS Model objectallDefinitions - a map of all OAS models from the specpublic void postProcessModelProperty(CodegenModel model, CodegenProperty property)
postProcessModelProperty 在接口中 CodegenConfigpostProcessModelProperty 在类中 DefaultCodegenpublic void postProcessParameter(CodegenParameter parameter)
postProcessParameter 在接口中 CodegenConfigpostProcessParameter 在类中 DefaultCodegenpublic Map<String,Object> postProcessModels(Map<String,Object> objs)
postProcessModels 在接口中 CodegenConfigpostProcessModels 在类中 DefaultCodegenpublic Map<String,Object> postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)
public void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
preprocessOpenAPI 在接口中 CodegenConfigpreprocessOpenAPI 在类中 DefaultCodegenprotected static String getAccept(io.swagger.v3.oas.models.OpenAPI openAPI, io.swagger.v3.oas.models.Operation operation)
protected boolean needToImport(String type)
DefaultCodegenneedToImport 在类中 DefaultCodegentype - name of the typepublic String toEnumName(CodegenProperty property)
DefaultCodegentoEnumName 在类中 DefaultCodegenproperty - Codegen propertypublic String toEnumVarName(String value, String datatype)
DefaultCodegentoEnumVarName 在类中 DefaultCodegenvalue - enum variable namedatatype - data typepublic String toEnumValue(String value, String datatype)
DefaultCodegentoEnumValue 在类中 DefaultCodegenvalue - enum variable namedatatype - data typepublic CodegenOperation fromOperation(String path, String httpMethod, io.swagger.v3.oas.models.Operation operation, Map<String,io.swagger.v3.oas.models.media.Schema> definitions, io.swagger.v3.oas.models.OpenAPI openAPI)
DefaultCodegenfromOperation 在接口中 CodegenConfigfromOperation 在类中 DefaultCodegenpath - the path of the operationhttpMethod - HTTP methodoperation - OAS operation objectdefinitions - a map of OAS modelsopenAPI - a OAS 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 setSupportAsync(boolean enabled)
public void setDisableHtmlEscaping(boolean disabled)
public void setBooleanGetterPrefix(String booleanGetterPrefix)
public void setUseNullForUnknownEnumValue(boolean useNullForUnknownEnumValue)
public String escapeQuotationMark(String input)
DefaultCodegenescapeQuotationMark 在接口中 CodegenConfigescapeQuotationMark 在类中 DefaultCodegeninput - String to be cleaned uppublic String escapeUnsafeCharacters(String input)
DefaultCodegenescapeUnsafeCharacters 在接口中 CodegenConfigescapeUnsafeCharacters 在类中 DefaultCodegeninput - String to be cleaned uppublic void setSupportJava6(boolean value)
public String toRegularExpression(String pattern)
DefaultCodegentoRegularExpression 在类中 DefaultCodegenpattern - the pattern (regular expression)public boolean convertPropertyToBoolean(String propertyKey)
public void writePropertyBack(String propertyKey, boolean value)
writePropertyBack 在类中 DefaultCodegenpublic String toBooleanGetter(String name)
toBooleanGetter 在接口中 CodegenConfigtoBooleanGetter 在类中 DefaultCodegenname - the name of the propertypublic String sanitizeTag(String tag)
DefaultCodegensanitizeTag 在接口中 CodegenConfigsanitizeTag 在类中 DefaultCodegentag - Tagpublic void postProcessFile(File file, String fileType)
DefaultCodegenTODO: store these values in enum instead
postProcessFile 在接口中 CodegenConfigpostProcessFile 在类中 DefaultCodegenfile - file to be processedfileType - file typepublic void setParentGroupId(String parentGroupId)
public void setParentArtifactId(String parentArtifactId)
public void setParentVersion(String parentVersion)
public void setParentOverridden(boolean parentOverridden)
Copyright © 2019. All rights reserved.