ElmClientCodegen (swagger-codegen (core library) 2.3.1 API)

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

All Implemented Interfaces:: CodegenConfig

public class ElmClientCodegen
extends DefaultCodegen
implements CodegenConfig

Field Summary

Fields
Modifier and Type Field and Description

protected String packageName

protected String packageVersion
- 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, LOGGER, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, releaseNote, removeOperationIdPrefix, reservedWords, reservedWordsMappings, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, templateDir, testPackage, typeAliases, typeMapping, vendorExtensions

Fields
Modifier and Type	Field and Description
`protected String`	`packageName`
`protected String`	`packageVersion`

Constructor Summary

Constructors
Constructor and Description

ElmClientCodegen()

Constructors
Constructor and Description
`ElmClientCodegen()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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
`CodegenParameter`	`fromParameter(io.swagger.models.parameters.Parameter param, Set<String> imports)` Convert Swagger Parameter object to Codegen Parameter object
`CodegenProperty`	`fromProperty(String name, io.swagger.models.properties.Property p)` Convert Swagger Property object to Codegen Property object
`CodegenResponse`	`fromResponse(String responseCode, io.swagger.models.Response resp)` Convert Swagger Response object to Codegen Response object
`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`	`modelFileFolder()`
`Map<String,Object>`	`postProcessAllModels(Map<String,Object> objs)`
`Map<String,Object>`	`postProcessModels(Map<String,Object> objs)`
`Map<String,Object>`	`postProcessOperations(Map<String,Object> operations)`
`String`	`toApiName(String name)` Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty
`String`	`toDefaultValue(io.swagger.models.properties.Property p)` Return the default value of the property
`String`	`toEnumName(CodegenProperty property)` Return the Enum name (e.g.
`String`	`toEnumVarName(String value, String datatype)` Return the sanitized variable name for enum
`String`	`toModelFilename(String name)` Return the capitalized file name of the model
`String`	`toModelName(String name)` Output the proper model name (capitalized).
`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, addProperties, addRegularExpressionDelimiter, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromModel, fromModel, fromOperation, fromOperation, fromSecurity, generateExamplePath, getAlias, getCommonTemplateDir, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getOrGenerateOperationId, getOutputDir, getReleaseNote, getSymbolName, getterAndSetterCapitalize, getTypeDeclaration, importMapping, initalizeSpecialCharacterMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needToImport, outputFolder, postProcessModelProperty, postProcessModelsEnum, postProcessOperationsWithModels, postProcessParameter, postProcessSupportingFileData, preprocessSwagger, processCompiler, processOpts, processSwagger, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoId, setGitUserId, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiTestFilename, toApiVarName, toBooleanGetter, toDefaultValueWithParam, toEnumDefaultValue, toEnumValue, toExamples, toExampleValue, toGetter, toInstantiationType, toModelDocFilename, toModelImport, toModelTestFilename, toOperationId, toParamName, 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, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, 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, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessModelProperty, postProcessOperationsWithModels, postProcessParameter, postProcessSupportingFileData, preprocessSwagger, processCompiler, processOpts, processSwagger, reservedWords, reservedWordsMappings, sanitizeTag, setGitRepoId, setGitUserId, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelImport, toModelTestFilename, toParamName, toSetter, typeMapping, vendorExtensions

- Field Detail
  - packageName
```
protected String packageName
```
  - packageVersion
```
protected String packageVersion
```
- Constructor Detail
  - ElmClientCodegen
```
public ElmClientCodegen()
```
- 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
  - 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
  - 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
  - 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"
  - 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
  - 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
  - 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
  - toEnumVarName
```
public String toEnumVarName(String value,
                            String datatype)
```
    Description copied from class: DefaultCodegen
    
    Return the sanitized variable name for enum
    
    Overrides:
    
    toEnumVarName in class DefaultCodegen
    
    Parameters:
    
    value - enum variable name
    
    datatype - data type
    
    Returns:
    
    the sanitized variable name for enum
  - 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
  - postProcessAllModels
```
public Map<String,Object> postProcessAllModels(Map<String,Object> objs)
```
    Specified by:
    
    postProcessAllModels in interface CodegenConfig
    
    Overrides:
    
    postProcessAllModels in class DefaultCodegen
  - postProcessModels
```
public Map<String,Object> postProcessModels(Map<String,Object> objs)
```
    Specified by:
    
    postProcessModels in interface CodegenConfig
    
    Overrides:
    
    postProcessModels in class DefaultCodegen
  - postProcessOperations
```
public Map<String,Object> postProcessOperations(Map<String,Object> operations)
```
    Specified by:
    
    postProcessOperations in interface CodegenConfig
    
    Overrides:
    
    postProcessOperations in class DefaultCodegen
  - toDefaultValue
```
public String toDefaultValue(io.swagger.models.properties.Property p)
```
    Description copied from class: DefaultCodegen
    
    Return the default value of the property
    
    Overrides:
    
    toDefaultValue in class DefaultCodegen
    
    Parameters:
    
    p - Swagger property object
    
    Returns:
    
    string presentation of the default value of the property
  - 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
  - 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
  - fromProperty
```
public CodegenProperty fromProperty(String name,
                                    io.swagger.models.properties.Property p)
```
    Description copied from class: DefaultCodegen
    
    Convert Swagger Property object to Codegen Property object
    
    Overrides:
    
    fromProperty in class DefaultCodegen
    
    Parameters:
    
    name - name of the property
    
    p - Swagger property object
    
    Returns:
    
    Codegen Property object
  - fromResponse
```
public CodegenResponse fromResponse(String responseCode,
                                    io.swagger.models.Response resp)
```
    Description copied from class: DefaultCodegen
    
    Convert Swagger Response object to Codegen Response object
    
    Overrides:
    
    fromResponse in class DefaultCodegen
    
    Parameters:
    
    responseCode - HTTP response code
    
    resp - Swagger Response object
    
    Returns:
    
    Codegen Response object
  - fromParameter
```
public CodegenParameter fromParameter(io.swagger.models.parameters.Parameter param,
                                      Set<String> imports)
```
    Description copied from class: DefaultCodegen
    
    Convert Swagger Parameter object to Codegen Parameter object
    
    Overrides:
    
    fromParameter in class DefaultCodegen
    
    Parameters:
    
    param - Swagger parameter object
    
    imports - set of imports for library/package/module
    
    Returns:
    
    Codegen Parameter object

Class ElmClientCodegen

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

packageName

packageVersion

Constructor Detail

ElmClientCodegen

Method Detail

getTag

getName

getHelp

escapeUnsafeCharacters

escapeQuotationMark

toApiName

toModelName

toModelFilename

toEnumName

toVarName

toEnumVarName

escapeReservedWord

apiFileFolder

modelFileFolder

postProcessAllModels

postProcessModels

postProcessOperations

toDefaultValue

getSwaggerType

getTypeDeclaration

fromProperty

fromResponse

fromParameter