LuaClientCodegen (swagger-codegen (core library) 2.4.2 API)

java.lang.Object
- io.swagger.codegen.DefaultCodegen
- - io.swagger.codegen.languages.LuaClientCodegen

All Implemented Interfaces:: CodegenConfig

public class LuaClientCodegen
extends DefaultCodegen
implements CodegenConfig

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`apiDocPath`
`protected String`	`luaRocksFilename`
`protected String`	`modelDocPath`
`protected String`	`packageName`
`protected String`	`packageVersion`
`protected String`	`specFolder`

Fields inherited from class io.swagger.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, releaseNote, removeOperationIdPrefix, reservedWords, reservedWordsMappings, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, templateDir, testPackage, typeAliases, typeMapping, vendorExtensions

Constructor Summary

Constructors
Constructor and Description

LuaClientCodegen()

Constructors
Constructor and Description
`LuaClientCodegen()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`apiDocFileFolder()`
`String`	`apiFileFolder()`
`String`	`apiTestFileFolder()`
`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
`String`	`getHelp()`
`String`	`getName()`
`String`	`getSwaggerType(io.swagger.models.properties.Property p)` returns the swagger type for the property
`CodegenType`	`getTag()`
`String`	`getTypeDeclaration(io.swagger.models.properties.Property p)` Output the type declaration of the property
`String`	`modelDocFileFolder()`
`String`	`modelFileFolder()`
`String`	`modelTestFileFolder()`
`protected boolean`	`needToImport(String type)` Check the type to see if it needs import the library/module/package
`Map<String,Object>`	`postProcessModels(Map<String,Object> objs)`
`Map<String,Object>`	`postProcessOperations(Map<String,Object> objs)`
`void`	`postProcessParameter(CodegenParameter parameter)` Overrides postProcessParameter to add a vendor extension "x-exportParamName".
`void`	`processOpts()`
`void`	`setLuaRocksFilename(String luaRocksFilename)`
`void`	`setPackageName(String packageName)`
`void`	`setPackageVersion(String packageVersion)`
`String`	`toApiDocFilename(String name)` Return the file name of the Api Documentation
`String`	`toApiFilename(String name)` Return the file name of the Api Test
`String`	`toApiName(String name)` Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty
`String`	`toApiTestFilename(String name)` Return the file name of the Api Test
`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.
`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`	`toModelImport(String name)` Return the fully-qualified "Model" name for import
`String`	`toModelName(String name)` Output the proper model name (capitalized).
`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`	`toVarName(String name)` Return the variable name by removing invalid characters and proper escaping if it's a reserved word.

Methods inherited from class io.swagger.codegen.DefaultCodegen
addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOperationToGroup, addOption, addOption, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, configureDataForTestTemplate, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromModel, fromModel, fromOperation, fromOperation, fromParameter, fromProperty, fromResponse, fromSecurity, generateExamplePath, getAlias, getCommonTemplateDir, getExamples, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getOrGenerateOperationId, getOutputDir, getParameterDataType, getReleaseNote, getSymbolName, getterAndSetterCapitalize, getTypeDeclaration, importMapping, initalizeSpecialCharacterMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isHideGenerationTimestamp, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessModelsEnum, postProcessOperationsWithModels, postProcessSupportingFileData, preprocessSwagger, processCompiler, processSwagger, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toApiVarName, toBooleanGetter, toDefaultValue, toDefaultValueWithParam, toExamples, toExampleValue, toGetter, toInstantiationType, toRegularExpression, toSetter, typeMapping, underscore, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writePropertyBack

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.swagger.codegen.CodegenConfig
additionalProperties, addOperationToGroup, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, fromModel, fromModel, fromOperation, fromOperation, fromSecurity, generateExamplePath, getCommonTemplateDir, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getTypeDeclaration, importMapping, instantiationTypes, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessOperationsWithModels, postProcessSupportingFileData, preprocessSwagger, processCompiler, processSwagger, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toApiVarName, toBooleanGetter, toGetter, toSetter, typeMapping, vendorExtensions

- Field Detail
  - specFolder
```
protected String specFolder
```
  - packageName
```
protected String packageName
```
  - packageVersion
```
protected String packageVersion
```
  - apiDocPath
```
protected String apiDocPath
```
  - modelDocPath
```
protected String modelDocPath
```
  - luaRocksFilename
```
protected String luaRocksFilename
```
- Constructor Detail
  - LuaClientCodegen
```
public LuaClientCodegen()
```
- Method Detail
  - getTag
```
public CodegenType getTag()
```
    Specified by:
    
    getTag in interface CodegenConfig
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface CodegenConfig
  - getHelp
```
public String getHelp()
```
    Specified by:
    
    getHelp in interface CodegenConfig
  - 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
  - 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
  - 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
  - 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 DefaultCodegen
    
    Parameters:
    name - the name of the model
    
    Returns:
    capitalized model 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
  - toApiFilename
```
public String toApiFilename(String name)
```
    Description copied from class: DefaultCodegen
    
    Return the file name of the Api Test
    
    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
  - 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
  - postProcessParameter
```
public void postProcessParameter(CodegenParameter parameter)
```
    Overrides postProcessParameter to add a vendor extension "x-exportParamName". This is useful when paramName starts with a lowercase letter, but we need that param to be exportable (starts with an Uppercase letter).
    
    Specified by:
    
    postProcessParameter in interface CodegenConfig
    
    Overrides:
    
    postProcessParameter in class DefaultCodegen
    
    Parameters:
    parameter - CodegenParameter object to be processed.
  - 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
  - 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 "Api" 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 ending with "Api"
  - getTypeDeclaration
```
public String getTypeDeclaration(io.swagger.models.properties.Property p)
```
    Description copied from class: DefaultCodegen
    
    Output the type declaration of the property
    
    Specified by:
    
    getTypeDeclaration in interface CodegenConfig
    
    Overrides:
    
    getTypeDeclaration in class DefaultCodegen
    
    Parameters:
    p - Swagger Property object
    
    Returns:
    a string presentation of the property type
  - getSwaggerType
```
public String getSwaggerType(io.swagger.models.properties.Property p)
```
    Description copied from class: DefaultCodegen
    
    returns the swagger type for the property
    
    Overrides:
    
    getSwaggerType in class DefaultCodegen
    
    Parameters:
    p - Swagger property object
    
    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
  - postProcessOperations
```
public Map<String,Object> postProcessOperations(Map<String,Object> objs)
```
    Specified by:
    
    postProcessOperations in interface CodegenConfig
    
    Overrides:
    
    postProcessOperations in class DefaultCodegen
  - postProcessModels
```
public Map<String,Object> postProcessModels(Map<String,Object> 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
  - setPackageName
```
public void setPackageName(String packageName)
```
  - setPackageVersion
```
public void setPackageVersion(String packageVersion)
```
  - setLuaRocksFilename
```
public void setLuaRocksFilename(String luaRocksFilename)
```
  - 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
  - toModelImport
```
public String toModelImport(String name)
```
    Description copied from class: DefaultCodegen
    
    Return the fully-qualified "Model" name for import
    
    Specified by:
    
    toModelImport in interface CodegenConfig
    
    Overrides:
    
    toModelImport in class DefaultCodegen
    
    Parameters:
    name - the name of the "Model"
    
    Returns:
    the fully-qualified "Model" name for import

Class LuaClientCodegen

Field Summary

Fields inherited from class io.swagger.codegen.DefaultCodegen

Constructor Summary

Method Summary

Methods inherited from class io.swagger.codegen.DefaultCodegen

Methods inherited from class java.lang.Object

Methods inherited from interface io.swagger.codegen.CodegenConfig

Field Detail

specFolder

packageName

packageVersion

apiDocPath

modelDocPath

luaRocksFilename

Constructor Detail

LuaClientCodegen

Method Detail

getTag

getName

getHelp

processOpts

escapeReservedWord

apiFileFolder

modelFileFolder

toVarName

toParamName

toModelName

toModelFilename

toApiFilename

toApiTestFilename

toModelTestFilename

postProcessParameter

apiTestFileFolder

modelTestFileFolder

apiDocFileFolder

modelDocFileFolder

toModelDocFilename

toApiDocFilename

toApiName

getTypeDeclaration

getSwaggerType

toOperationId

postProcessOperations

postProcessModels

needToImport

setPackageName

setPackageVersion

setLuaRocksFilename

escapeQuotationMark

escapeUnsafeCharacters

createMapping

toEnumValue

toEnumDefaultValue

toEnumVarName

toEnumName

toModelImport