DefaultCodegen (swagger-codegen (core library) 2.2.0 API)

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

Direct Known Subclasses:

AbstractCSharpCodegen, AbstractJavaCodegen, AbstractTypeScriptClientCodegen, AkkaScalaClientCodegen, AndroidClientCodegen, AsyncScalaClientCodegen, ClojureClientCodegen, CppRestClientCodegen, CsharpDotNet2ClientCodegen, DartClientCodegen, FlashClientCodegen, FlaskConnexionCodegen, GoClientCodegen, GoServerCodegen, HaskellServantCodegen, JavascriptClientCodegen, JavascriptClosureAngularClientCodegen, JMeterCodegen, LumenServerCodegen, NodeJSServerCodegen, ObjcClientCodegen, PerlClientCodegen, PhpClientCodegen, PythonClientCodegen, Qt5CPPGenerator, Rails5ServerCodegen, RubyClientCodegen, ScalaClientCodegen, ScalatraServerCodegen, SilexServerCodegen, SinatraServerCodegen, SlimFrameworkServerCodegen, StaticDocCodegen, StaticHtmlGenerator, SwaggerGenerator, SwaggerYamlGenerator, SwiftCodegen, TizenClientCodegen
```
public class DefaultCodegen
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,Object>`	`additionalProperties`
`protected Map<String,String>`	`apiDocTemplateFiles`
`protected String`	`apiPackage`
`protected Map<String,String>`	`apiTemplateFiles`
`protected Map<String,String>`	`apiTestTemplateFiles`
`protected List<CliOption>`	`cliOptions`
`protected String`	`commonTemplateDir`
`protected Set<String>`	`defaultIncludes`
`protected String`	`embeddedTemplateDir`
`protected Boolean`	`ensureUniqueParams`
`protected String`	`fileSuffix`
`protected String`	`gitRepoId`
`protected String`	`gitUserId`
`protected String`	`httpUserAgent`
`protected Map<String,String>`	`importMapping`
`protected Map<String,String>`	`instantiationTypes`
`protected Set<String>`	`languageSpecificPrimitives`
`protected String`	`library`
`protected static org.slf4j.Logger`	`LOGGER`
`protected Map<String,String>`	`modelDocTemplateFiles`
`protected String`	`modelNamePrefix`
`protected String`	`modelNameSuffix`
`protected String`	`modelPackage`
`protected Map<String,String>`	`modelTemplateFiles`
`protected Map<String,String>`	`modelTestTemplateFiles`
`protected String`	`outputFolder`
`protected String`	`releaseNote`
`protected Set<String>`	`reservedWords`
`protected boolean`	`skipOverwrite`
`protected Boolean`	`sortParamsByRequiredFlag`
`protected Map<Character,String>`	`specialCharReplacements`
`protected Map<String,String>`	`supportedLibraries`
`protected List<SupportingFile>`	`supportingFiles`
`protected boolean`	`supportsInheritance`
`protected String`	`templateDir`
`protected String`	`testPackage`
`protected Map<String,String>`	`typeMapping`
`protected Map<String,Object>`	`vendorExtensions`

Constructor Summary

Constructors
Constructor and Description

DefaultCodegen()
Default constructor.

Constructors
Constructor and Description
`DefaultCodegen()` Default constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addAdditionPropertiesToCodeGenModel(CodegenModel codegenModel, io.swagger.models.ModelImpl swaggerModel)`
`protected void`	`addImport(CodegenModel m, String type)`
`Map<String,Object>`	`additionalProperties()`
`void`	`addOperationToGroup(String tag, String resourcePath, io.swagger.models.Operation operation, CodegenOperation co, Map<String,List<CodegenOperation>> operations)` Add operation to group
`protected void`	`addProperties(Map<String,io.swagger.models.properties.Property> properties, List<String> required, io.swagger.models.Model model, Map<String,io.swagger.models.Model> allDefinitions)`
`String`	`apiDocFileFolder()`
`String`	`apiDocFilename(String templateName, String tag)` Return the full path and API documentation file
`Map<String,String>`	`apiDocTemplateFiles()`
`String`	`apiFileFolder()`
`String`	`apiFilename(String templateName, String tag)`
`String`	`apiPackage()`
`Map<String,String>`	`apiTemplateFiles()`
`String`	`apiTestFileFolder()`
`String`	`apiTestFilename(String templateName, String tag)` Return the full path and API test file
`Map<String,String>`	`apiTestTemplateFiles()`
`protected CliOption`	`buildLibraryCliOption(Map<String,String> supportedLibraries)`
`static String`	`camelize(String word)` Camelize name (parameter, property, method, etc) with upper case for first letter copied from Twitter elephant bird https://github.com/twitter/elephant-bird/blob/master/core/src/main/java/com/twitter/elephantbird/util/Strings.java
`static String`	`camelize(String word, boolean lowercaseFirstLetter)` Camelize name (parameter, property, method, etc)
`List<CliOption>`	`cliOptions()`
`protected String`	`dashize(String word)` Dashize the given word.
`Set<String>`	`defaultIncludes()`
`String`	`embeddedTemplateDir()`
`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)`
`String`	`escapeUnsafeCharacters(String input)` override with any special text escaping logic to handle unsafe characters so as to avoid code injection
`String`	`fileSuffix()`
`String`	`findCommonPrefixOfVars(List<Object> vars)` Returns the common prefix of variables for enum naming
`protected io.swagger.models.Response`	`findMethodResponse(Map<String,io.swagger.models.Response> responses)` Override with any special handling of response codes
`CodegenModel`	`fromModel(String name, io.swagger.models.Model model)` Convert Swagger Model object to Codegen Model object without providing all model definitions
`CodegenModel`	`fromModel(String name, io.swagger.models.Model model, Map<String,io.swagger.models.Model> allDefinitions)` Convert Swagger Model object to Codegen Model object
`CodegenOperation`	`fromOperation(String path, String httpMethod, io.swagger.models.Operation operation, Map<String,io.swagger.models.Model> definitions)` Convert Swagger Operation object to Codegen Operation object (without providing a Swagger object)
`CodegenOperation`	`fromOperation(String path, String httpMethod, io.swagger.models.Operation operation, Map<String,io.swagger.models.Model> definitions, io.swagger.models.Swagger swagger)` Convert Swagger Operation object to Codegen Operation object
`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 response)` Convert Swagger Response object to Codegen Response object
`List<CodegenSecurity>`	`fromSecurity(Map<String,io.swagger.models.auth.SecuritySchemeDefinition> schemes)` Convert map of Swagger SecuritySchemeDefinition objects to a list of Codegen Security objects
`String`	`generateExamplePath(String path, io.swagger.models.Operation operation)` Return the example path
`String`	`getCommonTemplateDir()`
`String`	`getGitRepoId()` Git repo ID
`String`	`getGitUserId()` Git user ID
`String`	`getHttpUserAgent()` HTTP user agent
`String`	`getLibrary()` Library template (sub-template).
`protected String`	`getOrGenerateOperationId(io.swagger.models.Operation operation, String path, String httpMethod)` Get operationId from the operation object, and if it's blank, generate a new one from the given parameters.
`String`	`getOutputDir()`
`String`	`getReleaseNote()` Release note
`String`	`getSwaggerType(io.swagger.models.properties.Property p)` returns the swagger type for the property
`String`	`getterAndSetterCapitalize(String name)` Camelize the method name of the getter and setter
`String`	`getTypeDeclaration(io.swagger.models.properties.Property p)` Output the type declaration of the property
`String`	`getTypeDeclaration(String name)` Output the type declaration of a given name
`Map<String,String>`	`importMapping()`
`protected void`	`initalizeSpecialCharacterMapping()` Initalize special character mapping
`String`	`initialCaps(String name)` Capitalize the string
`Map<String,String>`	`instantiationTypes()`
`boolean`	`isDataTypeBinary(String dataType)`
`protected Boolean`	`isPropertyInnerMostEnum(CodegenProperty property)` Update property for map container
`protected boolean`	`isReservedWord(String word)`
`boolean`	`isSkipOverwrite()`
`Set<String>`	`languageSpecificPrimitives()`
`String`	`modelDocFileFolder()`
`Map<String,String>`	`modelDocTemplateFiles()`
`String`	`modelFileFolder()`
`String`	`modelPackage()`
`Map<String,String>`	`modelTemplateFiles()`
`String`	`modelTestFileFolder()`
`Map<String,String>`	`modelTestTemplateFiles()`
`protected boolean`	`needToImport(String type)` Check the type to see if it needs import the library/module/package
`String`	`outputFolder()`
`Map<String,Object>`	`postProcessAllModels(Map<String,Object> objs)`
`void`	`postProcessModelProperty(CodegenModel model, CodegenProperty property)`
`Map<String,Object>`	`postProcessModels(Map<String,Object> objs)`
`Map<String,Object>`	`postProcessModelsEnum(Map<String,Object> objs)` post process enum defined in model's properties
`Map<String,Object>`	`postProcessOperations(Map<String,Object> objs)`
`void`	`postProcessParameter(CodegenParameter parameter)`
`Map<String,Object>`	`postProcessSupportingFileData(Map<String,Object> objs)`
`void`	`preprocessSwagger(io.swagger.models.Swagger swagger)`
`void`	`processOpts()`
`void`	`processSwagger(io.swagger.models.Swagger swagger)`
`String`	`removeNonNameElementToCamelCase(String name)` Remove characters not suitable for variable or method name from the input and camelize it
`protected String`	`removeNonNameElementToCamelCase(String name, String nonNameElementPattern)` Remove characters that is not good to be included in method name from the input and camelize it
`Set<String>`	`reservedWords()`
`String`	`sanitizeName(String name)` Sanitize name (parameter, property, method, etc)
`String`	`sanitizeTag(String tag)` Sanitize tag
`void`	`setApiPackage(String apiPackage)`
`void`	`setCommonTemplateDir(String commonTemplateDir)`
`void`	`setEnsureUniqueParams(Boolean ensureUniqueParams)`
`void`	`setGitRepoId(String gitRepoId)` Set Git repo ID.
`void`	`setGitUserId(String gitUserId)` Set Git user ID.
`void`	`setHttpUserAgent(String httpUserAgent)` Set HTTP user agent.
`void`	`setLibrary(String library)` Set library template (sub-template).
`void`	`setModelNamePrefix(String modelNamePrefix)`
`void`	`setModelNameSuffix(String modelNameSuffix)`
`void`	`setModelPackage(String modelPackage)`
`protected void`	`setNonArrayMapProperty(CodegenProperty property, String type)`
`void`	`setOutputDir(String dir)`
`void`	`setParameterBooleanFlagWithCodegenProperty(CodegenParameter parameter, CodegenProperty property)` Set CodegenParameter boolean flag using CodegenProperty.
`void`	`setParameterExampleValue(CodegenParameter p)` Return the example value of the parameter.
`void`	`setReleaseNote(String releaseNote)` Set release note.
`protected void`	`setReservedWordsLowerCase(List<String> words)`
`void`	`setSkipOverwrite(boolean skipOverwrite)`
`void`	`setSortParamsByRequiredFlag(Boolean sortParamsByRequiredFlag)`
`void`	`setTemplateDir(String templateDir)`
`boolean`	`shouldOverwrite(String filename)`
`String`	`snakeCase(String name)` Return the snake-case of the string
`Map<String,String>`	`supportedLibraries()` All library templates supported.
`List<SupportingFile>`	`supportingFiles()`
`String`	`templateDir()`
`String`	`testPackage()`
`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`	`toApiImport(String name)` Return the fully-qualified "Api" name for import
`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`	`toApiVarName(String name)` Return the variable name in the Api
`String`	`toDefaultValue(io.swagger.models.properties.Property p)` Return the default value of the property
`String`	`toDefaultValueWithParam(String name, io.swagger.models.properties.Property p)` Return the property initialized from a data object Useful for initialization with a plain object in Javascript
`String`	`toEnumDefaultValue(String value, String datatype)` Return the enum default value in the language specifed format
`String`	`toEnumName(CodegenProperty property)` Return the Enum name (e.g.
`String`	`toEnumValue(String value, String datatype)` Return the enum value in the language specifed format e.g.
`String`	`toEnumVarName(String value, String datatype)` Return the sanitized variable name for enum
`protected List<Map<String,Object>>`	`toExamples(Map<String,Object> examples)`
`String`	`toExampleValue(io.swagger.models.properties.Property p)` Return the example value of the property
`String`	`toInstantiationType(io.swagger.models.properties.Property p)` Return the instantiation type of the property, especially for map and array
`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`	`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.
`Map<String,String>`	`typeMapping()`
`static String`	`underscore(String word)` Underscore the given word.
`void`	`updateCodegenPropertyEnum(CodegenProperty var)` Update codegen property's enum by adding "enumVars" (with name and value)
`protected void`	`updateDataTypeWithEnumForArray(CodegenProperty property)` Update datatypeWithEnum for array container
`protected void`	`updateDataTypeWithEnumForMap(CodegenProperty property)` Update datatypeWithEnum for map container
`protected void`	`updatePropertyForArray(CodegenProperty property, CodegenProperty innerProperty)` Update property for array(list) container
`protected void`	`updatePropertyForMap(CodegenProperty property, CodegenProperty innerProperty)` Update property for map container
`Map<String,Object>`	`vendorExtensions()`
`void`	`writeOptional(String outputFolder, SupportingFile supportingFile)` Only write if the file doesn't exist

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

- Field Detail
  - LOGGER
```
protected static final org.slf4j.Logger LOGGER
```
  - outputFolder
```
protected String outputFolder
```
  - defaultIncludes
```
protected Set<String> defaultIncludes
```
  - typeMapping
```
protected Map<String,String> typeMapping
```
  - instantiationTypes
```
protected Map<String,String> instantiationTypes
```
  - reservedWords
```
protected Set<String> reservedWords
```
  - languageSpecificPrimitives
```
protected Set<String> languageSpecificPrimitives
```
  - importMapping
```
protected Map<String,String> importMapping
```
  - modelPackage
```
protected String modelPackage
```
  - apiPackage
```
protected String apiPackage
```
  - fileSuffix
```
protected String fileSuffix
```
  - modelNamePrefix
```
protected String modelNamePrefix
```
  - modelNameSuffix
```
protected String modelNameSuffix
```
  - testPackage
```
protected String testPackage
```
  - apiTemplateFiles
```
protected Map<String,String> apiTemplateFiles
```
  - modelTemplateFiles
```
protected Map<String,String> modelTemplateFiles
```
  - apiTestTemplateFiles
```
protected Map<String,String> apiTestTemplateFiles
```
  - modelTestTemplateFiles
```
protected Map<String,String> modelTestTemplateFiles
```
  - apiDocTemplateFiles
```
protected Map<String,String> apiDocTemplateFiles
```
  - modelDocTemplateFiles
```
protected Map<String,String> modelDocTemplateFiles
```
  - templateDir
```
protected String templateDir
```
  - embeddedTemplateDir
```
protected String embeddedTemplateDir
```
  - commonTemplateDir
```
protected String commonTemplateDir
```
  - additionalProperties
```
protected Map<String,Object> additionalProperties
```
  - vendorExtensions
```
protected Map<String,Object> vendorExtensions
```
  - supportingFiles
```
protected List<SupportingFile> supportingFiles
```
  - cliOptions
```
protected List<CliOption> cliOptions
```
  - skipOverwrite
```
protected boolean skipOverwrite
```
  - supportsInheritance
```
protected boolean supportsInheritance
```
  - supportedLibraries
```
protected Map<String,String> supportedLibraries
```
  - library
```
protected String library
```
  - sortParamsByRequiredFlag
```
protected Boolean sortParamsByRequiredFlag
```
  - ensureUniqueParams
```
protected Boolean ensureUniqueParams
```
  - gitUserId
```
protected String gitUserId
```
  - gitRepoId
```
protected String gitRepoId
```
  - releaseNote
```
protected String releaseNote
```
  - httpUserAgent
```
protected String httpUserAgent
```
  - specialCharReplacements
```
protected Map<Character,String> specialCharReplacements
```
- Constructor Detail
  - DefaultCodegen
```
public DefaultCodegen()
```
    Default constructor. This method will map between Swagger type and language-specified type, as well as mapping between Swagger type and the corresponding import statement for the language. This will also add some language specified CLI options, if any. returns string presentation of the example path (it's a constructor)
- Method Detail
  - cliOptions
```
public List<CliOption> cliOptions()
```
  - processOpts
```
public void processOpts()
```
  - postProcessAllModels
```
public Map<String,Object> postProcessAllModels(Map<String,Object> objs)
```
  - postProcessModels
```
public Map<String,Object> postProcessModels(Map<String,Object> objs)
```
  - postProcessModelsEnum
```
public Map<String,Object> postProcessModelsEnum(Map<String,Object> objs)
```
    post process enum defined in model's properties
    
    Parameters:
    objs - Map of models
    
    Returns:
    maps of models with better enum support
  - findCommonPrefixOfVars
```
public String findCommonPrefixOfVars(List<Object> vars)
```
    Returns the common prefix of variables for enum naming
    
    Parameters:
    vars - List of variable names
    
    Returns:
    the common prefix for naming
  - toEnumDefaultValue
```
public String toEnumDefaultValue(String value,
                        String datatype)
```
    Return the enum default value in the language specifed format
    
    Parameters:
    value - enum variable name
    datatype - data type
    
    Returns:
    the default value for the enum
  - toEnumValue
```
public String toEnumValue(String value,
                 String datatype)
```
    Return the enum value in the language specifed format e.g. status becomes "status"
    
    Parameters:
    value - enum variable name
    datatype - data type
    
    Returns:
    the sanitized value for enum
  - toEnumVarName
```
public String toEnumVarName(String value,
                   String datatype)
```
    Return the sanitized variable name for enum
    
    Parameters:
    value - enum variable name
    datatype - data type
    
    Returns:
    the sanitized variable name for enum
  - postProcessOperations
```
public Map<String,Object> postProcessOperations(Map<String,Object> objs)
```
  - postProcessSupportingFileData
```
public Map<String,Object> postProcessSupportingFileData(Map<String,Object> objs)
```
  - postProcessModelProperty
```
public void postProcessModelProperty(CodegenModel model,
                            CodegenProperty property)
```
  - postProcessParameter
```
public void postProcessParameter(CodegenParameter parameter)
```
  - preprocessSwagger
```
public void preprocessSwagger(io.swagger.models.Swagger swagger)
```
  - processSwagger
```
public void processSwagger(io.swagger.models.Swagger swagger)
```
  - escapeText
```
public String escapeText(String input)
```
  - escapeUnsafeCharacters
```
public String escapeUnsafeCharacters(String input)
```
    override with any special text escaping logic to handle unsafe characters so as to avoid code injection
    
    Parameters:
    input - String to be cleaned up
    
    Returns:
    string with unsafe characters removed or escaped
  - escapeQuotationMark
```
public String escapeQuotationMark(String input)
```
    Escape single and/or double quote to avoid code injection
    
    Parameters:
    input - String to be cleaned up
    
    Returns:
    string with quotation mark removed or escaped
  - defaultIncludes
```
public Set<String> defaultIncludes()
```
  - typeMapping
```
public Map<String,String> typeMapping()
```
  - instantiationTypes
```
public Map<String,String> instantiationTypes()
```
  - reservedWords
```
public Set<String> reservedWords()
```
  - languageSpecificPrimitives
```
public Set<String> languageSpecificPrimitives()
```
  - importMapping
```
public Map<String,String> importMapping()
```
  - testPackage
```
public String testPackage()
```
  - modelPackage
```
public String modelPackage()
```
  - apiPackage
```
public String apiPackage()
```
  - fileSuffix
```
public String fileSuffix()
```
  - templateDir
```
public String templateDir()
```
  - embeddedTemplateDir
```
public String embeddedTemplateDir()
```
  - getCommonTemplateDir
```
public String getCommonTemplateDir()
```
  - setCommonTemplateDir
```
public void setCommonTemplateDir(String commonTemplateDir)
```
  - apiDocTemplateFiles
```
public Map<String,String> apiDocTemplateFiles()
```
  - modelDocTemplateFiles
```
public Map<String,String> modelDocTemplateFiles()
```
  - apiTestTemplateFiles
```
public Map<String,String> apiTestTemplateFiles()
```
  - modelTestTemplateFiles
```
public Map<String,String> modelTestTemplateFiles()
```
  - apiTemplateFiles
```
public Map<String,String> apiTemplateFiles()
```
  - modelTemplateFiles
```
public Map<String,String> modelTemplateFiles()
```
  - apiFileFolder
```
public String apiFileFolder()
```
  - modelFileFolder
```
public String modelFileFolder()
```
  - apiTestFileFolder
```
public String apiTestFileFolder()
```
  - modelTestFileFolder
```
public String modelTestFileFolder()
```
  - apiDocFileFolder
```
public String apiDocFileFolder()
```
  - modelDocFileFolder
```
public String modelDocFileFolder()
```
  - additionalProperties
```
public Map<String,Object> additionalProperties()
```
  - vendorExtensions
```
public Map<String,Object> vendorExtensions()
```
  - supportingFiles
```
public List<SupportingFile> supportingFiles()
```
  - outputFolder
```
public String outputFolder()
```
  - setOutputDir
```
public void setOutputDir(String dir)
```
  - getOutputDir
```
public String getOutputDir()
```
  - setTemplateDir
```
public void setTemplateDir(String templateDir)
```
  - setModelPackage
```
public void setModelPackage(String modelPackage)
```
  - setModelNamePrefix
```
public void setModelNamePrefix(String modelNamePrefix)
```
  - setModelNameSuffix
```
public void setModelNameSuffix(String modelNameSuffix)
```
  - setApiPackage
```
public void setApiPackage(String apiPackage)
```
  - setSortParamsByRequiredFlag
```
public void setSortParamsByRequiredFlag(Boolean sortParamsByRequiredFlag)
```
  - setEnsureUniqueParams
```
public void setEnsureUniqueParams(Boolean ensureUniqueParams)
```
  - toRegularExpression
```
public String toRegularExpression(String pattern)
```
    Return the regular expression/JSON schema pattern (http://json-schema.org/latest/json-schema-validation.html#anchor33)
    
    Parameters:
    pattern - the pattern (regular expression)
    
    Returns:
    properly-escaped pattern
  - toApiFilename
```
public String toApiFilename(String name)
```
    Return the file name of the Api Test
    
    Parameters:
    name - the file name of the Api
    
    Returns:
    the file name of the Api
  - toApiDocFilename
```
public String toApiDocFilename(String name)
```
    Return the file name of the Api Documentation
    
    Parameters:
    name - the file name of the Api
    
    Returns:
    the file name of the Api
  - toApiTestFilename
```
public String toApiTestFilename(String name)
```
    Return the file name of the Api Test
    
    Parameters:
    name - the file name of the Api
    
    Returns:
    the file name of the Api
  - toApiVarName
```
public String toApiVarName(String name)
```
    Return the variable name in the Api
    
    Parameters:
    name - the varible name of the Api
    
    Returns:
    the snake-cased variable name
  - toModelFilename
```
public String toModelFilename(String name)
```
    Return the capitalized file name of the model
    
    Parameters:
    name - the model name
    
    Returns:
    the file name of the model
  - toModelTestFilename
```
public String toModelTestFilename(String name)
```
    Return the capitalized file name of the model test
    
    Parameters:
    name - the model name
    
    Returns:
    the file name of the model
  - toModelDocFilename
```
public String toModelDocFilename(String name)
```
    Return the capitalized file name of the model documentation
    
    Parameters:
    name - the model name
    
    Returns:
    the file name of the model
  - toOperationId
```
public String toOperationId(String operationId)
```
    Return the operation ID (method name)
    
    Parameters:
    operationId - operation ID
    
    Returns:
    the sanitized method name
  - toVarName
```
public String toVarName(String name)
```
    Return the variable name by removing invalid characters and proper escaping if it's a reserved word.
    
    Parameters:
    name - the variable name
    
    Returns:
    the sanitized variable name
  - toParamName
```
public String toParamName(String name)
```
    Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.
    
    Parameters:
    name - Codegen property object
    
    Returns:
    the sanitized parameter name
  - toEnumName
```
public String toEnumName(CodegenProperty property)
```
    Return the Enum name (e.g. StatusEnum given 'status')
    
    Parameters:
    property - Codegen property
    
    Returns:
    the Enum name
  - escapeReservedWord
```
public String escapeReservedWord(String name)
```
    Return the escaped name of the reserved word
    
    Parameters:
    name - the name to be escaped
    
    Returns:
    the escaped reserved word throws Runtime exception as reserved word is not allowed (default behavior)
  - toModelImport
```
public String toModelImport(String name)
```
    Return the fully-qualified "Model" name for import
    
    Parameters:
    name - the name of the "Model"
    
    Returns:
    the fully-qualified "Model" name for import
  - toApiImport
```
public String toApiImport(String name)
```
    Return the fully-qualified "Api" name for import
    
    Parameters:
    name - the name of the "Api"
    
    Returns:
    the fully-qualified "Api" name for import
  - initalizeSpecialCharacterMapping
```
protected void initalizeSpecialCharacterMapping()
```
    Initalize special character mapping
  - generateExamplePath
```
public String generateExamplePath(String path,
                         io.swagger.models.Operation operation)
```
    Return the example path
    
    Parameters:
    path - the path of the operation
    operation - Swagger operation object
    
    Returns:
    string presentation of the example path
  - toInstantiationType
```
public String toInstantiationType(io.swagger.models.properties.Property p)
```
    Return the instantiation type of the property, especially for map and array
    
    Parameters:
    p - Swagger property object
    
    Returns:
    string presentation of the instantiation type of the property
  - setParameterExampleValue
```
public void setParameterExampleValue(CodegenParameter p)
```
    Return the example value of the parameter.
    
    Parameters:
    p - Swagger property object
  - toExampleValue
```
public String toExampleValue(io.swagger.models.properties.Property p)
```
    Return the example value of the property
    
    Parameters:
    p - Swagger property object
    
    Returns:
    string presentation of the example value of the property
  - toDefaultValue
```
public String toDefaultValue(io.swagger.models.properties.Property p)
```
    Return the default value of the property
    
    Parameters:
    p - Swagger property object
    
    Returns:
    string presentation of the default value of the property
  - toDefaultValueWithParam
```
public String toDefaultValueWithParam(String name,
                             io.swagger.models.properties.Property p)
```
    Return the property initialized from a data object Useful for initialization with a plain object in Javascript
    
    Parameters:
    name - Name of the property object
    p - Swagger property object
    
    Returns:
    string presentation of the default value of the property
  - getSwaggerType
```
public String getSwaggerType(io.swagger.models.properties.Property p)
```
    returns the swagger type for the property
    
    Parameters:
    p - Swagger property object
    
    Returns:
    string presentation of the type
  - snakeCase
```
public String snakeCase(String name)
```
    Return the snake-case of the string
    
    Parameters:
    name - string to be snake-cased
    
    Returns:
    snake-cased string
  - initialCaps
```
public String initialCaps(String name)
```
    Capitalize the string
    
    Parameters:
    name - string to be capitalized
    
    Returns:
    capitalized string
  - getTypeDeclaration
```
public String getTypeDeclaration(String name)
```
    Output the type declaration of a given name
    
    Parameters:
    name - name
    
    Returns:
    a string presentation of the type
  - getTypeDeclaration
```
public String getTypeDeclaration(io.swagger.models.properties.Property p)
```
    Output the type declaration of the property
    
    Parameters:
    p - Swagger Property object
    
    Returns:
    a string presentation of the property type
  - toApiName
```
public String toApiName(String name)
```
    Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty
    
    Parameters:
    name - the name of the Api
    
    Returns:
    capitalized Api name ending with "Api"
  - toModelName
```
public String toModelName(String name)
```
    Output the proper model name (capitalized)
    
    Parameters:
    name - the name of the model
    
    Returns:
    capitalized model name
  - fromModel
```
public CodegenModel fromModel(String name,
                     io.swagger.models.Model model)
```
    Convert Swagger Model object to Codegen Model object without providing all model definitions
    
    Parameters:
    name - the name of the model
    model - Swagger Model object
    
    Returns:
    Codegen Model object
  - fromModel
```
public CodegenModel fromModel(String name,
                     io.swagger.models.Model model,
                     Map<String,io.swagger.models.Model> allDefinitions)
```
    Convert Swagger Model object to Codegen Model object
    
    Parameters:
    name - the name of the model
    model - Swagger Model object
    allDefinitions - a map of all Swagger models from the spec
    
    Returns:
    Codegen Model object
  - addAdditionPropertiesToCodeGenModel
```
protected void addAdditionPropertiesToCodeGenModel(CodegenModel codegenModel,
                                       io.swagger.models.ModelImpl swaggerModel)
```
  - addProperties
```
protected void addProperties(Map<String,io.swagger.models.properties.Property> properties,
                 List<String> required,
                 io.swagger.models.Model model,
                 Map<String,io.swagger.models.Model> allDefinitions)
```
  - getterAndSetterCapitalize
```
public String getterAndSetterCapitalize(String name)
```
    Camelize the method name of the getter and setter
    
    Parameters:
    name - string to be camelized
    
    Returns:
    Camelized string
  - fromProperty
```
public CodegenProperty fromProperty(String name,
                           io.swagger.models.properties.Property p)
```
    Convert Swagger Property object to Codegen Property object
    
    Parameters:
    name - name of the property
    p - Swagger property object
    
    Returns:
    Codegen Property object
  - updatePropertyForArray
```
protected void updatePropertyForArray(CodegenProperty property,
                          CodegenProperty innerProperty)
```
    Update property for array(list) container
    
    Parameters:
    property - Codegen property
    innerProperty - Codegen inner property of map or list
  - updatePropertyForMap
```
protected void updatePropertyForMap(CodegenProperty property,
                        CodegenProperty innerProperty)
```
    Update property for map container
    
    Parameters:
    property - Codegen property
    innerProperty - Codegen inner property of map or list
  - isPropertyInnerMostEnum
```
protected Boolean isPropertyInnerMostEnum(CodegenProperty property)
```
    Update property for map container
    
    Parameters:
    property - Codegen property
    
    Returns:
    True if the inner most type is enum
  - updateDataTypeWithEnumForArray
```
protected void updateDataTypeWithEnumForArray(CodegenProperty property)
```
    Update datatypeWithEnum for array container
    
    Parameters:
    property - Codegen property
  - updateDataTypeWithEnumForMap
```
protected void updateDataTypeWithEnumForMap(CodegenProperty property)
```
    Update datatypeWithEnum for map container
    
    Parameters:
    property - Codegen property
  - setNonArrayMapProperty
```
protected void setNonArrayMapProperty(CodegenProperty property,
                          String type)
```
  - findMethodResponse
```
protected io.swagger.models.Response findMethodResponse(Map<String,io.swagger.models.Response> responses)
```
    Override with any special handling of response codes
    
    Parameters:
    responses - Swagger Operation's responses
    
    Returns:
    default method response or null if not found
  - fromOperation
```
public CodegenOperation fromOperation(String path,
                             String httpMethod,
                             io.swagger.models.Operation operation,
                             Map<String,io.swagger.models.Model> definitions)
```
    Convert Swagger Operation object to Codegen Operation object (without providing a Swagger object)
    
    Parameters:
    path - the path of the operation
    httpMethod - HTTP method
    operation - Swagger operation object
    definitions - a map of Swagger models
    
    Returns:
    Codegen Operation object
  - fromOperation
```
public CodegenOperation fromOperation(String path,
                             String httpMethod,
                             io.swagger.models.Operation operation,
                             Map<String,io.swagger.models.Model> definitions,
                             io.swagger.models.Swagger swagger)
```
    Convert Swagger Operation object to Codegen Operation object
    
    Parameters:
    path - the path of the operation
    httpMethod - HTTP method
    operation - Swagger operation object
    definitions - a map of Swagger models
    swagger - a Swagger object representing the spec
    
    Returns:
    Codegen Operation object
  - fromResponse
```
public CodegenResponse fromResponse(String responseCode,
                           io.swagger.models.Response response)
```
    Convert Swagger Response object to Codegen Response object
    
    Parameters:
    responseCode - HTTP response code
    response - Swagger Response object
    
    Returns:
    Codegen Response object
  - fromParameter
```
public CodegenParameter fromParameter(io.swagger.models.parameters.Parameter param,
                             Set<String> imports)
```
    Convert Swagger Parameter object to Codegen Parameter object
    
    Parameters:
    param - Swagger parameter object
    imports - set of imports for library/package/module
    
    Returns:
    Codegen Parameter object
  - isDataTypeBinary
```
public boolean isDataTypeBinary(String dataType)
```
  - fromSecurity
```
public List<CodegenSecurity> fromSecurity(Map<String,io.swagger.models.auth.SecuritySchemeDefinition> schemes)
```
    Convert map of Swagger SecuritySchemeDefinition objects to a list of Codegen Security objects
    
    Parameters:
    schemes - a map of Swagger SecuritySchemeDefinition object
    
    Returns:
    a list of Codegen Security objects
  - setReservedWordsLowerCase
```
protected void setReservedWordsLowerCase(List<String> words)
```
  - isReservedWord
```
protected boolean isReservedWord(String word)
```
  - getOrGenerateOperationId
```
protected String getOrGenerateOperationId(io.swagger.models.Operation operation,
                              String path,
                              String httpMethod)
```
    Get operationId from the operation object, and if it's blank, generate a new one from the given parameters.
    
    Parameters:
    operation - the operation object
    path - the path of the operation
    httpMethod - the HTTP method of the operation
    
    Returns:
    the (generated) operationId
  - needToImport
```
protected boolean needToImport(String type)
```
    Check the type to see if it needs import the library/module/package
    
    Parameters:
    type - name of the type
    
    Returns:
    true if the library/module/package of the corresponding type needs to be imported
  - toExamples
```
protected List<Map<String,Object>> toExamples(Map<String,Object> examples)
```
  - addOperationToGroup
```
public void addOperationToGroup(String tag,
                       String resourcePath,
                       io.swagger.models.Operation operation,
                       CodegenOperation co,
                       Map<String,List<CodegenOperation>> operations)
```
    Add operation to group
    
    Parameters:
    tag - name of the tag
    resourcePath - path of the resource
    operation - Swagger Operation object
    co - Codegen Operation object
    operations - map of Codegen operations
  - underscore
```
public static String underscore(String word)
```
    Underscore the given word. Copied from Twitter elephant bird https://github.com/twitter/elephant-bird/blob/master/core/src/main/java/com/twitter/elephantbird/util/Strings.java
    
    Parameters:
    word - The word
    
    Returns:
    The underscored version of the word
  - dashize
```
protected String dashize(String word)
```
    Dashize the given word.
    
    Parameters:
    word - The word
    
    Returns:
    The dashized version of the word, e.g. "my-name"
  - addImport
```
protected void addImport(CodegenModel m,
             String type)
```
  - removeNonNameElementToCamelCase
```
public String removeNonNameElementToCamelCase(String name)
```
    Remove characters not suitable for variable or method name from the input and camelize it
    
    Parameters:
    name - string to be camelize
    
    Returns:
    camelized string
  - removeNonNameElementToCamelCase
```
protected String removeNonNameElementToCamelCase(String name,
                                     String nonNameElementPattern)
```
    Remove characters that is not good to be included in method name from the input and camelize it
    
    Parameters:
    name - string to be camelize
    nonNameElementPattern - a regex pattern of the characters that is not good to be included in name
    
    Returns:
    camelized string
  - camelize
```
public static String camelize(String word)
```
    Camelize name (parameter, property, method, etc) with upper case for first letter copied from Twitter elephant bird https://github.com/twitter/elephant-bird/blob/master/core/src/main/java/com/twitter/elephantbird/util/Strings.java
    
    Parameters:
    word - string to be camelize
    
    Returns:
    camelized string
  - camelize
```
public static String camelize(String word,
              boolean lowercaseFirstLetter)
```
    Camelize name (parameter, property, method, etc)
    
    Parameters:
    word - string to be camelize
    lowercaseFirstLetter - lower case for first letter if set to true
    
    Returns:
    camelized string
  - apiFilename
```
public String apiFilename(String templateName,
                 String tag)
```
  - apiDocFilename
```
public String apiDocFilename(String templateName,
                    String tag)
```
    Return the full path and API documentation file
    
    Parameters:
    templateName - template name
    tag - tag
    
    Returns:
    the API documentation file name with full path
  - apiTestFilename
```
public String apiTestFilename(String templateName,
                     String tag)
```
    Return the full path and API test file
    
    Parameters:
    templateName - template name
    tag - tag
    
    Returns:
    the API test file name with full path
  - shouldOverwrite
```
public boolean shouldOverwrite(String filename)
```
  - isSkipOverwrite
```
public boolean isSkipOverwrite()
```
  - setSkipOverwrite
```
public void setSkipOverwrite(boolean skipOverwrite)
```
  - supportedLibraries
```
public Map<String,String> supportedLibraries()
```
    All library templates supported. (key: library name, value: library description)
    
    Returns:
    the supported libraries
  - setLibrary
```
public void setLibrary(String library)
```
    Set library template (sub-template).
    
    Parameters:
    library - Library template
  - getLibrary
```
public String getLibrary()
```
    Library template (sub-template).
    
    Returns:
    Library template
  - setGitUserId
```
public void setGitUserId(String gitUserId)
```
    Set Git user ID.
    
    Parameters:
    gitUserId - Git user ID
  - getGitUserId
```
public String getGitUserId()
```
    Git user ID
    
    Returns:
    Git user ID
  - setGitRepoId
```
public void setGitRepoId(String gitRepoId)
```
    Set Git repo ID.
    
    Parameters:
    gitRepoId - Git repo ID
  - getGitRepoId
```
public String getGitRepoId()
```
    Git repo ID
    
    Returns:
    Git repo ID
  - setReleaseNote
```
public void setReleaseNote(String releaseNote)
```
    Set release note.
    
    Parameters:
    releaseNote - Release note
  - getReleaseNote
```
public String getReleaseNote()
```
    Release note
    
    Returns:
    Release note
  - setHttpUserAgent
```
public void setHttpUserAgent(String httpUserAgent)
```
    Set HTTP user agent.
    
    Parameters:
    httpUserAgent - HTTP user agent
  - getHttpUserAgent
```
public String getHttpUserAgent()
```
    HTTP user agent
    
    Returns:
    HTTP user agent
  - buildLibraryCliOption
```
protected CliOption buildLibraryCliOption(Map<String,String> supportedLibraries)
```
  - sanitizeName
```
public String sanitizeName(String name)
```
    Sanitize name (parameter, property, method, etc)
    
    Parameters:
    name - string to be sanitize
    
    Returns:
    sanitized string
  - sanitizeTag
```
public String sanitizeTag(String tag)
```
    Sanitize tag
    
    Parameters:
    tag - Tag
    
    Returns:
    Sanitized tag
  - writeOptional
```
public void writeOptional(String outputFolder,
                 SupportingFile supportingFile)
```
    Only write if the file doesn't exist
    
    Parameters:
    outputFolder - Output folder
    supportingFile - Supporting file
  - setParameterBooleanFlagWithCodegenProperty
```
public void setParameterBooleanFlagWithCodegenProperty(CodegenParameter parameter,
                                              CodegenProperty property)
```
    Set CodegenParameter boolean flag using CodegenProperty.
    
    Parameters:
    parameter - Codegen Parameter
    property - Codegen property
  - updateCodegenPropertyEnum
```
public void updateCodegenPropertyEnum(CodegenProperty var)
```
    Update codegen property's enum by adding "enumVars" (with name and value)
    
    Parameters:
    var - list of CodegenProperty

Class DefaultCodegen

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOGGER

outputFolder

defaultIncludes

typeMapping

instantiationTypes

reservedWords

languageSpecificPrimitives

importMapping

modelPackage

apiPackage

fileSuffix

modelNamePrefix

modelNameSuffix

testPackage

apiTemplateFiles

modelTemplateFiles

apiTestTemplateFiles

modelTestTemplateFiles

apiDocTemplateFiles

modelDocTemplateFiles

templateDir

embeddedTemplateDir

commonTemplateDir

additionalProperties

vendorExtensions

supportingFiles

cliOptions

skipOverwrite

supportsInheritance

supportedLibraries

library

sortParamsByRequiredFlag

ensureUniqueParams

gitUserId

gitRepoId

releaseNote

httpUserAgent

specialCharReplacements

Constructor Detail

DefaultCodegen

Method Detail

cliOptions

processOpts

postProcessAllModels

postProcessModels

postProcessModelsEnum

findCommonPrefixOfVars

toEnumDefaultValue

toEnumValue

toEnumVarName

postProcessOperations

postProcessSupportingFileData

postProcessModelProperty

postProcessParameter

preprocessSwagger

processSwagger

escapeText

escapeUnsafeCharacters

escapeQuotationMark

defaultIncludes

typeMapping

instantiationTypes

reservedWords

languageSpecificPrimitives

importMapping

testPackage

modelPackage

apiPackage

fileSuffix

templateDir

embeddedTemplateDir

getCommonTemplateDir

setCommonTemplateDir

apiDocTemplateFiles