Class AbstractJavaCodegen
- java.lang.Object
-
- io.swagger.codegen.v3.generators.DefaultCodegenConfig
-
- io.swagger.codegen.v3.generators.java.AbstractJavaCodegen
-
- All Implemented Interfaces:
io.swagger.codegen.v3.CodegenConfig
- Direct Known Subclasses:
AbstractJavaJAXRSServerCodegen,JavaClientCodegen,JavaCXFClientCodegen,JavaInflectorServerCodegen,JavaVertXServerCodegen,MicronautCodegen,SpringCodegen
public abstract class AbstractJavaCodegen extends DefaultCodegenConfig
-
-
Field Summary
-
Fields inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig
additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, configFiles, customTemplateDir, DEFAULT_CONTENT_TYPE, DEFAULT_TEMPLATE_DIR, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoBaseURL, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, ignoreImportMapping, importMapping, inputSpec, inputURL, instantiationTypes, IS_NULLABLE_FALSE, IS_NULLABLE_TRUE, 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 Summary
Constructors Constructor Description AbstractJavaCodegen()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidaddAdditionPropertiesToCodeGenModel(io.swagger.codegen.v3.CodegenModel codegenModel, io.swagger.v3.oas.models.media.Schema schema)voidaddHandlebarHelpers(com.github.jknack.handlebars.Handlebars handlebars)StringapiDocFileFolder()StringapiFileFolder()StringapiTestFileFolder()StringcamelizeVarName(String word, boolean lowercaseFirstLetter)booleancheckAliasModel()protected voidcheckDuplicatedModelNameIgnoringCase(io.swagger.v3.oas.models.OpenAPI openAPI)booleanconvertPropertyToBoolean(String propertyKey)StringescapeQuotationMark(String input)Escape single and/or double quote to avoid code injectionStringescapeReservedWord(String name)Return the escaped name of the reserved wordprotected StringescapeUnderscore(String name)StringescapeUnsafeCharacters(String input)override with any special text escaping logic to handle unsafe characters so as to avoid code injectionprotected voidfixUpParentAndInterfaces(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.CodegenModelfromModel(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 objectio.swagger.codegen.v3.CodegenOperationfromOperation(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 objectStringgetAlias(String name)Determine the type alias for the given type if it exists.StringgetSchemaType(io.swagger.v3.oas.models.media.Schema schema)returns the swagger type for the propertyStringgetTypeDeclaration(io.swagger.v3.oas.models.media.Schema propertySchema)Output the type declaration of the propertyprotected static booleanisSameEnum(io.swagger.codegen.v3.CodegenProperty actual, io.swagger.codegen.v3.CodegenProperty other)StringmodelDocFileFolder()StringmodelFileFolder()protected booleanneedToImport(String type)Check the type to see if it needs import the library/module/packagevoidpostProcessModelProperty(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)voidpostProcessParameter(io.swagger.codegen.v3.CodegenParameter parameter)voidpreprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)voidprocessOpts()protected voidreplaceDuplicatedInModelProperties(Map<String,io.swagger.v3.oas.models.media.Schema> definitions, String modelName, String newModelName)protected voidreplaceDuplicatedInPaths(io.swagger.v3.oas.models.Paths paths, String modelName, String newModelName)StringsanitizeTag(String tag)Sanitize tagStringsanitizeVarName(String name)voidsetArtifactDescription(String artifactDescription)voidsetArtifactId(String artifactId)voidsetArtifactUrl(String artifactUrl)voidsetArtifactVersion(String artifactVersion)voidsetDateLibrary(String library)voidsetDeveloperEmail(String developerEmail)voidsetDeveloperName(String developerName)voidsetDeveloperOrganization(String developerOrganization)voidsetDeveloperOrganizationUrl(String developerOrganizationUrl)voidsetFullJavaUtil(boolean fullJavaUtil)voidsetGroupId(String groupId)voidsetInvokerPackage(String invokerPackage)voidsetJakarta(boolean jakarta)voidsetJava11Mode(boolean java11Mode)voidsetJava8Mode(boolean enabled)voidsetLanguageArguments(List<io.swagger.codegen.v3.CodegenArgument> languageArguments)voidsetLicenseName(String licenseName)voidsetLicenseUrl(String licenseUrl)voidsetLocalVariablePrefix(String localVariablePrefix)voidsetParameterExampleValue(io.swagger.codegen.v3.CodegenParameter p)Return the example value of the parameter.voidsetScmConnection(String scmConnection)voidsetScmDeveloperConnection(String scmDeveloperConnection)voidsetScmUrl(String scmUrl)voidsetSerializableModel(Boolean serializableModel)voidsetSerializeBigDecimalAsString(boolean s)voidsetSourceFolder(String sourceFolder)voidsetSupportJava6(boolean value)voidsetTestFolder(String testFolder)voidsetUseNullableForNotnull(Boolean useNullableForNotNull)voidsetWithXml(boolean withXml)StringtoApiDocFilename(String name)Return the file name of the Api DocumentationStringtoApiFilename(String name)Return the file name of the Api TestStringtoApiName(String name)Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is emptyStringtoApiTestFilename(String name)Return the file name of the Api TestStringtoBooleanGetter(String name)Output the Getter name for boolean property, e.g.StringtoDefaultValue(io.swagger.v3.oas.models.media.Schema schema)Return the default value of the propertyStringtoEnumName(io.swagger.codegen.v3.CodegenProperty property)Return the Enum name (e.g.StringtoEnumValue(String value, String datatype)Return the enum value in the language specified format e.g.StringtoEnumVarName(String value, String datatype)Return the sanitized variable name for enumStringtoExampleValue(io.swagger.v3.oas.models.media.Schema schemaProperty)Return the example value of the propertyStringtoModelDocFilename(String name)Return the capitalized file name of the model documentationStringtoModelFilename(String name)Return the capitalized file name of the modelStringtoModelName(String name)Output the proper model name (capitalized).StringtoOperationId(String operationId)Return the operation ID (method name)StringtoParamName(String name)Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.StringtoRegularExpression(String pattern)Return the regular expression/JSON schema pattern (http://json-schema.org/latest/json-schema-validation.html#anchor33)StringtoVarName(String name)Return the variable name by removing invalid characters and proper escaping if it's a reserved word.voidwritePropertyBack(String propertyKey, boolean value)-
Methods inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig
addCodegenContentParameters, addConsumesInfo, addImport, additionalProperties, addOperationImports, addOperationToGroup, addOption, addOption, addParameters, addParentContainer, addProducesInfo, addProperties, addRegularExpressionDelimiter, addSwitch, addVars, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, configFiles, configureDataForTestTemplate, configuresParameterForMediaType, convertPropertyToBooleanAndWriteBack, copyFirstAllOfProperties, customTemplateDir, dashize, defaultIgnoreImportMappingOption, defaultIncludes, detectParent, embeddedTemplateDir, ensureUniqueParameters, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromModel, fromOperation, fromParameter, fromProperty, fromRequestBody, fromResponse, fromSecurity, generateExamplePath, getArgumentsLocation, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getDefaultTemplateDir, getGitRepoBaseURL, 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, isFileTypeSchema, isObjectSchema, isPrimivite, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needsUnflattenedSpec, outputFolder, postProcessAllCodegenModels, postProcessAllModels, postProcessModelsEnum, postProcessOperationsWithModels, postProcessSupportingFileData, processCompiler, processMapSchema, processModelEnums, processOpenAPI, processPropertySchemaContainerTypes, processPropertySchemaTypes, readLanguageArguments, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoBaseURL, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setIgnoreImportMapping, setInputSpec, setInputURL, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterJson, setParameterNullable, setReleaseNote, setRemoveOperationIdPrefix, setReservedWords, setReservedWordsLowerCase, setSchemaProperties, 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, writeOptional
-
-
-
-
Field Detail
-
FULL_JAVA_UTIL
public static final String FULL_JAVA_UTIL
- See Also:
- Constant Field Values
-
DEFAULT_LIBRARY
public static final String DEFAULT_LIBRARY
- See Also:
- Constant Field Values
-
DATE_LIBRARY
public static final String DATE_LIBRARY
- See Also:
- Constant Field Values
-
JAVA8_MODE
public static final String JAVA8_MODE
- See Also:
- Constant Field Values
-
JAVA11_MODE
public static final String JAVA11_MODE
- See Also:
- Constant Field Values
-
WITH_XML
public static final String WITH_XML
- See Also:
- Constant Field Values
-
SUPPORT_JAVA6
public static final String SUPPORT_JAVA6
- See Also:
- Constant Field Values
-
ERROR_ON_UNKNOWN_ENUM
public static final String ERROR_ON_UNKNOWN_ENUM
- See Also:
- Constant Field Values
-
CHECK_DUPLICATED_MODEL_NAME
public static final String CHECK_DUPLICATED_MODEL_NAME
- See Also:
- Constant Field Values
-
USE_NULLABLE_FOR_NOTNULL
public static final String USE_NULLABLE_FOR_NOTNULL
- See Also:
- Constant Field Values
-
WIREMOCK_OPTION
public static final String WIREMOCK_OPTION
- See Also:
- Constant Field Values
-
JAKARTA
public static final String JAKARTA
- See Also:
- Constant Field Values
-
dateLibrary
protected String dateLibrary
-
java8Mode
protected boolean java8Mode
-
java11Mode
protected boolean java11Mode
-
withXml
protected boolean withXml
-
invokerPackage
protected String invokerPackage
-
groupId
protected String groupId
-
artifactId
protected String artifactId
-
artifactVersion
protected String artifactVersion
-
artifactUrl
protected String artifactUrl
-
artifactDescription
protected String artifactDescription
-
developerName
protected String developerName
-
developerEmail
protected String developerEmail
-
developerOrganization
protected String developerOrganization
-
developerOrganizationUrl
protected String developerOrganizationUrl
-
scmConnection
protected String scmConnection
-
scmDeveloperConnection
protected String scmDeveloperConnection
-
scmUrl
protected String scmUrl
-
licenseName
protected String licenseName
-
licenseUrl
protected String licenseUrl
-
projectFolder
protected String projectFolder
-
projectTestFolder
protected String projectTestFolder
-
sourceFolder
protected String sourceFolder
-
testFolder
protected String testFolder
-
localVariablePrefix
protected String localVariablePrefix
-
fullJavaUtil
protected boolean fullJavaUtil
-
javaUtilPrefix
protected String javaUtilPrefix
-
serializableModel
protected Boolean serializableModel
-
serializeBigDecimalAsString
protected boolean serializeBigDecimalAsString
-
apiDocPath
protected String apiDocPath
-
modelDocPath
protected String modelDocPath
-
supportJava6
protected boolean supportJava6
-
jakarta
protected boolean jakarta
-
useNullableForNotNull
protected boolean useNullableForNotNull
-
-
Method Detail
-
processOpts
public void processOpts()
- Specified by:
processOptsin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
processOptsin classDefaultCodegenConfig
-
escapeReservedWord
public String escapeReservedWord(String name)
Description copied from class:DefaultCodegenConfigReturn the escaped name of the reserved word- Specified by:
escapeReservedWordin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
escapeReservedWordin classDefaultCodegenConfig- Parameters:
name- the name to be escaped- Returns:
- the escaped reserved word throws Runtime exception as reserved word is not allowed (default behavior)
-
apiFileFolder
public String apiFileFolder()
- Specified by:
apiFileFolderin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
apiFileFolderin classDefaultCodegenConfig
-
apiTestFileFolder
public String apiTestFileFolder()
- Specified by:
apiTestFileFolderin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
apiTestFileFolderin classDefaultCodegenConfig
-
modelFileFolder
public String modelFileFolder()
- Specified by:
modelFileFolderin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
modelFileFolderin classDefaultCodegenConfig
-
apiDocFileFolder
public String apiDocFileFolder()
- Specified by:
apiDocFileFolderin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
apiDocFileFolderin classDefaultCodegenConfig
-
modelDocFileFolder
public String modelDocFileFolder()
- Specified by:
modelDocFileFolderin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
modelDocFileFolderin classDefaultCodegenConfig
-
toApiDocFilename
public String toApiDocFilename(String name)
Description copied from class:DefaultCodegenConfigReturn the file name of the Api Documentation- Specified by:
toApiDocFilenamein interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
toApiDocFilenamein classDefaultCodegenConfig- Parameters:
name- the file name of the Api- Returns:
- the file name of the Api
-
toModelDocFilename
public String toModelDocFilename(String name)
Description copied from class:DefaultCodegenConfigReturn the capitalized file name of the model documentation- Specified by:
toModelDocFilenamein interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
toModelDocFilenamein classDefaultCodegenConfig- Parameters:
name- the model name- Returns:
- the file name of the model
-
toApiTestFilename
public String toApiTestFilename(String name)
Description copied from class:DefaultCodegenConfigReturn the file name of the Api Test- Specified by:
toApiTestFilenamein interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
toApiTestFilenamein classDefaultCodegenConfig- Parameters:
name- the file name of the Api- Returns:
- the file name of the Api
-
toApiName
public String toApiName(String name)
Description copied from class:DefaultCodegenConfigOutput the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty- Specified by:
toApiNamein interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
toApiNamein classDefaultCodegenConfig- Parameters:
name- the name of the Api- Returns:
- capitalized Api name ending with "Api"
-
toApiFilename
public String toApiFilename(String name)
Description copied from class:DefaultCodegenConfigReturn the file name of the Api Test- Specified by:
toApiFilenamein interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
toApiFilenamein classDefaultCodegenConfig- Parameters:
name- the file name of the Api- Returns:
- the file name of the Api
-
toVarName
public String toVarName(String name)
Description copied from class:DefaultCodegenConfigReturn the variable name by removing invalid characters and proper escaping if it's a reserved word.- Overrides:
toVarNamein classDefaultCodegenConfig- Parameters:
name- the variable name- Returns:
- the sanitized variable name
-
toParamName
public String toParamName(String name)
Description copied from class:DefaultCodegenConfigReturn the parameter name by removing invalid characters and proper escaping if it's a reserved word.- Specified by:
toParamNamein interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
toParamNamein classDefaultCodegenConfig- Parameters:
name- Codegen property object- Returns:
- the sanitized parameter name
-
toModelName
public String toModelName(String name)
Description copied from class:DefaultCodegenConfigOutput the proper model name (capitalized). In case the name belongs to the TypeSystem it won't be renamed.- Specified by:
toModelNamein interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
toModelNamein classDefaultCodegenConfig- Parameters:
name- the name of the model- Returns:
- capitalized model name
-
toModelFilename
public String toModelFilename(String name)
Description copied from class:DefaultCodegenConfigReturn the capitalized file name of the model- Specified by:
toModelFilenamein interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
toModelFilenamein classDefaultCodegenConfig- Parameters:
name- the model name- Returns:
- the file name of the model
-
getTypeDeclaration
public String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema propertySchema)
Description copied from class:DefaultCodegenConfigOutput the type declaration of the property- Specified by:
getTypeDeclarationin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
getTypeDeclarationin classDefaultCodegenConfig- Parameters:
propertySchema- Schema Property object- Returns:
- a string presentation of the property type
-
getAlias
public String getAlias(String name)
Description copied from class:DefaultCodegenConfigDetermine the type alias for the given type if it exists. This feature is only used for Java, because the language does not have a aliasing mechanism of its own.- Overrides:
getAliasin classDefaultCodegenConfig- Parameters:
name- The type name.- Returns:
- The alias of the given type, if it exists. If there is no alias for this type, then returns the input type name.
-
toDefaultValue
public String toDefaultValue(io.swagger.v3.oas.models.media.Schema schema)
Description copied from class:DefaultCodegenConfigReturn the default value of the property- Overrides:
toDefaultValuein classDefaultCodegenConfig- Parameters:
schema- Schema property object- Returns:
- string presentation of the default value of the property
-
setParameterExampleValue
public void setParameterExampleValue(io.swagger.codegen.v3.CodegenParameter p)
Description copied from class:DefaultCodegenConfigReturn the example value of the parameter.- Overrides:
setParameterExampleValuein classDefaultCodegenConfig- Parameters:
p- Swagger property object
-
toExampleValue
public String toExampleValue(io.swagger.v3.oas.models.media.Schema schemaProperty)
Description copied from class:DefaultCodegenConfigReturn the example value of the property- Overrides:
toExampleValuein classDefaultCodegenConfig- Parameters:
schemaProperty- Schema property object- Returns:
- string presentation of the example value of the property
-
getSchemaType
public String getSchemaType(io.swagger.v3.oas.models.media.Schema schema)
Description copied from class:DefaultCodegenConfigreturns the swagger type for the property- Overrides:
getSchemaTypein classDefaultCodegenConfig- Parameters:
schema- Schema property object- Returns:
- string presentation of the type
-
toOperationId
public String toOperationId(String operationId)
Description copied from class:DefaultCodegenConfigReturn the operation ID (method name)- Overrides:
toOperationIdin classDefaultCodegenConfig- Parameters:
operationId- operation ID- Returns:
- the sanitized method name
-
fromModel
public 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)
Description copied from class:DefaultCodegenConfigConvert Swagger Model object to Codegen Model object- Specified by:
fromModelin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
fromModelin classDefaultCodegenConfig- Parameters:
name- the name of the modelschema- Swagger Model objectallSchemas- a map of all Swagger models from the spec- Returns:
- Codegen Model object
-
addAdditionPropertiesToCodeGenModel
protected void addAdditionPropertiesToCodeGenModel(io.swagger.codegen.v3.CodegenModel codegenModel, io.swagger.v3.oas.models.media.Schema schema)- Overrides:
addAdditionPropertiesToCodeGenModelin classDefaultCodegenConfig
-
postProcessModelProperty
public void postProcessModelProperty(io.swagger.codegen.v3.CodegenModel model, io.swagger.codegen.v3.CodegenProperty property)- Specified by:
postProcessModelPropertyin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
postProcessModelPropertyin classDefaultCodegenConfig
-
fixUpParentAndInterfaces
protected void fixUpParentAndInterfaces(io.swagger.codegen.v3.CodegenModel codegenModel, Map<String,io.swagger.codegen.v3.CodegenModel> allModels)Description copied from class:DefaultCodegenConfigFix up all parent and interface CodegenModel references.- Overrides:
fixUpParentAndInterfacesin classDefaultCodegenConfig
-
postProcessParameter
public void postProcessParameter(io.swagger.codegen.v3.CodegenParameter parameter)
- Specified by:
postProcessParameterin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
postProcessParameterin classDefaultCodegenConfig
-
postProcessModels
public Map<String,Object> postProcessModels(Map<String,Object> objs)
- Specified by:
postProcessModelsin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
postProcessModelsin classDefaultCodegenConfig
-
postProcessOperations
public Map<String,Object> postProcessOperations(Map<String,Object> objs)
- Specified by:
postProcessOperationsin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
postProcessOperationsin classDefaultCodegenConfig
-
preprocessOpenAPI
public void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
- Specified by:
preprocessOpenAPIin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
preprocessOpenAPIin classDefaultCodegenConfig
-
needToImport
protected boolean needToImport(String type)
Description copied from class:DefaultCodegenConfigCheck the type to see if it needs import the library/module/package- Overrides:
needToImportin classDefaultCodegenConfig- Parameters:
type- name of the type- Returns:
- true if the library/module/package of the corresponding type needs to be imported
-
checkDuplicatedModelNameIgnoringCase
protected void checkDuplicatedModelNameIgnoringCase(io.swagger.v3.oas.models.OpenAPI openAPI)
-
replaceDuplicatedInPaths
protected void replaceDuplicatedInPaths(io.swagger.v3.oas.models.Paths paths, String modelName, String newModelName)
-
replaceDuplicatedInModelProperties
protected void replaceDuplicatedInModelProperties(Map<String,io.swagger.v3.oas.models.media.Schema> definitions, String modelName, String newModelName)
-
toEnumName
public String toEnumName(io.swagger.codegen.v3.CodegenProperty property)
Description copied from class:DefaultCodegenConfigReturn the Enum name (e.g. StatusEnum given 'status')- Overrides:
toEnumNamein classDefaultCodegenConfig- Parameters:
property- Codegen property- Returns:
- the Enum name
-
toEnumVarName
public String toEnumVarName(String value, String datatype)
Description copied from class:DefaultCodegenConfigReturn the sanitized variable name for enum- Overrides:
toEnumVarNamein classDefaultCodegenConfig- Parameters:
value- enum variable namedatatype- data type- Returns:
- the sanitized variable name for enum
-
toEnumValue
public String toEnumValue(String value, String datatype)
Description copied from class:DefaultCodegenConfigReturn the enum value in the language specified format e.g. status becomes "status"- Overrides:
toEnumValuein classDefaultCodegenConfig- Parameters:
value- enum variable namedatatype- data type- Returns:
- the sanitized value for enum
-
fromOperation
public 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)
Description copied from class:DefaultCodegenConfigConvert Swagger Operation object to Codegen Operation object- Specified by:
fromOperationin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
fromOperationin classDefaultCodegenConfig- Parameters:
path- the path of the operationhttpMethod- HTTP methodoperation- Swagger operation objectschemas- a map of schemasopenAPI- a OpenAPI object representing the spec- Returns:
- Codegen Operation object
-
isSameEnum
protected static boolean isSameEnum(io.swagger.codegen.v3.CodegenProperty actual, io.swagger.codegen.v3.CodegenProperty other)
-
setInvokerPackage
public void setInvokerPackage(String invokerPackage)
-
setGroupId
public void setGroupId(String groupId)
-
setArtifactId
public void setArtifactId(String artifactId)
-
setArtifactVersion
public void setArtifactVersion(String artifactVersion)
-
setArtifactUrl
public void setArtifactUrl(String artifactUrl)
-
setArtifactDescription
public void setArtifactDescription(String artifactDescription)
-
setScmConnection
public void setScmConnection(String scmConnection)
-
setScmDeveloperConnection
public void setScmDeveloperConnection(String scmDeveloperConnection)
-
setScmUrl
public void setScmUrl(String scmUrl)
-
setUseNullableForNotnull
public void setUseNullableForNotnull(Boolean useNullableForNotNull)
-
setDeveloperName
public void setDeveloperName(String developerName)
-
setDeveloperEmail
public void setDeveloperEmail(String developerEmail)
-
setDeveloperOrganization
public void setDeveloperOrganization(String developerOrganization)
-
setDeveloperOrganizationUrl
public void setDeveloperOrganizationUrl(String developerOrganizationUrl)
-
setLicenseName
public void setLicenseName(String licenseName)
-
setLicenseUrl
public void setLicenseUrl(String licenseUrl)
-
setSourceFolder
public void setSourceFolder(String sourceFolder)
-
setTestFolder
public void setTestFolder(String testFolder)
-
setLocalVariablePrefix
public void setLocalVariablePrefix(String localVariablePrefix)
-
setSerializeBigDecimalAsString
public void setSerializeBigDecimalAsString(boolean s)
-
setSerializableModel
public void setSerializableModel(Boolean serializableModel)
-
setFullJavaUtil
public void setFullJavaUtil(boolean fullJavaUtil)
-
setWithXml
public void setWithXml(boolean withXml)
-
setDateLibrary
public void setDateLibrary(String library)
-
setJava8Mode
public void setJava8Mode(boolean enabled)
-
setJava11Mode
public void setJava11Mode(boolean java11Mode)
-
setJakarta
public void setJakarta(boolean jakarta)
-
escapeQuotationMark
public String escapeQuotationMark(String input)
Description copied from class:DefaultCodegenConfigEscape single and/or double quote to avoid code injection- Specified by:
escapeQuotationMarkin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
escapeQuotationMarkin classDefaultCodegenConfig- Parameters:
input- String to be cleaned up- Returns:
- string with quotation mark removed or escaped
-
escapeUnsafeCharacters
public String escapeUnsafeCharacters(String input)
Description copied from class:DefaultCodegenConfigoverride with any special text escaping logic to handle unsafe characters so as to avoid code injection- Specified by:
escapeUnsafeCharactersin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
escapeUnsafeCharactersin classDefaultCodegenConfig- Parameters:
input- String to be cleaned up- Returns:
- string with unsafe characters removed or escaped
-
setSupportJava6
public void setSupportJava6(boolean value)
-
toRegularExpression
public String toRegularExpression(String pattern)
Description copied from class:DefaultCodegenConfigReturn the regular expression/JSON schema pattern (http://json-schema.org/latest/json-schema-validation.html#anchor33)- Overrides:
toRegularExpressionin classDefaultCodegenConfig- Parameters:
pattern- the pattern (regular expression)- Returns:
- properly-escaped pattern
-
convertPropertyToBoolean
public boolean convertPropertyToBoolean(String propertyKey)
- Overrides:
convertPropertyToBooleanin classDefaultCodegenConfig
-
writePropertyBack
public void writePropertyBack(String propertyKey, boolean value)
- Overrides:
writePropertyBackin classDefaultCodegenConfig
-
toBooleanGetter
public String toBooleanGetter(String name)
Output the Getter name for boolean property, e.g. isActive- Specified by:
toBooleanGetterin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
toBooleanGetterin classDefaultCodegenConfig- Parameters:
name- the name of the property- Returns:
- getter name based on naming convention
-
sanitizeTag
public String sanitizeTag(String tag)
Description copied from class:DefaultCodegenConfigSanitize tag- Specified by:
sanitizeTagin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
sanitizeTagin classDefaultCodegenConfig- Parameters:
tag- Tag- Returns:
- Sanitized tag
-
addHandlebarHelpers
public void addHandlebarHelpers(com.github.jknack.handlebars.Handlebars handlebars)
- Specified by:
addHandlebarHelpersin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
addHandlebarHelpersin classDefaultCodegenConfig
-
setLanguageArguments
public void setLanguageArguments(List<io.swagger.codegen.v3.CodegenArgument> languageArguments)
- Specified by:
setLanguageArgumentsin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
setLanguageArgumentsin classDefaultCodegenConfig
-
checkAliasModel
public boolean checkAliasModel()
-
-