AbstractAdaCodegen (openapi-generator (core library) 3.3.4.2 API)

java.lang.Object
- org.openapitools.codegen.DefaultCodegen
- - org.openapitools.codegen.languages.AbstractAdaCodegen

所有已实现的接口:: CodegenConfig

直接已知子类:: AdaCodegen, AdaServerCodegen

public abstract class AbstractAdaCodegen
extends DefaultCodegen
implements CodegenConfig

字段概要

字段
限定符和类型	字段和说明
`protected Map<String,List<String>>`	`modelDepends`
`protected Map<String,String>`	`nullableTypeMapping`
`protected HashMap<String,String>`	`operationsScopes`
`protected List<Map<String,Object>>`	`orderedModels`
`protected String`	`packageName`
`protected String`	`projectName`
`protected int`	`scopeIndex`

从类继承的字段 org.openapitools.codegen.DefaultCodegen
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

构造器概要

构造器
构造器和说明

AbstractAdaCodegen()

构造器
构造器和说明
`AbstractAdaCodegen()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`String`	`escapeQuotationMark(String input)` Escape single and/or double quote to avoid code injection
`String`	`escapeReservedWord(String name)` Escapes a reserved word as defined in the `reservedWords` array.
`String`	`escapeUnsafeCharacters(String input)` override with any special text escaping logic to handle unsafe characters so as to avoid code injection
`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
`CodegenProperty`	`fromProperty(String name, io.swagger.v3.oas.models.media.Schema p)` Convert OAS Property object to Codegen Property object
`String`	`getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)` Optional - type declaration.
`protected int`	`postProcessMediaTypes(List<Map<String,String>> types)` Post process the media types (produces and consumes) for Ada code generator.
`Map<String,Object>`	`postProcessModels(Map<String,Object> objs)`
`Map<String,Object>`	`postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)`
`void`	`postProcessParameter(CodegenParameter parameter)` Overrides postProcessParameter to add a vendor extension "x-is-model-type".
`Map<String,Object>`	`postProcessSupportingFileData(Map<String,Object> objs)`
`com.samskivert.mustache.Mustache.Compiler`	`processCompiler(com.samskivert.mustache.Mustache.Compiler compiler)` Override the Mustache compiler configuration.
`protected String`	`toAdaIdentifier(String name, String prefix)` Turn a parameter name, operation name into an Ada identifier.
`String`	`toFilename(String name)`
`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`	`toVarName(String name)` Return the variable name by removing invalid characters and proper escaping if it's a reserved word.

从类继承的方法 org.openapitools.codegen.DefaultCodegen
addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOperationToGroup, addOption, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFileFolder, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, embeddedTemplateDir, escapeSpecialCharacters, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromModel, fromOperation, fromParameter, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, getAlias, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getDocExtension, getGitRepoId, getGitUserId, getHelp, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getMostInnerItems, getName, getOrGenerateOperationId, getOutputDir, getParameterDataType, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSchemaType, getSymbolName, getTag, getterAndSetterCapitalize, getTypeDeclaration, hasBodyParameter, hasFormParameter, importMapping, initalizeSpecialCharacterMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnablePostProcessFile, isHideGenerationTimestamp, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needToImport, outputFolder, postProcessAllModels, postProcessFile, postProcessModelProperty, postProcessModelsEnum, postProcessOperations, preprocessOpenAPI, processOpenAPI, processOpts, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeTag, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setDocExtension, setEnablePostProcessFile, setEnsureUniqueParams, setGitRepoId, setGitUserId, setGlobalOpenAPI, setGlobalSchemas, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setParameterExampleValue, setParameterExampleValue, setPrependFormOrBodyParameters, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExamples, toExampleValue, toGetter, toGetter, toInstantiationType, toModelDocFilename, toModelFilename, toModelImport, toModelTestFilename, toRegularExpression, toSetter, toSetter, typeMapping, underscore, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writePropertyBack

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.openapitools.codegen.CodegenConfig
additionalProperties, addOperationToGroup, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFileFolder, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromModel, 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, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessFile, postProcessModelProperty, postProcessOperations, preprocessOpenAPI, processOpenAPI, processOpts, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setDocExtension, setEnablePostProcessFile, setGitRepoId, setGitUserId, setGlobalOpenAPI, setGlobalSchemas, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelFilename, toModelImport, toModelTestFilename, toSetter, typeMapping, vendorExtensions

- 字段详细资料
  - packageName
```
protected String packageName
```
  - projectName
```
protected String projectName
```
  - orderedModels
```
protected List<Map<String,Object>> orderedModels
```
  - modelDepends
```
protected final Map<String,List<String>> modelDepends
```
  - nullableTypeMapping
```
protected final Map<String,String> nullableTypeMapping
```
  - operationsScopes
```
protected final HashMap<String,String> operationsScopes
```
  - scopeIndex
```
protected int scopeIndex
```
- 构造器详细资料
  - AbstractAdaCodegen
```
public AbstractAdaCodegen()
```
- 方法详细资料
  - toFilename
```
public String toFilename(String name)
```
  - toAdaIdentifier
```
protected String toAdaIdentifier(String name,
                                 String prefix)
```
    Turn a parameter name, operation name into an Ada identifier.
    Ada programming standard avoid the camelcase syntax and prefer the underscore notation. We also have to make sure the identifier is not a reserved keyword. When this happens, we add the configurable prefix. The function translates:
    body - P_Body petId - Pet_Id updatePetWithForm - Update_Pet_With_Form
    
    参数:
    
    name - the parameter name.
    
    prefix - the optional prefix in case the parameter name is a reserved keyword.
    
    返回:
    
    the Ada identifier to be used.
  - toOperationId
```
public String toOperationId(String operationId)
```
    从类复制的说明: DefaultCodegen
    
    Return the operation ID (method name)
    
    覆盖:
    
    toOperationId 在类中 DefaultCodegen
    
    参数:
    
    operationId - operation ID
    
    返回:
    
    the sanitized method name
  - toVarName
```
public String toVarName(String name)
```
    从类复制的说明: DefaultCodegen
    
    Return the variable name by removing invalid characters and proper escaping if it's a reserved word.
    
    覆盖:
    
    toVarName 在类中 DefaultCodegen
    
    参数:
    
    name - the variable name
    
    返回:
    
    the sanitized variable name
  - toParamName
```
public String toParamName(String name)
```
    从类复制的说明: DefaultCodegen
    
    Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.
    
    指定者:
    
    toParamName 在接口中 CodegenConfig
    
    覆盖:
    
    toParamName 在类中 DefaultCodegen
    
    参数:
    
    name - Codegen property object
    
    返回:
    
    the sanitized parameter name
  - toModelName
```
public String toModelName(String name)
```
    Output the proper model name (capitalized). In case the name belongs to the TypeSystem it won't be renamed.
    
    指定者:
    
    toModelName 在接口中 CodegenConfig
    
    覆盖:
    
    toModelName 在类中 DefaultCodegen
    
    参数:
    
    name - the name of the model
    
    返回:
    
    capitalized model name
  - fromProperty
```
public CodegenProperty fromProperty(String name,
                                    io.swagger.v3.oas.models.media.Schema p)
```
    从类复制的说明: DefaultCodegen
    
    Convert OAS Property object to Codegen Property object
    
    覆盖:
    
    fromProperty 在类中 DefaultCodegen
    
    参数:
    
    name - name of the property
    
    p - OAS property object
    
    返回:
    
    Codegen Property object
  - escapeReservedWord
```
public String escapeReservedWord(String name)
```
    Escapes a reserved word as defined in the `reservedWords` array. Handle escaping those terms here. This logic is only called if a variable matches the reserved words
    
    指定者:
    
    escapeReservedWord 在接口中 CodegenConfig
    
    覆盖:
    
    escapeReservedWord 在类中 DefaultCodegen
    
    参数:
    
    name - the name to be escaped
    
    返回:
    
    the escaped term
  - escapeQuotationMark
```
public String escapeQuotationMark(String input)
```
    从类复制的说明: DefaultCodegen
    
    Escape single and/or double quote to avoid code injection
    
    指定者:
    
    escapeQuotationMark 在接口中 CodegenConfig
    
    覆盖:
    
    escapeQuotationMark 在类中 DefaultCodegen
    
    参数:
    
    input - String to be cleaned up
    
    返回:
    
    string with quotation mark removed or escaped
  - escapeUnsafeCharacters
```
public String escapeUnsafeCharacters(String input)
```
    从类复制的说明: DefaultCodegen
    
    override with any special text escaping logic to handle unsafe characters so as to avoid code injection
    
    指定者:
    
    escapeUnsafeCharacters 在接口中 CodegenConfig
    
    覆盖:
    
    escapeUnsafeCharacters 在类中 DefaultCodegen
    
    参数:
    
    input - String to be cleaned up
    
    返回:
    
    string with unsafe characters removed or escaped
  - processCompiler
```
public com.samskivert.mustache.Mustache.Compiler processCompiler(com.samskivert.mustache.Mustache.Compiler compiler)
```
    Override the Mustache compiler configuration.
    We don't want to have special characters escaped
    
    指定者:
    
    processCompiler 在接口中 CodegenConfig
    
    覆盖:
    
    processCompiler 在类中 DefaultCodegen
    
    参数:
    
    compiler - the compiler.
    
    返回:
    
    the compiler to use.
  - getTypeDeclaration
```
public String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)
```
    Optional - type declaration. This is a String which is used by the templates to instantiate your types. There is typically special handling for different property types
    
    指定者:
    
    getTypeDeclaration 在接口中 CodegenConfig
    
    覆盖:
    
    getTypeDeclaration 在类中 DefaultCodegen
    
    参数:
    
    p - property schema
    
    返回:
    
    a string value used as the `dataType` field for model templates, `returnType` for api templates
  - postProcessParameter
```
public void postProcessParameter(CodegenParameter parameter)
```
    Overrides postProcessParameter to add a vendor extension "x-is-model-type". This boolean indicates that the parameter comes from the model package.
    
    指定者:
    
    postProcessParameter 在接口中 CodegenConfig
    
    覆盖:
    
    postProcessParameter 在类中 DefaultCodegen
    
    参数:
    
    parameter - CodegenParameter object to be processed.
  - postProcessMediaTypes
```
protected int postProcessMediaTypes(List<Map<String,String>> types)
```
    Post process the media types (produces and consumes) for Ada code generator.
    For each media type, add an adaMediaType member that gives the Ada enum constant for the corresponding type.
    
    参数:
    
    types - the list of media types.
    
    返回:
    
    the number of media types.
  - fromOperation
```
public 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)
```
    从类复制的说明: DefaultCodegen
    
    Convert OAS Operation object to Codegen Operation object
    
    指定者:
    
    fromOperation 在接口中 CodegenConfig
    
    覆盖:
    
    fromOperation 在类中 DefaultCodegen
    
    参数:
    
    path - the path of the operation
    
    httpMethod - HTTP method
    
    operation - OAS operation object
    
    definitions - a map of OAS models
    
    openAPI - a OAS object representing the spec
    
    返回:
    
    Codegen Operation object
  - postProcessOperationsWithModels
```
public Map<String,Object> postProcessOperationsWithModels(Map<String,Object> objs,
                                                          List<Object> allModels)
```
    指定者:
    
    postProcessOperationsWithModels 在接口中 CodegenConfig
    
    覆盖:
    
    postProcessOperationsWithModels 在类中 DefaultCodegen
  - postProcessModels
```
public Map<String,Object> postProcessModels(Map<String,Object> objs)
```
    指定者:
    
    postProcessModels 在接口中 CodegenConfig
    
    覆盖:
    
    postProcessModels 在类中 DefaultCodegen
  - postProcessSupportingFileData
```
public Map<String,Object> postProcessSupportingFileData(Map<String,Object> objs)
```
    指定者:
    
    postProcessSupportingFileData 在接口中 CodegenConfig
    
    覆盖:
    
    postProcessSupportingFileData 在类中 DefaultCodegen

类 AbstractAdaCodegen

字段概要

从类继承的字段 org.openapitools.codegen.DefaultCodegen

构造器概要

方法概要

从类继承的方法 org.openapitools.codegen.DefaultCodegen

从类继承的方法 java.lang.Object

从接口继承的方法 org.openapitools.codegen.CodegenConfig

字段详细资料

packageName

projectName

orderedModels

modelDepends

nullableTypeMapping

operationsScopes

scopeIndex

构造器详细资料

AbstractAdaCodegen

方法详细资料

toFilename

toAdaIdentifier

toOperationId

toVarName

toParamName

toModelName

fromProperty

escapeReservedWord

escapeQuotationMark

escapeUnsafeCharacters

processCompiler

getTypeDeclaration

postProcessParameter

postProcessMediaTypes

fromOperation

postProcessOperationsWithModels

postProcessModels

postProcessSupportingFileData