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

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

所有已实现的接口:: CodegenConfig

直接已知子类:: ApexClientCodegen

public abstract class AbstractApexCodegen
extends DefaultCodegen
implements CodegenConfig

字段概要

字段
限定符和类型字段和说明

protected Boolean serializableModel
- 从类继承的字段 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

字段
限定符和类型	字段和说明
`protected Boolean`	`serializableModel`

构造器概要

构造器
构造器和说明

AbstractApexCodegen()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`convertPropertyToBoolean(String propertyKey)`
`String`	`escapeReservedWord(String name)` Return the escaped name of the reserved word
`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
`String`	`getAlias(String name)` Determine the type alias for the given type if it exists.
`String`	`getHelp()`
`String`	`getName()`
`String`	`getSchemaType(io.swagger.v3.oas.models.media.Schema p)` returns the OpenAPI type for the property.
`CodegenType`	`getTag()`
`String`	`getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)` Output the type declaration of the property
`protected boolean`	`needToImport(String type)` Check the type to see if it needs import the library/module/package
`Map<String,Object>`	`postProcessModels(Map<String,Object> objs)`
`void`	`postProcessParameter(CodegenParameter parameter)`
`void`	`processOpts()`
`String`	`sanitizeName(String name)` Sanitize name (parameter, property, method, etc)
`String`	`sanitizeTag(String tag)` Sanitize tag
`void`	`setParameterExampleValue(CodegenParameter p)` Return the example value of the parameter.
`void`	`setSerializableModel(Boolean serializableModel)`
`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`	`toModelFilename(String name)` Return the capitalized file name of the model
`String`	`toModelName(String name)` Output the proper model name (capitalized).
`String`	`toModelTestFilename(String name)` Return the capitalized file name of the model test
`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)`

从类继承的方法 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, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, embeddedTemplateDir, escapeQuotationMark, escapeSpecialCharacters, escapeText, escapeTextWhileAllowingNewLines, escapeUnsafeCharacters, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromOperation, fromParameter, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getDocExtension, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getMostInnerItems, getOrGenerateOperationId, getOutputDir, getParameterDataType, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSymbolName, 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, outputFolder, postProcessAllModels, postProcessFile, postProcessModelProperty, postProcessModelsEnum, postProcessOperations, postProcessOperationsWithModels, postProcessSupportingFileData, preprocessOpenAPI, processCompiler, processOpenAPI, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, 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, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toGetter, toGetter, toInstantiationType, toModelDocFilename, toModelImport, toSetter, toSetter, typeMapping, underscore, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional

从类继承的方法 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, escapeQuotationMark, escapeText, escapeTextWhileAllowingNewLines, escapeUnsafeCharacters, fileSuffix, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getCommonTemplateDir, getDocExtension, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getTypeDeclaration, importMapping, instantiationTypes, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessFile, postProcessModelProperty, postProcessOperations, postProcessOperationsWithModels, postProcessSupportingFileData, preprocessOpenAPI, processCompiler, processOpenAPI, reservedWords, reservedWordsMappings, 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, toModelImport, toSetter, typeMapping, vendorExtensions

- 字段详细资料
  - serializableModel
```
protected Boolean serializableModel
```
- 构造器详细资料
  - AbstractApexCodegen
```
public AbstractApexCodegen()
```
- 方法详细资料
  - getTag
```
public CodegenType getTag()
```
    指定者:
    
    getTag 在接口中 CodegenConfig
    
    覆盖:
    
    getTag 在类中 DefaultCodegen
  - getName
```
public String getName()
```
    指定者:
    
    getName 在接口中 CodegenConfig
    
    覆盖:
    
    getName 在类中 DefaultCodegen
  - getHelp
```
public String getHelp()
```
    指定者:
    
    getHelp 在接口中 CodegenConfig
    
    覆盖:
    
    getHelp 在类中 DefaultCodegen
  - processOpts
```
public void processOpts()
```
    指定者:
    
    processOpts 在接口中 CodegenConfig
    
    覆盖:
    
    processOpts 在类中 DefaultCodegen
  - escapeReservedWord
```
public String escapeReservedWord(String name)
```
    从类复制的说明: DefaultCodegen
    
    Return the escaped name of the reserved word
    
    指定者:
    
    escapeReservedWord 在接口中 CodegenConfig
    
    覆盖:
    
    escapeReservedWord 在类中 DefaultCodegen
    
    参数:
    
    name - the name to be escaped
    
    返回:
    
    the escaped reserved word
    throws Runtime exception as reserved word is not allowed (default behavior)
  - sanitizeName
```
public String sanitizeName(String name)
```
    从类复制的说明: DefaultCodegen
    
    Sanitize name (parameter, property, method, etc)
    
    指定者:
    
    sanitizeName 在接口中 CodegenConfig
    
    覆盖:
    
    sanitizeName 在类中 DefaultCodegen
    
    参数:
    
    name - string to be sanitize
    
    返回:
    
    sanitized string
  - 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)
```
    从类复制的说明: DefaultCodegen
    
    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
  - toModelFilename
```
public String toModelFilename(String name)
```
    从类复制的说明: DefaultCodegen
    
    Return the capitalized file name of the model
    
    指定者:
    
    toModelFilename 在接口中 CodegenConfig
    
    覆盖:
    
    toModelFilename 在类中 DefaultCodegen
    
    参数:
    
    name - the model name
    
    返回:
    
    the file name of the model
  - getTypeDeclaration
```
public String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)
```
    从类复制的说明: DefaultCodegen
    
    Output the type declaration of the property
    
    指定者:
    
    getTypeDeclaration 在接口中 CodegenConfig
    
    覆盖:
    
    getTypeDeclaration 在类中 DefaultCodegen
    
    参数:
    
    p - property schema
    
    返回:
    
    a string presentation of the property type
  - getAlias
```
public String getAlias(String name)
```
    从类复制的说明: DefaultCodegen
    
    Determine the type alias for the given type if it exists. This feature was originally developed for Java because the language does not have an aliasing mechanism of its own but later extends to handle other languages
    
    覆盖:
    
    getAlias 在类中 DefaultCodegen
    
    参数:
    
    name - The type name.
    
    返回:
    
    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 p)
```
    从类复制的说明: DefaultCodegen
    
    Return the default value of the property
    
    覆盖:
    
    toDefaultValue 在类中 DefaultCodegen
    
    参数:
    
    p - Property schema
    
    返回:
    
    string presentation of the default value of the property
  - setParameterExampleValue
```
public void setParameterExampleValue(CodegenParameter p)
```
    从类复制的说明: DefaultCodegen
    
    Return the example value of the parameter.
    
    覆盖:
    
    setParameterExampleValue 在类中 DefaultCodegen
    
    参数:
    
    p - Codegen parameter
  - toExampleValue
```
public String toExampleValue(io.swagger.v3.oas.models.media.Schema p)
```
    从类复制的说明: DefaultCodegen
    
    Return the example value of the property
    
    覆盖:
    
    toExampleValue 在类中 DefaultCodegen
    
    参数:
    
    p - Property schema
    
    返回:
    
    string presentation of the example value of the property
  - getSchemaType
```
public String getSchemaType(io.swagger.v3.oas.models.media.Schema p)
```
    从类复制的说明: DefaultCodegen
    
    returns the OpenAPI type for the property. Use getAlias to handle $ref of primitive type
    
    覆盖:
    
    getSchemaType 在类中 DefaultCodegen
    
    参数:
    
    p - property schema
    
    返回:
    
    string presentation of the type
  - toOperationId
```
public String toOperationId(String operationId)
```
    从类复制的说明: DefaultCodegen
    
    Return the operation ID (method name)
    
    覆盖:
    
    toOperationId 在类中 DefaultCodegen
    
    参数:
    
    operationId - operation ID
    
    返回:
    
    the sanitized method name
  - fromModel
```
public CodegenModel fromModel(String name,
                              io.swagger.v3.oas.models.media.Schema model,
                              Map<String,io.swagger.v3.oas.models.media.Schema> allDefinitions)
```
    从类复制的说明: DefaultCodegen
    
    Convert OAS Model object to Codegen Model object
    
    指定者:
    
    fromModel 在接口中 CodegenConfig
    
    覆盖:
    
    fromModel 在类中 DefaultCodegen
    
    参数:
    
    name - the name of the model
    
    model - OAS Model object
    
    allDefinitions - a map of all OAS models from the spec
    
    返回:
    
    Codegen Model object
  - postProcessParameter
```
public void postProcessParameter(CodegenParameter parameter)
```
    指定者:
    
    postProcessParameter 在接口中 CodegenConfig
    
    覆盖:
    
    postProcessParameter 在类中 DefaultCodegen
  - postProcessModels
```
public Map<String,Object> postProcessModels(Map<String,Object> objs)
```
    指定者:
    
    postProcessModels 在接口中 CodegenConfig
    
    覆盖:
    
    postProcessModels 在类中 DefaultCodegen
  - needToImport
```
protected boolean needToImport(String type)
```
    从类复制的说明: DefaultCodegen
    
    Check the type to see if it needs import the library/module/package
    
    覆盖:
    
    needToImport 在类中 DefaultCodegen
    
    参数:
    
    type - name of the type
    
    返回:
    
    true if the library/module/package of the corresponding type needs to be imported
  - toEnumName
```
public String toEnumName(CodegenProperty property)
```
    从类复制的说明: DefaultCodegen
    
    Return the Enum name (e.g. StatusEnum given 'status')
    
    覆盖:
    
    toEnumName 在类中 DefaultCodegen
    
    参数:
    
    property - Codegen property
    
    返回:
    
    the Enum name
  - toEnumVarName
```
public String toEnumVarName(String value,
                            String datatype)
```
    从类复制的说明: DefaultCodegen
    
    Return the sanitized variable name for enum
    
    覆盖:
    
    toEnumVarName 在类中 DefaultCodegen
    
    参数:
    
    value - enum variable name
    
    datatype - data type
    
    返回:
    
    the sanitized variable name for enum
  - toEnumValue
```
public String toEnumValue(String value,
                          String datatype)
```
    从类复制的说明: DefaultCodegen
    
    Return the enum value in the language specified format e.g. status becomes "status"
    
    覆盖:
    
    toEnumValue 在类中 DefaultCodegen
    
    参数:
    
    value - enum variable name
    
    datatype - data type
    
    返回:
    
    the sanitized value for enum
  - 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
  - setSerializableModel
```
public void setSerializableModel(Boolean serializableModel)
```
  - toRegularExpression
```
public String toRegularExpression(String pattern)
```
    从类复制的说明: DefaultCodegen
    
    Return the regular expression/JSON schema pattern (http://json-schema.org/latest/json-schema-validation.html#anchor33)
    
    覆盖:
    
    toRegularExpression 在类中 DefaultCodegen
    
    参数:
    
    pattern - the pattern (regular expression)
    
    返回:
    
    properly-escaped pattern
  - convertPropertyToBoolean
```
public boolean convertPropertyToBoolean(String propertyKey)
```
    覆盖:
    
    convertPropertyToBoolean 在类中 DefaultCodegen
  - writePropertyBack
```
public void writePropertyBack(String propertyKey,
                              boolean value)
```
    覆盖:
    
    writePropertyBack 在类中 DefaultCodegen
  - sanitizeTag
```
public String sanitizeTag(String tag)
```
    从类复制的说明: DefaultCodegen
    
    Sanitize tag
    
    指定者:
    
    sanitizeTag 在接口中 CodegenConfig
    
    覆盖:
    
    sanitizeTag 在类中 DefaultCodegen
    
    参数:
    
    tag - Tag
    
    返回:
    
    Sanitized tag
  - toModelTestFilename
```
public String toModelTestFilename(String name)
```
    从类复制的说明: DefaultCodegen
    
    Return the capitalized file name of the model test
    
    指定者:
    
    toModelTestFilename 在接口中 CodegenConfig
    
    覆盖:
    
    toModelTestFilename 在类中 DefaultCodegen
    
    参数:
    
    name - the model name
    
    返回:
    
    the file name of the model

类 AbstractApexCodegen

字段概要

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

构造器概要

方法概要

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

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

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

字段详细资料

serializableModel

构造器详细资料

AbstractApexCodegen

方法详细资料

getTag

getName

getHelp

processOpts

escapeReservedWord

sanitizeName

toVarName

toParamName

toModelName

toModelFilename

getTypeDeclaration

getAlias

toDefaultValue

setParameterExampleValue

toExampleValue

getSchemaType

toOperationId

fromModel

postProcessParameter

postProcessModels

needToImport

toEnumName

toEnumVarName

toEnumValue

fromOperation

setSerializableModel

toRegularExpression

convertPropertyToBoolean

writePropertyBack

sanitizeTag

toModelTestFilename