org.openapitools.codegen.languages

类 CppQt5ClientCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractCppCodegen

org.openapitools.codegen.languages.CppQt5ClientCodegen

所有已实现的接口:

CodegenConfig

public class CppQt5ClientCodegen
extends AbstractCppCodegen
implements CodegenConfig

字段概要

字段

限定符和类型	字段和说明
protected String	apiVersion
static String	CPP_NAMESPACE
static String	CPP_NAMESPACE_DESC
protected String	cppNamespace
protected Set<String>	foundationClasses
protected Map<String,String>	namespaces
static String	OPTIONAL_PROJECT_FILE_DESC
protected boolean	optionalProjectFileFlag
protected String	PREFIX
protected String	sourceFolder
protected Set<String>	systemIncludes

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

构造器概要

构造器

构造器和说明
CppQt5ClientCodegen()

方法概要

限定符和类型	方法和说明
String	apiFileFolder() Location to write api files.
String	getHelp() Returns human-friendly help for the generator.
String	getName() Configures a friendly name for the generator.
String	getSchemaType(io.swagger.v3.oas.models.media.Schema p) Optional - OpenAPI type conversion.
CodegenType	getTag() Configures the type of generator.
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p) Optional - type declaration.
String	getTypeDeclaration(String str) Output the type declaration of a given name
String	modelFileFolder() Location to write model files.
void	processOpts()
void	setOptionalProjectFileFlag(boolean flag)
String	toApiFilename(String name) Return the file name of the Api Test
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	toModelImport(String name) Return the fully-qualified "Model" name for import
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.languages.AbstractCppCodegen

escapeQuotationMark, escapeReservedWord, escapeUnsafeCharacters, fromProperty, postProcessFile, toApiName, toBooleanGetter, toModelName, toOperationId

从类继承的方法 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, 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, 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, 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, toApiVarName, toArrayModelParamName, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExamples, toExampleValue, toGetter, toGetter, toInstantiationType, toModelDocFilename, 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, escapeQuotationMark, escapeReservedWord, escapeText, escapeTextWhileAllowingNewLines, escapeUnsafeCharacters, fileSuffix, fromModel, fromOperation, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getCommonTemplateDir, getDocExtension, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, 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, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelName, toModelTestFilename, toSetter, typeMapping, vendorExtensions

字段详细资料

CPP_NAMESPACE

public static final String CPP_NAMESPACE

另请参阅:

常量字段值

CPP_NAMESPACE_DESC

public static final String CPP_NAMESPACE_DESC

另请参阅:

常量字段值

OPTIONAL_PROJECT_FILE_DESC

public static final String OPTIONAL_PROJECT_FILE_DESC

另请参阅:

常量字段值

PREFIX

protected final String PREFIX

另请参阅:

常量字段值

foundationClasses

protected Set<String> foundationClasses

sourceFolder

protected String sourceFolder

apiVersion

protected String apiVersion

namespaces

protected Map<String,String> namespaces

systemIncludes

protected Set<String> systemIncludes

cppNamespace

protected String cppNamespace

optionalProjectFileFlag

protected boolean optionalProjectFileFlag

构造器详细资料

CppQt5ClientCodegen

public CppQt5ClientCodegen()

方法详细资料

processOpts

public void processOpts()

指定者:

processOpts 在接口中 CodegenConfig

覆盖:

processOpts 在类中 AbstractCppCodegen

getTag

public CodegenType getTag()

Configures the type of generator.

指定者:

getTag 在接口中 CodegenConfig

覆盖:

getTag 在类中 DefaultCodegen

返回:

the CodegenType for this generator

另请参阅:

CodegenType

getName

public String getName()

Configures a friendly name for the generator. This will be used by the generator to select the library with the -g flag.

指定者:

getName 在接口中 CodegenConfig

覆盖:

getName 在类中 DefaultCodegen

返回:

the friendly name for the generator

getHelp

public String getHelp()

Returns human-friendly help for the generator. Provide the consumer with help tips, parameters here

指定者:

getHelp 在接口中 CodegenConfig

覆盖:

getHelp 在类中 DefaultCodegen

返回:

A string value for the help message

toModelImport

public String toModelImport(String name)

从类复制的说明: DefaultCodegen

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

modelFileFolder

public String modelFileFolder()

Location to write model files. You can use the modelPackage() as defined when the class is instantiated

指定者:

modelFileFolder 在接口中 CodegenConfig

覆盖:

modelFileFolder 在类中 DefaultCodegen

apiFileFolder

public String apiFileFolder()

Location to write api files. You can use the apiPackage() as defined when the class is instantiated

指定者:

apiFileFolder 在接口中 CodegenConfig

覆盖:

apiFileFolder 在类中 DefaultCodegen

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

getTypeDeclaration

public String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)

Optional - type declaration. This is a String which is used by the templates to instantiate your types. There is typically special handling for different property types

指定者:

getTypeDeclaration 在接口中 CodegenConfig

覆盖:

getTypeDeclaration 在类中 DefaultCodegen

参数:

p - property schema

返回:

a string value used as the `dataType` field for model templates, `returnType` for api templates

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

getSchemaType

public String getSchemaType(io.swagger.v3.oas.models.media.Schema p)

Optional - OpenAPI type conversion. This is used to map OpenAPI types in a `Schema` into either language specific types via `typeMapping` or into complex models if there is not a mapping.

覆盖:

getSchemaType 在类中 DefaultCodegen

参数:

p - property schema

返回:

a string value of the type or complex model for this 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 在类中 AbstractCppCodegen

参数:

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 在类中 AbstractCppCodegen

参数:

name - Codegen property object

返回:

the sanitized parameter name

setOptionalProjectFileFlag

public void setOptionalProjectFileFlag(boolean flag)

getTypeDeclaration

public String getTypeDeclaration(String str)

从类复制的说明: DefaultCodegen

Output the type declaration of a given name

指定者:

getTypeDeclaration 在接口中 CodegenConfig

覆盖:

getTypeDeclaration 在类中 AbstractCppCodegen

参数:

str - name

返回:

a string presentation of the type