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

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

所有已实现的接口:: CodegenConfig

public class AndroidClientCodegen
extends DefaultCodegen
implements CodegenConfig

字段概要

字段
限定符和类型	字段和说明
`static String`	`ANDROID_BUILD_TOOLS_VERSION`
`static String`	`ANDROID_GRADLE_VERSION`
`static String`	`ANDROID_SDK_VERSION`
`protected String`	`androidBuildToolsVersion`
`protected String`	`androidGradleVersion`
`protected String`	`androidSdkVersion`
`protected String`	`apiDocPath`
`protected String`	`artifactId`
`protected String`	`artifactVersion`
`protected String`	`authPackage`
`protected String`	`gradleWrapperPackage`
`protected String`	`groupId`
`protected String`	`invokerPackage`
`protected String`	`modelDocPath`
`protected String`	`projectFolder`
`protected String`	`requestPackage`
`protected Boolean`	`serializableModel`
`protected String`	`sourceFolder`
`static String`	`USE_ANDROID_MAVEN_GRADLE_PLUGIN`
`protected Boolean`	`useAndroidMavenGradlePlugin`

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

构造器概要

构造器
构造器和说明

AndroidClientCodegen()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`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`	`getAndroidBuildToolsVersion()`
`String`	`getAndroidGradleVersion()`
`String`	`getAndroidSdkVersion()`
`String`	`getHelp()`
`String`	`getInvokerPackage()`
`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
`Boolean`	`getUseAndroidMavenGradlePlugin()`
`String`	`modelDocFileFolder()`
`String`	`modelFileFolder()`
`void`	`processOpts()`
`void`	`setAndroidBuildToolsVersion(String androidBuildToolsVersion)`
`void`	`setAndroidGradleVersion(String androidGradleVersion)`
`void`	`setAndroidSdkVersion(String androidSdkVersion)`
`void`	`setArtifactId(String artifactId)`
`void`	`setArtifactVersion(String artifactVersion)`
`void`	`setAuthPackage(String authPackage)`
`void`	`setGroupId(String groupId)`
`void`	`setInvokerPackage(String invokerPackage)`
`void`	`setParameterExampleValue(CodegenParameter p)` Return the example value of the parameter.
`void`	`setRequestPackage(String requestPackage)`
`void`	`setSerializableModel(Boolean serializableModel)`
`void`	`setSourceFolder(String sourceFolder)`
`void`	`setUseAndroidMavenGradlePlugin(Boolean useAndroidMavenGradlePlugin)`
`String`	`toApiDocFilename(String name)` Return the file name of the Api Documentation
`String`	`toModelDocFilename(String name)` Return the capitalized file name of the model documentation
`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, 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, setPrependFormOrBodyParameters, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExamples, toExampleValue, toGetter, toGetter, toInstantiationType, 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, 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, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelImport, toModelTestFilename, toSetter, typeMapping, vendorExtensions

- 字段详细资料
  - USE_ANDROID_MAVEN_GRADLE_PLUGIN
```
public static final String USE_ANDROID_MAVEN_GRADLE_PLUGIN
```
    另请参阅:
    
    常量字段值
  - ANDROID_GRADLE_VERSION
```
public static final String ANDROID_GRADLE_VERSION
```
    另请参阅:
    
    常量字段值
  - ANDROID_SDK_VERSION
```
public static final String ANDROID_SDK_VERSION
```
    另请参阅:
    
    常量字段值
  - ANDROID_BUILD_TOOLS_VERSION
```
public static final String ANDROID_BUILD_TOOLS_VERSION
```
    另请参阅:
    
    常量字段值
  - invokerPackage
```
protected String invokerPackage
```
  - groupId
```
protected String groupId
```
  - artifactId
```
protected String artifactId
```
  - artifactVersion
```
protected String artifactVersion
```
  - projectFolder
```
protected String projectFolder
```
  - sourceFolder
```
protected String sourceFolder
```
  - useAndroidMavenGradlePlugin
```
protected Boolean useAndroidMavenGradlePlugin
```
  - androidGradleVersion
```
protected String androidGradleVersion
```
  - androidSdkVersion
```
protected String androidSdkVersion
```
  - androidBuildToolsVersion
```
protected String androidBuildToolsVersion
```
  - serializableModel
```
protected Boolean serializableModel
```
  - requestPackage
```
protected String requestPackage
```
  - authPackage
```
protected String authPackage
```
  - gradleWrapperPackage
```
protected String gradleWrapperPackage
```
  - apiDocPath
```
protected String apiDocPath
```
  - modelDocPath
```
protected String modelDocPath
```
- 构造器详细资料
  - AndroidClientCodegen
```
public AndroidClientCodegen()
```
- 方法详细资料
  - 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
  - apiDocFileFolder
```
public String apiDocFileFolder()
```
    指定者:
    
    apiDocFileFolder 在接口中 CodegenConfig
    
    覆盖:
    
    apiDocFileFolder 在类中 DefaultCodegen
  - modelDocFileFolder
```
public String modelDocFileFolder()
```
    指定者:
    
    modelDocFileFolder 在接口中 CodegenConfig
    
    覆盖:
    
    modelDocFileFolder 在类中 DefaultCodegen
  - toApiDocFilename
```
public String toApiDocFilename(String name)
```
    从类复制的说明: DefaultCodegen
    
    Return the file name of the Api Documentation
    
    指定者:
    
    toApiDocFilename 在接口中 CodegenConfig
    
    覆盖:
    
    toApiDocFilename 在类中 DefaultCodegen
    
    参数:
    
    name - the file name of the Api
    
    返回:
    
    the file name of the Api
  - toModelDocFilename
```
public String toModelDocFilename(String name)
```
    从类复制的说明: DefaultCodegen
    
    Return the capitalized file name of the model documentation
    
    指定者:
    
    toModelDocFilename 在接口中 CodegenConfig
    
    覆盖:
    
    toModelDocFilename 在类中 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
  - 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
  - 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
  - setParameterExampleValue
```
public void setParameterExampleValue(CodegenParameter p)
```
    从类复制的说明: DefaultCodegen
    
    Return the example value of the parameter.
    
    覆盖:
    
    setParameterExampleValue 在类中 DefaultCodegen
    
    参数:
    
    p - Codegen parameter
  - toOperationId
```
public String toOperationId(String operationId)
```
    从类复制的说明: DefaultCodegen
    
    Return the operation ID (method name)
    
    覆盖:
    
    toOperationId 在类中 DefaultCodegen
    
    参数:
    
    operationId - operation ID
    
    返回:
    
    the sanitized method name
  - processOpts
```
public void processOpts()
```
    指定者:
    
    processOpts 在接口中 CodegenConfig
    
    覆盖:
    
    processOpts 在类中 DefaultCodegen
  - getUseAndroidMavenGradlePlugin
```
public Boolean getUseAndroidMavenGradlePlugin()
```
  - getAndroidGradleVersion
```
public String getAndroidGradleVersion()
```
  - getAndroidSdkVersion
```
public String getAndroidSdkVersion()
```
  - getAndroidBuildToolsVersion
```
public String getAndroidBuildToolsVersion()
```
  - setUseAndroidMavenGradlePlugin
```
public void setUseAndroidMavenGradlePlugin(Boolean useAndroidMavenGradlePlugin)
```
  - setAndroidGradleVersion
```
public void setAndroidGradleVersion(String androidGradleVersion)
```
  - setAndroidSdkVersion
```
public void setAndroidSdkVersion(String androidSdkVersion)
```
  - setAndroidBuildToolsVersion
```
public void setAndroidBuildToolsVersion(String androidBuildToolsVersion)
```
  - getInvokerPackage
```
public String getInvokerPackage()
```
  - setInvokerPackage
```
public void setInvokerPackage(String invokerPackage)
```
  - setRequestPackage
```
public void setRequestPackage(String requestPackage)
```
  - setAuthPackage
```
public void setAuthPackage(String authPackage)
```
  - setGroupId
```
public void setGroupId(String groupId)
```
  - setArtifactId
```
public void setArtifactId(String artifactId)
```
  - setArtifactVersion
```
public void setArtifactVersion(String artifactVersion)
```
  - setSourceFolder
```
public void setSourceFolder(String sourceFolder)
```
  - setSerializableModel
```
public void setSerializableModel(Boolean serializableModel)
```
  - 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

类 AndroidClientCodegen

字段概要

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

构造器概要

方法概要

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

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

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

字段详细资料

USE_ANDROID_MAVEN_GRADLE_PLUGIN

ANDROID_GRADLE_VERSION

ANDROID_SDK_VERSION

ANDROID_BUILD_TOOLS_VERSION

invokerPackage

groupId

artifactId

artifactVersion

projectFolder

sourceFolder

useAndroidMavenGradlePlugin

androidGradleVersion

androidSdkVersion

androidBuildToolsVersion

serializableModel

requestPackage

authPackage

gradleWrapperPackage

apiDocPath

modelDocPath

构造器详细资料

AndroidClientCodegen

方法详细资料

getTag

getName

getHelp

escapeReservedWord

apiFileFolder

modelFileFolder

apiDocFileFolder

modelDocFileFolder

toApiDocFilename

toModelDocFilename

getTypeDeclaration

getSchemaType

toVarName

toParamName

toModelName

toModelFilename

setParameterExampleValue

toOperationId

processOpts

getUseAndroidMavenGradlePlugin

getAndroidGradleVersion

getAndroidSdkVersion

getAndroidBuildToolsVersion

setUseAndroidMavenGradlePlugin

setAndroidGradleVersion

setAndroidSdkVersion

setAndroidBuildToolsVersion

getInvokerPackage

setInvokerPackage

setRequestPackage

setAuthPackage

setGroupId

setArtifactId

setArtifactVersion

setSourceFolder

setSerializableModel

escapeQuotationMark

escapeUnsafeCharacters