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

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

所有已实现的接口:: CodegenConfig

public class FlashClientCodegen
extends DefaultCodegen
implements CodegenConfig

字段概要

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

protected String invokerPackage

protected String packageName

protected String packageVersion

protected String sourceFolder
- 从类继承的字段 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 String`	`invokerPackage`
`protected String`	`packageName`
`protected String`	`packageVersion`
`protected String`	`sourceFolder`

构造器概要

构造器
构造器和说明

FlashClientCodegen()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`String`	`apiFileFolder()`
`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
`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
`String`	`modelFileFolder()`
`void`	`processOpts()`
`void`	`setInvokerPackage(String invokerPackage)`
`void`	`setPackageName(String packageName)`
`void`	`setPackageVersion(String packageVersion)`
`void`	`setSourceFolder(String sourceFolder)`
`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`	`toApiVarName(String name)` Return the variable name in the Api
`String`	`toDefaultValue(io.swagger.v3.oas.models.media.Schema p)` Return the default 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`	`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, 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, fromOperation, fromParameter, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, getAlias, 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, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needToImport, outputFolder, postProcessAllModels, postProcessFile, postProcessModelProperty, postProcessModels, postProcessModelsEnum, postProcessOperations, postProcessOperationsWithModels, postProcessParameter, postProcessSupportingFileData, preprocessOpenAPI, processCompiler, processOpenAPI, 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, toApiImport, toApiTestFilename, toArrayModelParamName, toBooleanGetter, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExamples, toExampleValue, toGetter, toGetter, toInstantiationType, toModelDocFilename, 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, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromModel, fromOperation, 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, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessFile, postProcessModelProperty, postProcessModels, postProcessOperations, postProcessOperationsWithModels, postProcessParameter, postProcessSupportingFileData, preprocessOpenAPI, processCompiler, processOpenAPI, 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, toApiImport, toApiTestFilename, toBooleanGetter, toGetter, toModelDocFilename, toModelImport, toModelTestFilename, toSetter, typeMapping, vendorExtensions

- 字段详细资料
  - packageName
```
protected String packageName
```
  - packageVersion
```
protected String packageVersion
```
  - invokerPackage
```
protected String invokerPackage
```
  - sourceFolder
```
protected String sourceFolder
```
- 构造器详细资料
  - FlashClientCodegen
```
public FlashClientCodegen()
```
- 方法详细资料
  - processOpts
```
public void processOpts()
```
    指定者:
    
    processOpts 在接口中 CodegenConfig
    
    覆盖:
    
    processOpts 在类中 DefaultCodegen
  - getTag
```
public CodegenType getTag()
```
    指定者:
    
    getTag 在接口中 CodegenConfig
    
    覆盖:
    
    getTag 在类中 DefaultCodegen
  - getName
```
public String getName()
```
    指定者:
    
    getName 在接口中 CodegenConfig
    
    覆盖:
    
    getName 在类中 DefaultCodegen
  - getHelp
```
public String getHelp()
```
    指定者:
    
    getHelp 在接口中 CodegenConfig
    
    覆盖:
    
    getHelp 在类中 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)
  - apiFileFolder
```
public String apiFileFolder()
```
    指定者:
    
    apiFileFolder 在接口中 CodegenConfig
    
    覆盖:
    
    apiFileFolder 在类中 DefaultCodegen
  - modelFileFolder
```
public String modelFileFolder()
```
    指定者:
    
    modelFileFolder 在接口中 CodegenConfig
    
    覆盖:
    
    modelFileFolder 在类中 DefaultCodegen
  - 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
  - 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
  - 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
  - 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
  - toApiFilename
```
public String toApiFilename(String name)
```
    从类复制的说明: DefaultCodegen
    
    Return the file name of the Api Test
    
    指定者:
    
    toApiFilename 在接口中 CodegenConfig
    
    覆盖:
    
    toApiFilename 在类中 DefaultCodegen
    
    参数:
    
    name - the file name of the Api
    
    返回:
    
    the file name of the Api
  - toApiName
```
public String toApiName(String name)
```
    从类复制的说明: DefaultCodegen
    
    Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty
    
    指定者:
    
    toApiName 在接口中 CodegenConfig
    
    覆盖:
    
    toApiName 在类中 DefaultCodegen
    
    参数:
    
    name - the name of the Api
    
    返回:
    
    capitalized Api name ending with "Api"
  - toApiVarName
```
public String toApiVarName(String name)
```
    从类复制的说明: DefaultCodegen
    
    Return the variable name in the Api
    
    指定者:
    
    toApiVarName 在接口中 CodegenConfig
    
    覆盖:
    
    toApiVarName 在类中 DefaultCodegen
    
    参数:
    
    name - the varible name of the Api
    
    返回:
    
    the snake-cased variable name
  - toOperationId
```
public String toOperationId(String operationId)
```
    从类复制的说明: DefaultCodegen
    
    Return the operation ID (method name)
    
    覆盖:
    
    toOperationId 在类中 DefaultCodegen
    
    参数:
    
    operationId - operation ID
    
    返回:
    
    the sanitized method name
  - setPackageName
```
public void setPackageName(String packageName)
```
  - setPackageVersion
```
public void setPackageVersion(String packageVersion)
```
  - setInvokerPackage
```
public void setInvokerPackage(String invokerPackage)
```
  - setSourceFolder
```
public void setSourceFolder(String sourceFolder)
```
  - 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

类 FlashClientCodegen

字段概要

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

构造器概要

方法概要

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

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

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

字段详细资料

packageName

packageVersion

invokerPackage

sourceFolder

构造器详细资料

FlashClientCodegen

方法详细资料

processOpts

getTag

getName

getHelp

escapeReservedWord

apiFileFolder

modelFileFolder

getTypeDeclaration

getSchemaType

toDefaultValue

toVarName

toParamName

toModelName

toModelFilename

toApiFilename

toApiName

toApiVarName

toOperationId

setPackageName

setPackageVersion

setInvokerPackage

setSourceFolder

escapeQuotationMark

escapeUnsafeCharacters