public abstract class AbstractJavaCodegen extends DefaultCodegenConfig
additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, DEFAULT_CONTENT_TYPE, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoId, gitUserId, httpUserAgent, ignoreFilePathOverride, importMapping, inputSpec, instantiationTypes, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, releaseNote, removeOperationIdPrefix, REQUEST_BODY_NAME, reservedWords, reservedWordsMappings, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, templateDir, testPackage, typeAliases, typeMapping, vendorExtensions| Constructor and Description |
|---|
AbstractJavaCodegen() |
| Modifier and Type | Method and Description |
|---|---|
void |
addHandlebarHelpers(com.github.jknack.handlebars.Handlebars handlebars) |
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
|
io.swagger.codegen.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.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
|
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.CodegenModel model,
io.swagger.codegen.CodegenProperty property) |
Map<String,Object> |
postProcessModels(Map<String,Object> objs) |
Map<String,Object> |
postProcessOperations(Map<String,Object> objs) |
void |
postProcessParameter(io.swagger.codegen.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 |
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 |
setLicenseName(String licenseName) |
void |
setLicenseUrl(String licenseUrl) |
void |
setLocalVariablePrefix(String localVariablePrefix) |
void |
setParameterExampleValue(io.swagger.codegen.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.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) |
addAdditionPropertiesToCodeGenModel, addConsumesInfo, addImport, additionalProperties, addOperationToGroup, addProducesInfo, addProperties, addRegularExpressionDelimiter, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, detectParent, embeddedTemplateDir, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromModel, fromOperation, fromParameter, fromProperty, fromRequestBody, fromResponse, fromSecurity, generateExamplePath, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getOrGenerateOperationId, getOutputDir, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSchemaFromBody, getSchemaFromResponse, getSimpleRef, getSymbolName, getterAndSetterCapitalize, getTypeDeclaration, importMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelsEnum, postProcessOperationsWithModels, postProcessSupportingFileData, processCompiler, processModelEnums, processOpenAPI, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoId, setGitUserId, 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, writeOptionalpublic 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
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 boolean hideGenerationTimestamp
protected String apiDocPath
protected String modelDocPath
protected boolean supportJava6
public void processOpts()
processOpts in interface io.swagger.codegen.CodegenConfigprocessOpts in class DefaultCodegenConfigpublic String escapeReservedWord(String name)
DefaultCodegenConfigescapeReservedWord in interface io.swagger.codegen.CodegenConfigescapeReservedWord in class DefaultCodegenConfigname - the name to be escapedpublic String apiFileFolder()
apiFileFolder in interface io.swagger.codegen.CodegenConfigapiFileFolder in class DefaultCodegenConfigpublic String apiTestFileFolder()
apiTestFileFolder in interface io.swagger.codegen.CodegenConfigapiTestFileFolder in class DefaultCodegenConfigpublic String modelFileFolder()
modelFileFolder in interface io.swagger.codegen.CodegenConfigmodelFileFolder in class DefaultCodegenConfigpublic String apiDocFileFolder()
apiDocFileFolder in interface io.swagger.codegen.CodegenConfigapiDocFileFolder in class DefaultCodegenConfigpublic String modelDocFileFolder()
modelDocFileFolder in interface io.swagger.codegen.CodegenConfigmodelDocFileFolder in class DefaultCodegenConfigpublic String toApiDocFilename(String name)
DefaultCodegenConfigtoApiDocFilename in interface io.swagger.codegen.CodegenConfigtoApiDocFilename in class DefaultCodegenConfigname - the file name of the Apipublic String toModelDocFilename(String name)
DefaultCodegenConfigtoModelDocFilename in interface io.swagger.codegen.CodegenConfigtoModelDocFilename in class DefaultCodegenConfigname - the model namepublic String toApiTestFilename(String name)
DefaultCodegenConfigtoApiTestFilename in interface io.swagger.codegen.CodegenConfigtoApiTestFilename in class DefaultCodegenConfigname - the file name of the Apipublic String toApiName(String name)
DefaultCodegenConfigtoApiName in interface io.swagger.codegen.CodegenConfigtoApiName in class DefaultCodegenConfigname - the name of the Apipublic String toApiFilename(String name)
DefaultCodegenConfigtoApiFilename in interface io.swagger.codegen.CodegenConfigtoApiFilename in class DefaultCodegenConfigname - the file name of the Apipublic String toVarName(String name)
DefaultCodegenConfigtoVarName in class DefaultCodegenConfigname - the variable namepublic String toParamName(String name)
DefaultCodegenConfigtoParamName in interface io.swagger.codegen.CodegenConfigtoParamName in class DefaultCodegenConfigname - Codegen property objectpublic String toModelName(String name)
DefaultCodegenConfigtoModelName in interface io.swagger.codegen.CodegenConfigtoModelName in class DefaultCodegenConfigname - the name of the modelpublic String toModelFilename(String name)
DefaultCodegenConfigtoModelFilename in interface io.swagger.codegen.CodegenConfigtoModelFilename in class DefaultCodegenConfigname - the model namepublic String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema propertySchema)
DefaultCodegenConfiggetTypeDeclaration in interface io.swagger.codegen.CodegenConfiggetTypeDeclaration in class DefaultCodegenConfigpropertySchema - Schema Property objectpublic String getAlias(String name)
DefaultCodegenConfiggetAlias in class DefaultCodegenConfigname - The type name.public String toDefaultValue(io.swagger.v3.oas.models.media.Schema schema)
DefaultCodegenConfigtoDefaultValue in class DefaultCodegenConfigschema - Schema property objectpublic void setParameterExampleValue(io.swagger.codegen.CodegenParameter p)
DefaultCodegenConfigsetParameterExampleValue in class DefaultCodegenConfigp - Swagger property objectpublic String toExampleValue(io.swagger.v3.oas.models.media.Schema schemaProperty)
DefaultCodegenConfigtoExampleValue in class DefaultCodegenConfigschemaProperty - Schema property objectpublic String getSchemaType(io.swagger.v3.oas.models.media.Schema schema)
DefaultCodegenConfiggetSchemaType in class DefaultCodegenConfigschema - Schema property objectpublic String toOperationId(String operationId)
DefaultCodegenConfigtoOperationId in class DefaultCodegenConfigoperationId - operation IDpublic io.swagger.codegen.CodegenModel fromModel(String name, io.swagger.v3.oas.models.media.Schema schema, Map<String,io.swagger.v3.oas.models.media.Schema> allSchemas)
DefaultCodegenConfigfromModel in interface io.swagger.codegen.CodegenConfigfromModel in class DefaultCodegenConfigname - the name of the modelschema - Swagger Model objectallSchemas - a map of all Swagger models from the specpublic void postProcessModelProperty(io.swagger.codegen.CodegenModel model,
io.swagger.codegen.CodegenProperty property)
postProcessModelProperty in interface io.swagger.codegen.CodegenConfigpostProcessModelProperty in class DefaultCodegenConfigpublic void postProcessParameter(io.swagger.codegen.CodegenParameter parameter)
postProcessParameter in interface io.swagger.codegen.CodegenConfigpostProcessParameter in class DefaultCodegenConfigpublic Map<String,Object> postProcessModels(Map<String,Object> objs)
postProcessModels in interface io.swagger.codegen.CodegenConfigpostProcessModels in class DefaultCodegenConfigpublic Map<String,Object> postProcessOperations(Map<String,Object> objs)
postProcessOperations in interface io.swagger.codegen.CodegenConfigpostProcessOperations in class DefaultCodegenConfigpublic void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
preprocessOpenAPI in interface io.swagger.codegen.CodegenConfigpreprocessOpenAPI in class DefaultCodegenConfigprotected boolean needToImport(String type)
DefaultCodegenConfigneedToImport in class DefaultCodegenConfigtype - name of the typepublic String toEnumName(io.swagger.codegen.CodegenProperty property)
DefaultCodegenConfigtoEnumName in class DefaultCodegenConfigproperty - Codegen propertypublic String toEnumVarName(String value, String datatype)
DefaultCodegenConfigtoEnumVarName in class DefaultCodegenConfigvalue - enum variable namedatatype - data typepublic String toEnumValue(String value, String datatype)
DefaultCodegenConfigtoEnumValue in class DefaultCodegenConfigvalue - enum variable namedatatype - data typepublic io.swagger.codegen.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)
DefaultCodegenConfigfromOperation in interface io.swagger.codegen.CodegenConfigfromOperation in class DefaultCodegenConfigpath - the path of the operationhttpMethod - HTTP methodoperation - Swagger operation objectschemas - a map of schemasopenAPI - a OpenAPI object representing the specpublic 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)
DefaultCodegenConfigescapeQuotationMark in interface io.swagger.codegen.CodegenConfigescapeQuotationMark in class DefaultCodegenConfiginput - String to be cleaned uppublic String escapeUnsafeCharacters(String input)
DefaultCodegenConfigescapeUnsafeCharacters in interface io.swagger.codegen.CodegenConfigescapeUnsafeCharacters in class DefaultCodegenConfiginput - String to be cleaned uppublic void setSupportJava6(boolean value)
public String toRegularExpression(String pattern)
DefaultCodegenConfigtoRegularExpression in class DefaultCodegenConfigpattern - the pattern (regular expression)public boolean convertPropertyToBoolean(String propertyKey)
convertPropertyToBoolean in class DefaultCodegenConfigpublic void writePropertyBack(String propertyKey, boolean value)
writePropertyBack in class DefaultCodegenConfigpublic String toBooleanGetter(String name)
toBooleanGetter in interface io.swagger.codegen.CodegenConfigtoBooleanGetter in class DefaultCodegenConfigname - the name of the propertypublic String sanitizeTag(String tag)
DefaultCodegenConfigsanitizeTag in interface io.swagger.codegen.CodegenConfigsanitizeTag in class DefaultCodegenConfigtag - Tagpublic void addHandlebarHelpers(com.github.jknack.handlebars.Handlebars handlebars)
addHandlebarHelpers in interface io.swagger.codegen.CodegenConfigaddHandlebarHelpers in class DefaultCodegenConfigCopyright © 2018. All rights reserved.