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

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

所有已实现的接口:: CodegenConfig

直接已知子类:: DartJaguarClientCodegen

public class DartClientCodegen
extends DefaultCodegen
implements CodegenConfig

字段概要

字段
限定符和类型	字段和说明
`protected String`	`apiDocPath`
`static String`	`BROWSER_CLIENT`
`protected boolean`	`browserClient`
`protected String`	`modelDocPath`
`static String`	`PUB_DESCRIPTION`
`static String`	`PUB_NAME`
`static String`	`PUB_VERSION`
`protected String`	`pubDescription`
`protected String`	`pubName`
`protected String`	`pubVersion`
`protected String`	`sourceFolder`
`static String`	`SUPPORT_DART2`
`static String`	`USE_ENUM_EXTENSION`
`protected boolean`	`useEnumExtension`

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

构造器概要

构造器
构造器和说明

DartClientCodegen()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`String`	`apiDocFileFolder()`
`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`	`modelDocFileFolder()`
`String`	`modelFileFolder()`
`void`	`postProcessFile(File file, String fileType)` Post-process the auto-generated file, e.g. using go-fmt to format the Go code.
`Map<String,Object>`	`postProcessModels(Map<String,Object> objs)`
`Map<String,Object>`	`postProcessModelsEnum(Map<String,Object> objs)` post process enum defined in model's properties
`void`	`processOpts()`
`void`	`setBrowserClient(boolean browserClient)`
`void`	`setPubDescription(String pubDescription)`
`void`	`setPubName(String pubName)`
`void`	`setPubVersion(String pubVersion)`
`void`	`setSourceFolder(String sourceFolder)`
`void`	`setUseEnumExtension(boolean useEnumExtension)`
`String`	`toApiFilename(String name)` Return the file name of the Api Test
`String`	`toDefaultValue(io.swagger.v3.oas.models.media.Schema schema)` Return the default value of the property
`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`	`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, 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, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needToImport, outputFolder, postProcessAllModels, postProcessModelProperty, 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, toApiName, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, 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, 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, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelProperty, 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, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelImport, toModelTestFilename, toSetter, typeMapping, vendorExtensions

- 字段详细资料
  - BROWSER_CLIENT
```
public static final String BROWSER_CLIENT
```
    另请参阅:
    
    常量字段值
  - PUB_NAME
```
public static final String PUB_NAME
```
    另请参阅:
    
    常量字段值
  - PUB_VERSION
```
public static final String PUB_VERSION
```
    另请参阅:
    
    常量字段值
  - PUB_DESCRIPTION
```
public static final String PUB_DESCRIPTION
```
    另请参阅:
    
    常量字段值
  - USE_ENUM_EXTENSION
```
public static final String USE_ENUM_EXTENSION
```
    另请参阅:
    
    常量字段值
  - SUPPORT_DART2
```
public static final String SUPPORT_DART2
```
    另请参阅:
    
    常量字段值
  - browserClient
```
protected boolean browserClient
```
  - pubName
```
protected String pubName
```
  - pubVersion
```
protected String pubVersion
```
  - pubDescription
```
protected String pubDescription
```
  - useEnumExtension
```
protected boolean useEnumExtension
```
  - sourceFolder
```
protected String sourceFolder
```
  - apiDocPath
```
protected String apiDocPath
```
  - modelDocPath
```
protected String modelDocPath
```
- 构造器详细资料
  - DartClientCodegen
```
public DartClientCodegen()
```
- 方法详细资料
  - 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)
  - apiFileFolder
```
public String apiFileFolder()
```
    指定者:
    
    apiFileFolder 在接口中 CodegenConfig
    
    覆盖:
    
    apiFileFolder 在类中 DefaultCodegen
  - modelFileFolder
```
public String modelFileFolder()
```
    指定者:
    
    modelFileFolder 在接口中 CodegenConfig
    
    覆盖:
    
    modelFileFolder 在类中 DefaultCodegen
  - apiDocFileFolder
```
public String apiDocFileFolder()
```
    指定者:
    
    apiDocFileFolder 在接口中 CodegenConfig
    
    覆盖:
    
    apiDocFileFolder 在类中 DefaultCodegen
  - modelDocFileFolder
```
public String modelDocFileFolder()
```
    指定者:
    
    modelDocFileFolder 在接口中 CodegenConfig
    
    覆盖:
    
    modelDocFileFolder 在类中 DefaultCodegen
  - 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
  - toDefaultValue
```
public String toDefaultValue(io.swagger.v3.oas.models.media.Schema schema)
```
    从类复制的说明: DefaultCodegen
    
    Return the default value of the property
    
    覆盖:
    
    toDefaultValue 在类中 DefaultCodegen
    
    参数:
    
    schema - Property schema
    
    返回:
    
    string presentation of the default value of the property
  - 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
  - postProcessModels
```
public Map<String,Object> postProcessModels(Map<String,Object> objs)
```
    指定者:
    
    postProcessModels 在接口中 CodegenConfig
    
    覆盖:
    
    postProcessModels 在类中 DefaultCodegen
  - postProcessModelsEnum
```
public Map<String,Object> postProcessModelsEnum(Map<String,Object> objs)
```
    从类复制的说明: DefaultCodegen
    
    post process enum defined in model's properties
    
    覆盖:
    
    postProcessModelsEnum 在类中 DefaultCodegen
    
    参数:
    
    objs - Map of models
    
    返回:
    
    maps of models with better enum support
  - 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
  - toOperationId
```
public String toOperationId(String operationId)
```
    从类复制的说明: DefaultCodegen
    
    Return the operation ID (method name)
    
    覆盖:
    
    toOperationId 在类中 DefaultCodegen
    
    参数:
    
    operationId - operation ID
    
    返回:
    
    the sanitized method name
  - setBrowserClient
```
public void setBrowserClient(boolean browserClient)
```
  - setPubName
```
public void setPubName(String pubName)
```
  - setPubVersion
```
public void setPubVersion(String pubVersion)
```
  - setPubDescription
```
public void setPubDescription(String pubDescription)
```
  - setUseEnumExtension
```
public void setUseEnumExtension(boolean useEnumExtension)
```
  - 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
  - postProcessFile
```
public void postProcessFile(File file,
                            String fileType)
```
    从类复制的说明: DefaultCodegen
    
    Post-process the auto-generated file, e.g. using go-fmt to format the Go code. The file type can be "model-test", "model-doc", "model", "api", "api-test", "api-doc", "supporting-mustache", "supporting-common", "openapi-generator-ignore", "openapi-generator-version"
    TODO: store these values in enum instead
    
    指定者:
    
    postProcessFile 在接口中 CodegenConfig
    
    覆盖:
    
    postProcessFile 在类中 DefaultCodegen
    
    参数:
    
    file - file to be processed
    
    fileType - file type

类 DartClientCodegen

字段概要

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

构造器概要

方法概要

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

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

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

字段详细资料

BROWSER_CLIENT

PUB_NAME

PUB_VERSION

PUB_DESCRIPTION

USE_ENUM_EXTENSION

SUPPORT_DART2

browserClient

pubName

pubVersion

pubDescription

useEnumExtension

sourceFolder

apiDocPath

modelDocPath

构造器详细资料

DartClientCodegen

方法详细资料

getTag

getName

getHelp

processOpts

escapeReservedWord

apiFileFolder

modelFileFolder

apiDocFileFolder

modelDocFileFolder

toVarName

toParamName

toModelName

toModelFilename

toApiFilename

toDefaultValue

getTypeDeclaration

getSchemaType

postProcessModels

postProcessModelsEnum

toEnumVarName

toEnumValue

toOperationId

setBrowserClient

setPubName

setPubVersion

setPubDescription

setUseEnumExtension

setSourceFolder

escapeQuotationMark

escapeUnsafeCharacters

postProcessFile