org.openapitools.codegen.languages

Class ApexClientCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractJavaCodegen

org.openapitools.codegen.languages.ApexClientCodegen

All Implemented Interfaces:

CodegenConfig

public class ApexClientCodegen
extends AbstractJavaCodegen

Field Summary

Fields inherited from class org.openapitools.codegen.languages.AbstractJavaCodegen

apiDocPath, artifactDescription, artifactId, artifactUrl, artifactVersion, BOOLEAN_GETTER_PREFIX, BOOLEAN_GETTER_PREFIX_DEFAULT, booleanGetterPrefix, DATE_LIBRARY, dateLibrary, DEFAULT_LIBRARY, developerEmail, developerName, developerOrganization, developerOrganizationUrl, DISABLE_HTML_ESCAPING, disableHtmlEscaping, FULL_JAVA_UTIL, fullJavaUtil, groupId, invokerPackage, JAVA8_MODE, java8Mode, javaUtilPrefix, licenseName, licenseUrl, localVariablePrefix, modelDocPath, projectFolder, projectTestFolder, scmConnection, scmDeveloperConnection, scmUrl, serializableModel, serializeBigDecimalAsString, sourceFolder, SUPPORT_ASYNC, SUPPORT_JAVA6, supportAsync, supportJava6, testFolder, WITH_XML, withXml

Fields inherited from class org.openapitools.codegen.DefaultCodegen

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoId, gitUserId, 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

Constructor Summary

Constructors

Constructor and Description
ApexClientCodegen()

Method Summary

Modifier and Type	Method and Description
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	escapeText(String input)
CodegenModel	fromModel(String name, io.swagger.v3.oas.models.media.Schema model, Map<String,io.swagger.v3.oas.models.media.Schema> allDefinitions) Convert OAS Model object to Codegen Model object
CodegenOperation	fromOperation(String path, String httpMethod, io.swagger.v3.oas.models.Operation operation, Map<String,io.swagger.v3.oas.models.media.Schema> definitions, io.swagger.v3.oas.models.OpenAPI openAPI) Convert OAS Operation object to Codegen Operation object
String	getHelp()
String	getName()
CodegenType	getTag()
void	preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
void	processOpts()
void	setApiVersion(String apiVersion)
void	setBuildMethod(String buildMethod)
void	setClassPrefix(String classPrefix)
void	setNamedCredential(String namedCredential)
void	setParameterExampleValue(CodegenParameter p) Return the example value of the parameter.
protected String	setPropertyExampleValue(CodegenProperty p)
String	toApiName(String name) Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty
String	toDefaultValue(io.swagger.v3.oas.models.media.Schema p) Return the default value of the property
String	toExampleValue(io.swagger.v3.oas.models.media.Schema p) Return the example value of the property
String	toModelName(String name) Output the proper model name (capitalized).
String	toModelTestFilename(String name) Return the capitalized file name of the model test
void	updateCodegenPropertyEnum(CodegenProperty var) Update codegen property's enum by adding "enumVars" (with name and value)

Methods inherited from class org.openapitools.codegen.languages.AbstractJavaCodegen

apiDocFileFolder, apiFileFolder, apiTestFileFolder, convertPropertyToBoolean, escapeUnsafeCharacters, getAccept, getAlias, getInvokerPackage, getSchemaType, getTypeDeclaration, modelDocFileFolder, modelFileFolder, needToImport, postProcessModelProperty, postProcessModels, postProcessOperationsWithModels, postProcessParameter, sanitizeTag, setArtifactDescription, setArtifactId, setArtifactUrl, setArtifactVersion, setBooleanGetterPrefix, setDateLibrary, setDeveloperEmail, setDeveloperName, setDeveloperOrganization, setDeveloperOrganizationUrl, setDisableHtmlEscaping, setFullJavaUtil, setGroupId, setInvokerPackage, setJava8Mode, setLicenseName, setLicenseUrl, setLocalVariablePrefix, setScmConnection, setScmDeveloperConnection, setScmUrl, setSerializableModel, setSerializeBigDecimalAsString, setSourceFolder, setSupportAsync, setSupportJava6, setTestFolder, setWithXml, toApiDocFilename, toApiFilename, toApiTestFilename, toBooleanGetter, toEnumName, toEnumValue, toEnumVarName, toModelDocFilename, toModelFilename, toOperationId, toParamName, toRegularExpression, toVarName, writePropertyBack

Methods inherited from class org.openapitools.codegen.DefaultCodegen

addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOperationToGroup, addOption, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, embeddedTemplateDir, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromFormProperty, fromOperation, fromParameter, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, 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, isHideGenerationTimestamp, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelsEnum, postProcessOperations, postProcessSupportingFileData, processCompiler, processOpenAPI, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoId, setGitUserId, 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, toApiImport, toApiVarName, toArrayModelParamName, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toGetter, toInstantiationType, toModelImport, toSetter, typeMapping, underscore, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openapitools.codegen.CodegenConfig

additionalProperties, addOperationToGroup, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeTextWhileAllowingNewLines, fileSuffix, fromOperation, fromSecurity, generateExamplePath, getCommonTemplateDir, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getTypeDeclaration, importMapping, instantiationTypes, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessOperations, postProcessSupportingFileData, processCompiler, processOpenAPI, reservedWords, reservedWordsMappings, sanitizeName, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toApiVarName, toGetter, toModelImport, toSetter, typeMapping, vendorExtensions

Constructor Detail

ApexClientCodegen

public ApexClientCodegen()

Method Detail

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class AbstractJavaCodegen

escapeReservedWord

public String escapeReservedWord(String name)

Description copied from class: DefaultCodegen

Return the escaped name of the reserved word

Specified by:

escapeReservedWord in interface CodegenConfig

Overrides:

escapeReservedWord in class AbstractJavaCodegen

Parameters:

name - the name to be escaped

Returns:

the escaped reserved word

throws Runtime exception as reserved word is not allowed (default behavior)

toModelName

public String toModelName(String name)

Description copied from class: DefaultCodegen

Output the proper model name (capitalized). In case the name belongs to the TypeSystem it won't be renamed.

Specified by:

toModelName in interface CodegenConfig

Overrides:

toModelName in class AbstractJavaCodegen

Parameters:

name - the name of the model

Returns:

capitalized model name

toDefaultValue

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

Description copied from class: DefaultCodegen

Return the default value of the property

Overrides:

toDefaultValue in class AbstractJavaCodegen

Parameters:

p - Property schema

Returns:

string presentation of the default value of the property

setParameterExampleValue

public void setParameterExampleValue(CodegenParameter p)

Description copied from class: DefaultCodegen

Return the example value of the parameter.

Overrides:

setParameterExampleValue in class AbstractJavaCodegen

Parameters:

p - Codegen parameter

setPropertyExampleValue

protected String setPropertyExampleValue(CodegenProperty p)

fromModel

public CodegenModel fromModel(String name,
                              io.swagger.v3.oas.models.media.Schema model,
                              Map<String,io.swagger.v3.oas.models.media.Schema> allDefinitions)

Description copied from class: DefaultCodegen

Convert OAS Model object to Codegen Model object

Specified by:

fromModel in interface CodegenConfig

Overrides:

fromModel in class AbstractJavaCodegen

Parameters:

name - the name of the model

model - OAS Model object

allDefinitions - a map of all OAS models from the spec

Returns:

Codegen Model object

preprocessOpenAPI

public void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)

Specified by:

preprocessOpenAPI in interface CodegenConfig

Overrides:

preprocessOpenAPI in class AbstractJavaCodegen

fromOperation

public CodegenOperation fromOperation(String path,
                                      String httpMethod,
                                      io.swagger.v3.oas.models.Operation operation,
                                      Map<String,io.swagger.v3.oas.models.media.Schema> definitions,
                                      io.swagger.v3.oas.models.OpenAPI openAPI)

Description copied from class: DefaultCodegen

Convert OAS Operation object to Codegen Operation object

Specified by:

fromOperation in interface CodegenConfig

Overrides:

fromOperation in class AbstractJavaCodegen

Parameters:

path - the path of the operation

httpMethod - HTTP method

operation - OAS operation object

definitions - a map of OAS models

openAPI - a OAS object representing the spec

Returns:

Codegen Operation object

escapeQuotationMark

public String escapeQuotationMark(String input)

Description copied from class: DefaultCodegen

Escape single and/or double quote to avoid code injection

Specified by:

escapeQuotationMark in interface CodegenConfig

Overrides:

escapeQuotationMark in class AbstractJavaCodegen

Parameters:

input - String to be cleaned up

Returns:

string with quotation mark removed or escaped

setBuildMethod

public void setBuildMethod(String buildMethod)

setNamedCredential

public void setNamedCredential(String namedCredential)

setClassPrefix

public void setClassPrefix(String classPrefix)

setApiVersion

public void setApiVersion(String apiVersion)

escapeText

public String escapeText(String input)

Specified by:

escapeText in interface CodegenConfig

Overrides:

escapeText in class DefaultCodegen

toModelTestFilename

public String toModelTestFilename(String name)

Description copied from class: DefaultCodegen

Return the capitalized file name of the model test

Specified by:

toModelTestFilename in interface CodegenConfig

Overrides:

toModelTestFilename in class DefaultCodegen

Parameters:

name - the model name

Returns:

the file name of the model

toExampleValue

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

Description copied from class: DefaultCodegen

Return the example value of the property

Overrides:

toExampleValue in class AbstractJavaCodegen

Parameters:

p - Property schema

Returns:

string presentation of the example value of the property

toApiName

public String toApiName(String name)

Description copied from class: DefaultCodegen

Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty

Specified by:

toApiName in interface CodegenConfig

Overrides:

toApiName in class AbstractJavaCodegen

Parameters:

name - the name of the Api

Returns:

capitalized Api name ending with "Api"

updateCodegenPropertyEnum

public void updateCodegenPropertyEnum(CodegenProperty var)

Description copied from class: DefaultCodegen

Update codegen property's enum by adding "enumVars" (with name and value)

Overrides:

updateCodegenPropertyEnum in class DefaultCodegen

Parameters:

var - list of CodegenProperty

getTag

public CodegenType getTag()

Specified by:

getTag in interface CodegenConfig

Overrides:

getTag in class DefaultCodegen

getName

public String getName()

Specified by:

getName in interface CodegenConfig

Overrides:

getName in class DefaultCodegen

getHelp

public String getHelp()

Specified by:

getHelp in interface CodegenConfig

Overrides:

getHelp in class DefaultCodegen