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

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

所有已实现的接口:

CodegenConfig

直接已知子类:

KotlinClientCodegen, KotlinServerCodegen, KotlinSpringServerCodegen
```
public abstract class AbstractKotlinCodegen
extends DefaultCodegen
implements CodegenConfig
```

字段概要

字段
限定符和类型	字段和说明
`protected String`	`apiDocPath`
`protected String`	`artifactId`
`protected String`	`artifactVersion`
`protected CodegenConstants.ENUM_PROPERTY_NAMING_TYPE`	`enumPropertyNaming`
`protected String`	`groupId`
`protected String`	`modelDocPath`
`protected String`	`packageName`
`protected boolean`	`parcelizeModels`
`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

构造器概要

构造器
构造器和说明

AbstractKotlinCodegen()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`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
`CodegenConstants.ENUM_PROPERTY_NAMING_TYPE`	`getEnumPropertyNaming()`
`Boolean`	`getParcelizeModels()`
`String`	`getSchemaType(io.swagger.v3.oas.models.media.Schema p)` returns the swagger type for the property
`String`	`getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)` Output the type declaration of the property
`boolean`	`isDataTypeString(String dataType)` checks if the data should be classified as "string" in enum e.g. double in C# needs to be double-quoted (e.g. "2.8") by treating it as a string In the future, we may rename this function to "isEnumString"
`protected boolean`	`isReservedWord(String word)`
`String`	`modelDocFileFolder()`
`String`	`modelFileFolder()`
`protected boolean`	`needToImport(String type)` Check the type to see if it needs import the library/module/package
`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)`
`void`	`processOpts()`
`void`	`setArtifactId(String artifactId)`
`void`	`setArtifactVersion(String artifactVersion)`
`void`	`setEnumPropertyNaming(String enumPropertyNamingType)` Sets the naming convention for Kotlin enum properties
`void`	`setGroupId(String groupId)`
`void`	`setPackageName(String packageName)`
`void`	`setParcelizeModels(Boolean parcelizeModels)`
`void`	`setSourceFolder(String sourceFolder)`
`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`	`toInstantiationType(io.swagger.v3.oas.models.media.Schema p)` Return the instantiation type of the property, especially for map and array
`String`	`toModelFilename(String name)` Return the capitalized file name of the model
`String`	`toModelImport(String name)` Return the fully-qualified "Model" name for import
`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`	`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.

从类继承的方法 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, getHelp, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getMostInnerItems, getName, getOrGenerateOperationId, getOutputDir, getParameterDataType, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSymbolName, getTag, getterAndSetterCapitalize, getTypeDeclaration, hasBodyParameter, hasFormParameter, importMapping, initalizeSpecialCharacterMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isEnablePostProcessFile, isHideGenerationTimestamp, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelProperty, 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, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toExamples, toExampleValue, toGetter, toGetter, toModelDocFilename, toModelTestFilename, 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, getHelp, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getName, getOutputDir, getReleaseNote, getTag, 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, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelTestFilename, toSetter, typeMapping, vendorExtensions

- 字段详细资料
  - artifactId
```
protected String artifactId
```
  - artifactVersion
```
protected String artifactVersion
```
  - groupId
```
protected String groupId
```
  - packageName
```
protected String packageName
```
  - sourceFolder
```
protected String sourceFolder
```
  - apiDocPath
```
protected String apiDocPath
```
  - modelDocPath
```
protected String modelDocPath
```
  - parcelizeModels
```
protected boolean parcelizeModels
```
  - enumPropertyNaming
```
protected CodegenConstants.ENUM_PROPERTY_NAMING_TYPE enumPropertyNaming
```
- 构造器详细资料
  - AbstractKotlinCodegen
```
public AbstractKotlinCodegen()
```
- 方法详细资料
  - apiDocFileFolder
```
public String apiDocFileFolder()
```
    指定者:
    
    apiDocFileFolder 在接口中 CodegenConfig
    
    覆盖:
    
    apiDocFileFolder 在类中 DefaultCodegen
  - apiFileFolder
```
public String apiFileFolder()
```
    指定者:
    
    apiFileFolder 在接口中 CodegenConfig
    
    覆盖:
    
    apiFileFolder 在类中 DefaultCodegen
  - 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
  - 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)
  - 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
  - getEnumPropertyNaming
```
public CodegenConstants.ENUM_PROPERTY_NAMING_TYPE getEnumPropertyNaming()
```
  - setEnumPropertyNaming
```
public void setEnumPropertyNaming(String enumPropertyNamingType)
```
    Sets the naming convention for Kotlin enum properties
    
    参数:
    
    enumPropertyNamingType - The string representation of the naming convention, as defined by CodegenConstants.ENUM_PROPERTY_NAMING_TYPE
  - getSchemaType
```
public String getSchemaType(io.swagger.v3.oas.models.media.Schema p)
```
    returns the swagger type for the property
    
    覆盖:
    
    getSchemaType 在类中 DefaultCodegen
    
    参数:
    
    p - Swagger property object
    
    返回:
    
    string presentation of the type
  - getTypeDeclaration
```
public String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)
```
    Output the type declaration of the property
    
    指定者:
    
    getTypeDeclaration 在接口中 CodegenConfig
    
    覆盖:
    
    getTypeDeclaration 在类中 DefaultCodegen
    
    参数:
    
    p - Swagger Property object
    
    返回:
    
    a string presentation of the property type
  - modelDocFileFolder
```
public String modelDocFileFolder()
```
    指定者:
    
    modelDocFileFolder 在接口中 CodegenConfig
    
    覆盖:
    
    modelDocFileFolder 在类中 DefaultCodegen
  - modelFileFolder
```
public String modelFileFolder()
```
    指定者:
    
    modelFileFolder 在接口中 CodegenConfig
    
    覆盖:
    
    modelFileFolder 在类中 DefaultCodegen
  - postProcessModels
```
public Map<String,Object> postProcessModels(Map<String,Object> objs)
```
    指定者:
    
    postProcessModels 在接口中 CodegenConfig
    
    覆盖:
    
    postProcessModels 在类中 DefaultCodegen
  - processOpts
```
public void processOpts()
```
    指定者:
    
    processOpts 在接口中 CodegenConfig
    
    覆盖:
    
    processOpts 在类中 DefaultCodegen
  - setArtifactId
```
public void setArtifactId(String artifactId)
```
  - setArtifactVersion
```
public void setArtifactVersion(String artifactVersion)
```
  - setGroupId
```
public void setGroupId(String groupId)
```
  - setPackageName
```
public void setPackageName(String packageName)
```
  - setSourceFolder
```
public void setSourceFolder(String sourceFolder)
```
  - getParcelizeModels
```
public Boolean getParcelizeModels()
```
  - setParcelizeModels
```
public void setParcelizeModels(Boolean parcelizeModels)
```
  - toEnumVarName
```
public String toEnumVarName(String value,
                            String datatype)
```
    Return the sanitized variable name for enum
    
    覆盖:
    
    toEnumVarName 在类中 DefaultCodegen
    
    参数:
    
    value - enum variable name
    
    datatype - data type
    
    返回:
    
    the sanitized variable name for enum
  - toInstantiationType
```
public String toInstantiationType(io.swagger.v3.oas.models.media.Schema p)
```
    从类复制的说明: DefaultCodegen
    
    Return the instantiation type of the property, especially for map and array
    
    覆盖:
    
    toInstantiationType 在类中 DefaultCodegen
    
    参数:
    
    p - property schema
    
    返回:
    
    string presentation of the instantiation type of the property
  - toModelImport
```
public String toModelImport(String name)
```
    Return the fully-qualified "Model" name for import
    
    指定者:
    
    toModelImport 在接口中 CodegenConfig
    
    覆盖:
    
    toModelImport 在类中 DefaultCodegen
    
    参数:
    
    name - the name of the "Model"
    
    返回:
    
    the fully-qualified "Model" name for import
  - 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
  - toOperationId
```
public String toOperationId(String operationId)
```
    Return the operation ID (method name)
    
    覆盖:
    
    toOperationId 在类中 DefaultCodegen
    
    参数:
    
    operationId - operation ID
    
    返回:
    
    the sanitized method 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
  - isReservedWord
```
protected boolean isReservedWord(String word)
```
    覆盖:
    
    isReservedWord 在类中 DefaultCodegen
  - needToImport
```
protected boolean needToImport(String type)
```
    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
  - 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
  - isDataTypeString
```
public boolean isDataTypeString(String dataType)
```
    从类复制的说明: DefaultCodegen
    
    checks if the data should be classified as "string" in enum e.g. double in C# needs to be double-quoted (e.g. "2.8") by treating it as a string In the future, we may rename this function to "isEnumString"
    
    覆盖:
    
    isDataTypeString 在类中 DefaultCodegen
    
    参数:
    
    dataType - data type
    
    返回:
    
    true if it's a enum string
  - 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
  - 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
  - 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
  - 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

类 AbstractKotlinCodegen

字段概要

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

构造器概要

方法概要

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

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

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

字段详细资料

artifactId

artifactVersion

groupId

packageName

sourceFolder

apiDocPath

modelDocPath

parcelizeModels

enumPropertyNaming

构造器详细资料

AbstractKotlinCodegen

方法详细资料

apiDocFileFolder

apiFileFolder

escapeQuotationMark

escapeReservedWord

escapeUnsafeCharacters

getEnumPropertyNaming

setEnumPropertyNaming

getSchemaType

getTypeDeclaration

modelDocFileFolder

modelFileFolder

postProcessModels

processOpts

setArtifactId

setArtifactVersion

setGroupId

setPackageName

setSourceFolder

getParcelizeModels

setParcelizeModels

toEnumVarName

toInstantiationType

toModelImport

toModelName

toOperationId

toModelFilename

isReservedWord

needToImport

toEnumValue

isDataTypeString

toParamName

toVarName

toRegularExpression

postProcessFile