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

All Implemented Interfaces:

CodegenConfig
```
public class RClientCodegen
extends DefaultCodegen
implements CodegenConfig
```
Mustache templates are located in src/main/resources/r/ (root templates shared across all libraries) and src/main/resources/r/libraries/ (library-specific overrides). A library-specific template shadows a root-level template of the same name.

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`apiDocPath`
`static String`	`DEFAULT`
`protected String`	`errorObjectType`
`static String`	`EXCEPTION_PACKAGE`
`protected String`	`exceptionPackage`
`protected Map<String,String>`	`exceptionPackages`
`static String`	`GENERATE_WRAPPER`
`protected boolean`	`generateWrapper`
`static String`	`HTTR`
`static String`	`HTTR2`
`protected Set<String>`	`itemReservedWords`
`protected String`	`modelDocPath`
`static String`	`OPERATIONID_NAMING`
`protected String`	`operationIdNaming`
`protected String`	`packageName`
`protected String`	`packageVersion`
`protected boolean`	`returnExceptionOnFailure`
`static String`	`RLANG`
`protected String`	`testFolder`
`static String`	`USE_DEFAULT_EXCEPTION`
`static String`	`USE_RLANG_EXCEPTION`
`protected boolean`	`useDefaultExceptionHandling`
`protected boolean`	`useOneOfDiscriminatorLookup`
`protected boolean`	`useRlangExceptionHandling`

Fields inherited from class org.openapitools.codegen.DefaultCodegen
additionalProperties, addOneOfInterfaceImports, addOneOfInterfaces, addSuffixToDuplicateOperationNicknames, allowUnicodeIdentifiers, apiDocTemplateFiles, apiNamePrefix, apiNameSuffix, apiPackage, apiTemplateFiles, apiTestTemplateFiles, autosetConstants, cliOptions, DefaultFeatureSet, defaultIncludes, defaultToEmptyContainer, disallowAdditionalPropertiesIfNotPresent, docExtension, embeddedTemplateDir, enableMinimalUpdate, enablePostProcessFile, ensureUniqueParams, enumNameMapping, enumUnknownDefaultCase, enumUnknownDefaultCaseName, falseSchema, filesMetadataFilename, fileSuffix, generatorMetadata, gitHost, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importBaseType, importContainerType, importMapping, inlineSchemaNameMapping, inlineSchemaOption, inputSpec, instantiationTypes, JSON_MIME_PATTERN, JSON_VENDOR_MIME_PATTERN, languageSpecificPrimitives, legacyDiscriminatorBehavior, library, loadDeepObjectIntoItems, modelDocTemplateFiles, modelNameMapping, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, nameMapping, openAPI, openapiGeneratorIgnoreList, openapiNormalizer, operationIdNameMapping, outputFolder, parameterNameMapping, prependFormOrBodyParameters, releaseNote, removeEnumValuePrefix, removeOperationIdPrefix, removeOperationIdPrefixCount, removeOperationIdPrefixDelimiter, reservedWords, reservedWordsMappings, schemaMapping, serverVariables, skipOperationExample, skipOverwrite, skipSortingOperations, sortModelPropertiesByRequiredFlag, sortParamsByRequiredFlag, specialCharReplacements, SPLIT_ON_SEMICOLON_OR_NEWLINE_REGEX, strictSpecBehavior, supportedLibraries, supportingFiles, supportsAdditionalPropertiesWithComposedSchema, supportsInheritance, supportsMixins, supportsMultipleInheritance, templateDir, templateOutputDirs, testPackage, trueSchema, typeAliases, typeMapping, useOneOfInterfaces, vendorExtensions, versionMetadataFilename, XML_MIME_PATTERN

Constructor Summary

Constructors
Constructor Description

RClientCodegen()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`apiDocFileFolder()`
`String`	`apiFileFolder()`
`String`	`apiTestFileFolder()`
`String`	`constructExampleCode(CodegenModel codegenModel, HashMap<String,CodegenModel> modelMaps, int depth)`
`String`	`constructExampleCode(CodegenParameter codegenParameter, HashMap<String,CodegenModel> modelMaps)`
`String`	`constructExampleCode(CodegenProperty codegenProperty, HashMap<String,CodegenModel> modelMaps, int depth)`
`String`	`constructRdocType(CodegenProperty codegenProperty)`	Return the R doc type (e.g. list(\link{Media}), character)
`Map<String,String>`	`createMapping(String key, String value)`
`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
`GeneratorLanguage`	`generatorLanguage()`
`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 language-specific type declaration of the property.
`boolean`	`getUseOneOfDiscriminatorLookup()`
`String`	`modelDocFileFolder()`
`String`	`modelFileFolder()`
`String`	`modelTestFileFolder()`
`protected boolean`	`needToImport(String type)`	Check the type to see if it needs import the library/module/package
`void`	`postProcess()`
`ModelsMap`	`postProcessModels(ModelsMap objs)`
`OperationsMap`	`postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels)`
`void`	`processOpts()`
`void`	`setExceptionPackageToUse(String exceptionPackage)`
`void`	`setOperationIdNaming(String operationIdNaming)`
`void`	`setParameterExampleValue(CodegenParameter p)`	Return the example value of the parameter.
`void`	`setParameterExampleValue(CodegenParameter codegenParameter, io.swagger.v3.oas.models.parameters.Parameter parameter)`	Return the example value of the parameter.
`String`	`toApiDocFilename(String name)`	Return the file name of the Api Documentation
`String`	`toApiFilename(String name)`	Return the file name of the Api
`String`	`toApiName(String name)`	Output the API (class) name (capitalized) ending with the specified or default suffix Return DefaultApi if name is empty
`String`	`toApiTestFilename(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`	`toEnumDefaultValue(String value, String datatype)`	Return the enum default value in the language specified format
`String`	`toEnumName(CodegenProperty property)`	Return the Enum name (e.g.
`String`	`toEnumValue(String value, String datatype)`	Return the enum value in the language specified format e.g. status becomes "status"
`String`	`toEnumVarName(String name, String datatype)`	Return the sanitized variable name for enum
`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)`	Converts the OpenAPI schema name to a model name suitable for the current code generator.
`String`	`toModelTestFilename(String name)`	Return the capitalized file name of the model test
`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.

Methods inherited from class org.openapitools.codegen.DefaultCodegen
addAdditionPropertiesToCodeGenModel, addBodyModelSchema, addHeaders, addImport, addImport, addImport, addImports, addImports, addImports, addImportsForPropertyType, addImportsToOneOfInterface, additionalProperties, addMustacheLambdas, addOneOfInterfaceModel, addOneOfNameExtension, addOperationToGroup, addOption, addOption, addParentContainer, addParentFromContainer, addProperties, addRegularExpressionDelimiter, addRequiredVarsMap, addSwitch, addVars, addVars, addVarsRequiredVarsAdditionalProps, apiDocFilename, apiDocTemplateFiles, apiFilename, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildEnumVars, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, convertPropertyToBooleanAndWriteBack, convertPropertyToStringAndWriteBack, convertPropertyToTypeAndWriteBack, createDiscriminator, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, enumNameMapping, escapeText, escapeTextInSingleQuotes, escapeTextWhileAllowingNewLines, executePostProcessor, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromModel, fromOperation, fromParameter, fromProperty, fromProperty, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, generatorLanguageVersion, getAdditionalPropertiesName, getAddSuffixToDuplicateOperationNicknames, getAlias, getAllModels, getAllOfDescendants, getCollectionFormat, getCollectionFormat, getConsumesInfo, getContent, getContentType, getDisallowAdditionalPropertiesIfNotPresent, getDiscriminatorPropertyType, getDiscriminatorSchema, getDocExtension, getEnumDefaultValue, getEnumUnknownDefaultCase, getEnumValueForProperty, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getItemsName, getLegacyDiscriminatorBehavior, getLibrary, getModelNameToSchemaCache, getMostInnerItems, getObjectAsStringList, getObjectAsStringListMap, getObjectAsStringMap, getOneOfAnyOfDescendants, getOpenapiGeneratorIgnoreList, getOrGenerateOperationId, getOutputDir, getParameterDataType, getProducesInfo, getPropertyAsStringList, getPropertyAsStringListMap, getPropertyAsStringMap, getReleaseNote, getSchemaAdditionalProperties, getSchemaFromBooleanOrSchema, getSingleSchemaType, getSupportedVendorExtensions, getSymbolName, getTemplatingEngine, getterAndSetterCapitalize, getTypeDeclaration, getUseInlineModelResolver, getUseOneOfInterfaces, getUseOpenapiNormalizer, getVersionMetadataFilename, handleConstantParams, handleMethodResponse, handleMethodResponse, handleSpecialCharacters, hasBodyParameter, hasFormParameter, importMapping, initializeSpecialCharacterMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isJsonMimeType, isJsonVendorMimeType, isLibrary, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isReservedWord, isSkipOperationExample, isSkipOverwrite, isSkipSortingOperations, isStrictSpecBehavior, isTypeErasedGenerics, isXmlMimeType, languageSpecificPrimitives, lowerCamelCase, modelDocTemplateFiles, modelFilename, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestTemplateFiles, modifyFeatureSet, nameMapping, openapiGeneratorIgnoreList, openapiNormalizer, operationIdNameMapping, outputFolder, parameterNameMapping, postProcessAllModels, postProcessEnumVars, postProcessFile, postProcessModelProperty, postProcessModelsEnum, postProcessParameter, postProcessResponseWithProperty, postProcessSupportingFileData, postProcessWebhooksWithModels, preprocessOpenAPI, processCompiler, processOpenAPI, processTemplatingEngine, processTestExampleData, removeImport, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, removeSelfReferenceImports, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, sanitizeTag, schemaMapping, serverVariableOverrides, setAddProps, setCircularReferences, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnumDiscriminatorDefaultValue, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setNonArrayMapProperty, setOpenAPI, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterEncodingValues, setParameterExamples, setParameterExampleValue, setParameterNullable, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOperationExample, setSkipOverwrite, setSkipSortingOperations, setStrictSpecBehavior, setTemplatingEngine, setUseOneOfInterfaces, shouldAddImport, shouldOverwrite, SortModelPropertiesByRequiredFlag, SortParametersByRequiredFlag, specVersionGreaterThanOrEqualTo310, supportedLibraries, supportingFiles, templateDir, templateOutputDirs, testPackage, toAllOfName, toAnyOfName, toApiImport, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultParameterValue, toDefaultParameterValue, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toExampleValue, toGetter, toInstantiationType, toMediaTypeSchemaName, toModelImport, toModelImportMap, toOneOfName, toSetter, toTestCaseName, typeMapping, unaliasPropertySchema, unaliasSchema, updateAllModels, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateEnumVarsWithExtensions, updateModelForAnyType, updateModelForComposedSchema, updateModelForInteger, updateModelForNumber, updateModelForObject, updateModelForString, updateOption, updateParameterForString, updatePropertyForAnyType, updatePropertyForArray, updatePropertyForInteger, updatePropertyForMap, updatePropertyForMap, updatePropertyForNumber, updatePropertyForObject, updatePropertyForString, updateRequestBodyForArray, updateRequestBodyForMap, updateRequestBodyForObject, updateRequestBodyForPrimitiveType, updateRequestBodyForString, useCodegenAsMustacheParentContext, vendorExtensions, writePropertyBack

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, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, enumNameMapping, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromModel, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generatorLanguageVersion, getAddSuffixToDuplicateOperationNicknames, getDocExtension, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOpenapiGeneratorIgnoreList, getOutputDir, getReleaseNote, getSupportedVendorExtensions, getTemplatingEngine, getTypeDeclaration, getUseInlineModelResolver, getUseOpenapiNormalizer, getVersionMetadataFilename, importMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isSkipSortingOperations, isStrictSpecBehavior, isTypeErasedGenerics, languageSpecificPrimitives, modelDocTemplateFiles, modelFilename, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestTemplateFiles, nameMapping, openapiGeneratorIgnoreList, openapiNormalizer, operationIdNameMapping, outputFolder, parameterNameMapping, postProcessAllModels, postProcessFile, postProcessModelProperty, postProcessParameter, postProcessResponseWithProperty, postProcessSupportingFileData, postProcessWebhooksWithModels, preprocessOpenAPI, processCompiler, processOpenAPI, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, schemaMapping, serverVariableOverrides, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOpenAPI, setOutputDir, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setSkipOperationExample, setSkipOverwrite, setSkipSortingOperations, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, templateOutputDirs, testPackage, toApiImport, toApiVarName, toBooleanGetter, toGetter, toModelImport, toModelImportMap, toSetter, typeMapping, unaliasSchema, updateAllModels, vendorExtensions

- Field Detail
  - packageName
```
protected String packageName
```
  - packageVersion
```
protected String packageVersion
```
  - apiDocPath
```
protected String apiDocPath
```
  - modelDocPath
```
protected String modelDocPath
```
  - testFolder
```
protected String testFolder
```
  - returnExceptionOnFailure
```
protected boolean returnExceptionOnFailure
```
  - exceptionPackage
```
protected String exceptionPackage
```
  - exceptionPackages
```
protected Map<String,String> exceptionPackages
```
  - itemReservedWords
```
protected Set<String> itemReservedWords
```
  - EXCEPTION_PACKAGE
```
public static final String EXCEPTION_PACKAGE
```
    See Also:
    
    Constant Field Values
  - USE_DEFAULT_EXCEPTION
```
public static final String USE_DEFAULT_EXCEPTION
```
    See Also:
    
    Constant Field Values
  - USE_RLANG_EXCEPTION
```
public static final String USE_RLANG_EXCEPTION
```
    See Also:
    
    Constant Field Values
  - GENERATE_WRAPPER
```
public static final String GENERATE_WRAPPER
```
    See Also:
    
    Constant Field Values
  - DEFAULT
```
public static final String DEFAULT
```
    See Also:
    
    Constant Field Values
  - RLANG
```
public static final String RLANG
```
    See Also:
    
    Constant Field Values
  - HTTR
```
public static final String HTTR
```
    See Also:
    
    Constant Field Values
  - HTTR2
```
public static final String HTTR2
```
    See Also:
    
    Constant Field Values
  - OPERATIONID_NAMING
```
public static final String OPERATIONID_NAMING
```
    See Also:
    
    Constant Field Values
  - useDefaultExceptionHandling
```
protected boolean useDefaultExceptionHandling
```
  - useRlangExceptionHandling
```
protected boolean useRlangExceptionHandling
```
  - errorObjectType
```
protected String errorObjectType
```
  - operationIdNaming
```
protected String operationIdNaming
```
  - generateWrapper
```
protected boolean generateWrapper
```
  - useOneOfDiscriminatorLookup
```
protected boolean useOneOfDiscriminatorLookup
```
- Constructor Detail
  - RClientCodegen
```
public RClientCodegen()
```
- Method Detail
  - 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
  - processOpts
```
public void processOpts()
```
    Specified by:
    
    processOpts in interface CodegenConfig
    
    Overrides:
    
    processOpts in class DefaultCodegen
  - 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 DefaultCodegen
    
    Parameters:
    
    name - the name to be escaped
    
    Returns:
    
    the escaped reserved word
    throws Runtime exception as reserved word is not allowed (default behavior)
  - apiFileFolder
```
public String apiFileFolder()
```
    Specified by:
    
    apiFileFolder in interface CodegenConfig
    
    Overrides:
    
    apiFileFolder in class DefaultCodegen
  - modelFileFolder
```
public String modelFileFolder()
```
    Specified by:
    
    modelFileFolder in interface CodegenConfig
    
    Overrides:
    
    modelFileFolder in class DefaultCodegen
  - toParamName
```
public String toParamName(String name)
```
    Description copied from class: DefaultCodegen
    
    Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.
    
    Specified by:
    
    toParamName in interface CodegenConfig
    
    Overrides:
    
    toParamName in class DefaultCodegen
    
    Parameters:
    
    name - Codegen property object
    
    Returns:
    
    the sanitized parameter name
  - toVarName
```
public String toVarName(String name)
```
    Description copied from class: DefaultCodegen
    
    Return the variable name by removing invalid characters and proper escaping if it's a reserved word.
    
    Overrides:
    
    toVarName in class DefaultCodegen
    
    Parameters:
    
    name - the variable name
    
    Returns:
    
    the sanitized variable name
  - toModelFilename
```
public String toModelFilename(String name)
```
    Description copied from class: DefaultCodegen
    
    Return the capitalized file name of the model
    
    Specified by:
    
    toModelFilename in interface CodegenConfig
    
    Overrides:
    
    toModelFilename in class DefaultCodegen
    
    Parameters:
    
    name - the model name
    
    Returns:
    
    the file name of the model
  - toModelName
```
public String toModelName(String name)
```
    Description copied from class: DefaultCodegen
    
    Converts the OpenAPI schema name to a model name suitable for the current code generator. May be overridden for each programming language. In case the name belongs to the TypeSystem it won't be renamed.
    
    Specified by:
    
    toModelName in interface CodegenConfig
    
    Overrides:
    
    toModelName in class DefaultCodegen
    
    Parameters:
    
    name - the name of the model
    
    Returns:
    
    capitalized model name
  - toApiFilename
```
public String toApiFilename(String name)
```
    Description copied from class: DefaultCodegen
    
    Return the file name of the Api
    
    Specified by:
    
    toApiFilename in interface CodegenConfig
    
    Overrides:
    
    toApiFilename in class DefaultCodegen
    
    Parameters:
    
    name - the file name of the Api
    
    Returns:
    
    the file name of the Api
  - apiDocFileFolder
```
public String apiDocFileFolder()
```
    Specified by:
    
    apiDocFileFolder in interface CodegenConfig
    
    Overrides:
    
    apiDocFileFolder in class DefaultCodegen
  - modelDocFileFolder
```
public String modelDocFileFolder()
```
    Specified by:
    
    modelDocFileFolder in interface CodegenConfig
    
    Overrides:
    
    modelDocFileFolder in class DefaultCodegen
  - toModelDocFilename
```
public String toModelDocFilename(String name)
```
    Description copied from class: DefaultCodegen
    
    Return the capitalized file name of the model documentation
    
    Specified by:
    
    toModelDocFilename in interface CodegenConfig
    
    Overrides:
    
    toModelDocFilename in class DefaultCodegen
    
    Parameters:
    
    name - the model name
    
    Returns:
    
    the file name of the model
  - toApiDocFilename
```
public String toApiDocFilename(String name)
```
    Description copied from class: DefaultCodegen
    
    Return the file name of the Api Documentation
    
    Specified by:
    
    toApiDocFilename in interface CodegenConfig
    
    Overrides:
    
    toApiDocFilename in class DefaultCodegen
    
    Parameters:
    
    name - the file name of the Api
    
    Returns:
    
    the file name of the Api
  - toApiName
```
public String toApiName(String name)
```
    Description copied from class: DefaultCodegen
    
    Output the API (class) name (capitalized) ending with the specified or default suffix Return DefaultApi if name is empty
    
    Specified by:
    
    toApiName in interface CodegenConfig
    
    Overrides:
    
    toApiName in class DefaultCodegen
    
    Parameters:
    
    name - the name of the Api
    
    Returns:
    
    capitalized Api name
  - getTypeDeclaration
```
public String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)
```
    Description copied from class: DefaultCodegen
    
    Output the language-specific type declaration of the property.
    
    Specified by:
    
    getTypeDeclaration in interface CodegenConfig
    
    Overrides:
    
    getTypeDeclaration in class DefaultCodegen
    
    Parameters:
    
    p - property schema
    
    Returns:
    
    a string presentation of the property type
  - getSchemaType
```
public String getSchemaType(io.swagger.v3.oas.models.media.Schema p)
```
    Description copied from class: DefaultCodegen
    
    returns the OpenAPI type for the property. Use getAlias to handle $ref of primitive type
    
    Overrides:
    
    getSchemaType in class DefaultCodegen
    
    Parameters:
    
    p - property schema
    
    Returns:
    
    string presentation of the type
  - toOperationId
```
public String toOperationId(String operationId)
```
    Description copied from class: DefaultCodegen
    
    Return the operation ID (method name)
    
    Overrides:
    
    toOperationId in class DefaultCodegen
    
    Parameters:
    
    operationId - operation ID
    
    Returns:
    
    the sanitized method name
  - postProcessModels
```
public ModelsMap postProcessModels(ModelsMap objs)
```
    Specified by:
    
    postProcessModels in interface CodegenConfig
    
    Overrides:
    
    postProcessModels in class DefaultCodegen
  - needToImport
```
protected boolean needToImport(String type)
```
    Description copied from class: DefaultCodegen
    
    Check the type to see if it needs import the library/module/package
    
    Overrides:
    
    needToImport in class DefaultCodegen
    
    Parameters:
    
    type - name of the type
    
    Returns:
    
    true if the library/module/package of the corresponding type needs to be imported
  - setExceptionPackageToUse
```
public void setExceptionPackageToUse(String exceptionPackage)
```
  - getUseOneOfDiscriminatorLookup
```
public boolean getUseOneOfDiscriminatorLookup()
```
  - setOperationIdNaming
```
public void setOperationIdNaming(String operationIdNaming)
```
  - 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 DefaultCodegen
    
    Parameters:
    
    input - String to be cleaned up
    
    Returns:
    
    string with quotation mark removed or escaped
  - escapeUnsafeCharacters
```
public String escapeUnsafeCharacters(String input)
```
    Description copied from class: DefaultCodegen
    
    override with any special text escaping logic to handle unsafe characters so as to avoid code injection
    
    Specified by:
    
    escapeUnsafeCharacters in interface CodegenConfig
    
    Overrides:
    
    escapeUnsafeCharacters in class DefaultCodegen
    
    Parameters:
    
    input - String to be cleaned up
    
    Returns:
    
    string with unsafe characters removed or escaped
  - createMapping
```
public Map<String,String> createMapping(String key,
                                              String value)
```
  - toEnumValue
```
public String toEnumValue(String value,
                          String datatype)
```
    Description copied from class: DefaultCodegen
    
    Return the enum value in the language specified format e.g. status becomes "status"
    
    Overrides:
    
    toEnumValue in class DefaultCodegen
    
    Parameters:
    
    value - enum variable name
    
    datatype - data type
    
    Returns:
    
    the sanitized value for enum
  - toEnumDefaultValue
```
public String toEnumDefaultValue(String value,
                                 String datatype)
```
    Description copied from class: DefaultCodegen
    
    Return the enum default value in the language specified format
    
    Overrides:
    
    toEnumDefaultValue in class DefaultCodegen
    
    Parameters:
    
    value - enum variable name
    
    datatype - data type
    
    Returns:
    
    the default value for the enum
  - toEnumVarName
```
public String toEnumVarName(String name,
                            String datatype)
```
    Description copied from class: DefaultCodegen
    
    Return the sanitized variable name for enum
    
    Overrides:
    
    toEnumVarName in class DefaultCodegen
    
    Parameters:
    
    name - enum variable name
    
    datatype - data type
    
    Returns:
    
    the sanitized variable name for enum
  - toEnumName
```
public String toEnumName(CodegenProperty property)
```
    Description copied from class: DefaultCodegen
    
    Return the Enum name (e.g. StatusEnum given 'status')
    
    Overrides:
    
    toEnumName in class DefaultCodegen
    
    Parameters:
    
    property - Codegen property
    
    Returns:
    
    the Enum name
  - setParameterExampleValue
```
public void setParameterExampleValue(CodegenParameter p)
```
    Description copied from class: DefaultCodegen
    
    Return the example value of the parameter.
    
    Overrides:
    
    setParameterExampleValue in class DefaultCodegen
    
    Parameters:
    
    p - Codegen parameter
  - setParameterExampleValue
```
public void setParameterExampleValue(CodegenParameter codegenParameter,
                                     io.swagger.v3.oas.models.parameters.Parameter parameter)
```
    Return the example value of the parameter. Overrides the setParameterExampleValue(CodegenParameter, Parameter) method in DefaultCodegen to always call setParameterExampleValue(CodegenParameter) in this class, which adds single quotes around strings from the x-example property.
    
    Overrides:
    
    setParameterExampleValue in class DefaultCodegen
    
    Parameters:
    
    codegenParameter - Codegen parameter
    
    parameter - Parameter
  - toDefaultValue
```
public String toDefaultValue(io.swagger.v3.oas.models.media.Schema p)
```
    Return the default value of the property
    
    Overrides:
    
    toDefaultValue in class DefaultCodegen
    
    Parameters:
    
    p - OpenAPI property object
    
    Returns:
    
    string presentation of the default value of the property
  - apiTestFileFolder
```
public String apiTestFileFolder()
```
    Specified by:
    
    apiTestFileFolder in interface CodegenConfig
    
    Overrides:
    
    apiTestFileFolder in class DefaultCodegen
  - modelTestFileFolder
```
public String modelTestFileFolder()
```
    Specified by:
    
    modelTestFileFolder in interface CodegenConfig
    
    Overrides:
    
    modelTestFileFolder in class DefaultCodegen
  - toApiTestFilename
```
public String toApiTestFilename(String name)
```
    Description copied from class: DefaultCodegen
    
    Return the file name of the Api Test
    
    Specified by:
    
    toApiTestFilename in interface CodegenConfig
    
    Overrides:
    
    toApiTestFilename in class DefaultCodegen
    
    Parameters:
    
    name - the file name of the Api
    
    Returns:
    
    the file name of the Api
  - 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
  - postProcessOperationsWithModels
```
public OperationsMap postProcessOperationsWithModels(OperationsMap objs,
                                                     List<ModelMap> allModels)
```
    Specified by:
    
    postProcessOperationsWithModels in interface CodegenConfig
    
    Overrides:
    
    postProcessOperationsWithModels in class DefaultCodegen
  - constructRdocType
```
public String constructRdocType(CodegenProperty codegenProperty)
```
    Return the R doc type (e.g. list(\link{Media}), character)
    
    Parameters:
    
    codegenProperty - Codegen property
    
    Returns:
    
    R doc type
  - constructExampleCode
```
public String constructExampleCode(CodegenParameter codegenParameter,
                                   HashMap<String,CodegenModel> modelMaps)
```
  - constructExampleCode
```
public String constructExampleCode(CodegenProperty codegenProperty,
                                   HashMap<String,CodegenModel> modelMaps,
                                   int depth)
```
  - constructExampleCode
```
public String constructExampleCode(CodegenModel codegenModel,
                                   HashMap<String,CodegenModel> modelMaps,
                                   int depth)
```
  - postProcess
```
public void postProcess()
```
    Specified by:
    
    postProcess in interface CodegenConfig
    
    Overrides:
    
    postProcess in class DefaultCodegen
  - generatorLanguage
```
public GeneratorLanguage generatorLanguage()
```
    Specified by:
    
    generatorLanguage in interface CodegenConfig
    
    Overrides:
    
    generatorLanguage in class DefaultCodegen
  - toRegularExpression
```
public String toRegularExpression(String pattern)
```
    Description copied from class: DefaultCodegen
    
    Return the regular expression/JSON schema pattern (http://json-schema.org/latest/json-schema-validation.html#anchor33)
    
    Overrides:
    
    toRegularExpression in class DefaultCodegen
    
    Parameters:
    
    pattern - the pattern (regular expression)
    
    Returns:
    
    properly-escaped pattern

Class RClientCodegen

Field Summary

Fields inherited from class org.openapitools.codegen.DefaultCodegen

Constructor Summary

Method Summary

Methods inherited from class org.openapitools.codegen.DefaultCodegen

Methods inherited from class java.lang.Object

Methods inherited from interface org.openapitools.codegen.CodegenConfig

Field Detail

packageName

packageVersion

apiDocPath

modelDocPath

testFolder

returnExceptionOnFailure

exceptionPackage

exceptionPackages

itemReservedWords

EXCEPTION_PACKAGE

USE_DEFAULT_EXCEPTION

USE_RLANG_EXCEPTION

GENERATE_WRAPPER

DEFAULT

RLANG

HTTR

HTTR2

OPERATIONID_NAMING

useDefaultExceptionHandling

useRlangExceptionHandling

errorObjectType

operationIdNaming

generateWrapper

useOneOfDiscriminatorLookup

Constructor Detail

RClientCodegen

Method Detail

getTag

getName

getHelp

processOpts

escapeReservedWord

apiFileFolder

modelFileFolder

toParamName

toVarName

toModelFilename

toModelName

toApiFilename

apiDocFileFolder

modelDocFileFolder

toModelDocFilename

toApiDocFilename

toApiName

getTypeDeclaration

getSchemaType

toOperationId

postProcessModels

needToImport

setExceptionPackageToUse

getUseOneOfDiscriminatorLookup

setOperationIdNaming

escapeQuotationMark

escapeUnsafeCharacters

createMapping

toEnumValue

toEnumDefaultValue

toEnumVarName

toEnumName

setParameterExampleValue

setParameterExampleValue

toDefaultValue

apiTestFileFolder

modelTestFileFolder

toApiTestFilename

toModelTestFilename

postProcessOperationsWithModels

constructRdocType

constructExampleCode

constructExampleCode

constructExampleCode