AbstractCSharpCodegen (swagger-codegen (core library) 2.2.3 API)

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

All Implemented Interfaces:

CodegenConfig

Direct Known Subclasses:

AspNetCoreServerCodegen, CSharpClientCodegen, CsharpDotNet2ClientCodegen, NancyFXServerCodegen
```
public abstract class AbstractCSharpCodegen
extends DefaultCodegen
implements CodegenConfig
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected Set<String>`	`collectionTypes`
`protected String`	`interfacePrefix`
`protected org.slf4j.Logger`	`LOGGER`
`protected Set<String>`	`mapTypes`
`protected boolean`	`netCoreProjectFileFlag`
`protected boolean`	`optionalAssemblyInfoFlag`
`protected boolean`	`optionalEmitDefaultValue`
`protected boolean`	`optionalMethodArgumentFlag`
`protected boolean`	`optionalProjectFileFlag`
`protected String`	`packageAuthors`
`protected String`	`packageCompany`
`protected String`	`packageCopyright`
`protected String`	`packageDescription`
`protected String`	`packageName`
`protected String`	`packageProductName`
`protected String`	`packageTitle`
`protected String`	`packageVersion`
`protected boolean`	`returnICollection`
`protected String`	`sourceFolder`
`protected String`	`testFolder`
`protected boolean`	`useCollection`
`protected boolean`	`useDateTimeOffsetFlag`

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

AbstractCSharpCodegen()

Constructors
Constructor and Description
`AbstractCSharpCodegen()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addOption(String key, String description, String defaultValue)`
`protected void`	`addSwitch(String key, String description, Boolean defaultValue)`
`String`	`apiFileFolder()`
`String`	`apiTestFileFolder()`
`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`	`getInterfacePrefix()`
`String`	`getSwaggerType(io.swagger.models.properties.Property p)` returns the swagger type for the property
`String`	`getTypeDeclaration(io.swagger.models.properties.Property p)` Output the type declaration of the property
`String`	`modelFileFolder()`
`String`	`modelTestFileFolder()`
`Map<String,Object>`	`postProcessModels(Map<String,Object> objs)`
`Map<String,Object>`	`postProcessOperations(Map<String,Object> objs)`
`protected void`	`processOperation(CodegenOperation operation)`
`void`	`processOpts()`
`void`	`setInterfacePrefix(String interfacePrefix)`
`void`	`setNetCoreProjectFileFlag(boolean flag)`
`void`	`setOptionalEmitDefaultValue(boolean optionalEmitDefaultValue)`
`void`	`setOptionalMethodArgumentFlag(boolean flag)`
`void`	`setPackageAuthors(String packageAuthors)`
`void`	`setPackageCompany(String packageCompany)`
`void`	`setPackageCopyright(String packageCopyright)`
`void`	`setPackageDescription(String packageDescription)`
`void`	`setPackageName(String packageName)`
`void`	`setPackageProductName(String packageProductName)`
`void`	`setPackageTitle(String packageTitle)`
`void`	`setPackageVersion(String packageVersion)`
`void`	`setReturnICollection(boolean returnICollection)`
`void`	`setSourceFolder(String sourceFolder)`
`void`	`setUseCollection(boolean useCollection)`
`String`	`testPackageName()`
`String`	`toApiTestFilename(String name)` Return the file name of the Api Test
`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 name, String datatype)` Return the sanitized variable name for enum
`String`	`toExampleValue(io.swagger.models.properties.Property p)` Return the example value of the property
`String`	`toModelFilename(String name)` Return the capitalized file name of the model
`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.
`void`	`useDateTimeOffset(boolean flag)`

Methods inherited from class io.swagger.codegen.DefaultCodegen
addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOperationToGroup, addProperties, addRegularExpressionDelimiter, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromModel, fromModel, fromOperation, fromOperation, fromParameter, fromProperty, fromResponse, 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, modelTestTemplateFiles, needToImport, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessModelsEnum, postProcessParameter, postProcessSupportingFileData, preprocessSwagger, processCompiler, 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, toApiName, toApiVarName, toDefaultValueWithParam, toEnumDefaultValue, toEnumValue, toExamples, toInstantiationType, toModelDocFilename, toModelImport, toRegularExpression, 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, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, fromModel, fromModel, fromOperation, fromOperation, fromSecurity, generateExamplePath, getCommonTemplateDir, getGitRepoId, getGitUserId, getHelp, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getName, getOutputDir, getReleaseNote, getTag, getTypeDeclaration, importMapping, instantiationTypes, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessParameter, postProcessSupportingFileData, preprocessSwagger, processCompiler, processSwagger, reservedWords, reservedWordsMappings, sanitizeTag, setGitRepoId, setGitUserId, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiVarName, toModelDocFilename, toModelImport, typeMapping, vendorExtensions

- Field Detail
  - optionalAssemblyInfoFlag
```
protected boolean optionalAssemblyInfoFlag
```
  - optionalProjectFileFlag
```
protected boolean optionalProjectFileFlag
```
  - optionalEmitDefaultValue
```
protected boolean optionalEmitDefaultValue
```
  - optionalMethodArgumentFlag
```
protected boolean optionalMethodArgumentFlag
```
  - useDateTimeOffsetFlag
```
protected boolean useDateTimeOffsetFlag
```
  - useCollection
```
protected boolean useCollection
```
  - returnICollection
```
protected boolean returnICollection
```
  - netCoreProjectFileFlag
```
protected boolean netCoreProjectFileFlag
```
  - packageVersion
```
protected String packageVersion
```
  - packageName
```
protected String packageName
```
  - packageTitle
```
protected String packageTitle
```
  - packageProductName
```
protected String packageProductName
```
  - packageDescription
```
protected String packageDescription
```
  - packageCompany
```
protected String packageCompany
```
  - packageCopyright
```
protected String packageCopyright
```
  - packageAuthors
```
protected String packageAuthors
```
  - interfacePrefix
```
protected String interfacePrefix
```
  - sourceFolder
```
protected String sourceFolder
```
  - testFolder
```
protected String testFolder
```
  - collectionTypes
```
protected Set<String> collectionTypes
```
  - mapTypes
```
protected Set<String> mapTypes
```
  - LOGGER
```
protected org.slf4j.Logger LOGGER
```
- Constructor Detail
  - AbstractCSharpCodegen
```
public AbstractCSharpCodegen()
```
- Method Detail
  - setReturnICollection
```
public void setReturnICollection(boolean returnICollection)
```
  - setOptionalEmitDefaultValue
```
public void setOptionalEmitDefaultValue(boolean optionalEmitDefaultValue)
```
  - setUseCollection
```
public void setUseCollection(boolean useCollection)
```
  - setOptionalMethodArgumentFlag
```
public void setOptionalMethodArgumentFlag(boolean flag)
```
  - setNetCoreProjectFileFlag
```
public void setNetCoreProjectFileFlag(boolean flag)
```
  - addOption
```
protected void addOption(String key,
             String description,
             String defaultValue)
```
  - addSwitch
```
protected void addSwitch(String key,
             String description,
             Boolean defaultValue)
```
  - useDateTimeOffset
```
public void useDateTimeOffset(boolean flag)
```
  - processOpts
```
public void processOpts()
```
    Specified by:
    
    processOpts in interface CodegenConfig
    
    Overrides:
    
    processOpts 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> objs)
```
    Specified by:
    
    postProcessOperations in interface CodegenConfig
    
    Overrides:
    
    postProcessOperations in class DefaultCodegen
  - processOperation
```
protected void processOperation(CodegenOperation operation)
```
  - 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
  - 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
  - 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
  - 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
  - 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)
  - toExampleValue
```
public String toExampleValue(io.swagger.models.properties.Property p)
```
    Return the example value of the property
    
    Overrides:
    
    toExampleValue in class DefaultCodegen
    
    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
    
    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
  - 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
  - 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
  - setPackageName
```
public void setPackageName(String packageName)
```
  - setPackageVersion
```
public void setPackageVersion(String packageVersion)
```
  - setPackageTitle
```
public void setPackageTitle(String packageTitle)
```
  - setPackageProductName
```
public void setPackageProductName(String packageProductName)
```
  - setPackageDescription
```
public void setPackageDescription(String packageDescription)
```
  - setPackageCompany
```
public void setPackageCompany(String packageCompany)
```
  - setPackageCopyright
```
public void setPackageCopyright(String packageCopyright)
```
  - setPackageAuthors
```
public void setPackageAuthors(String packageAuthors)
```
  - setSourceFolder
```
public void setSourceFolder(String sourceFolder)
```
  - getInterfacePrefix
```
public String getInterfacePrefix()
```
  - setInterfacePrefix
```
public void setInterfacePrefix(String interfacePrefix)
```
  - 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
  - testPackageName
```
public String testPackageName()
```
  - 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

Class AbstractCSharpCodegen

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

optionalAssemblyInfoFlag

optionalProjectFileFlag

optionalEmitDefaultValue

optionalMethodArgumentFlag

useDateTimeOffsetFlag

useCollection

returnICollection

netCoreProjectFileFlag

packageVersion

packageName

packageTitle

packageProductName

packageDescription

packageCompany

packageCopyright

packageAuthors

interfacePrefix

sourceFolder

testFolder

collectionTypes

mapTypes

LOGGER

Constructor Detail

AbstractCSharpCodegen

Method Detail

setReturnICollection

setOptionalEmitDefaultValue

setUseCollection

setOptionalMethodArgumentFlag

setNetCoreProjectFileFlag

addOption

addSwitch

useDateTimeOffset

processOpts

postProcessModels

postProcessOperations

processOperation

apiFileFolder

modelFileFolder

toModelFilename

toOperationId

toVarName

toParamName

escapeReservedWord

toExampleValue

toDefaultValue

getSwaggerType

getTypeDeclaration

toModelName

apiTestFileFolder

modelTestFileFolder

toApiTestFilename

toModelTestFilename

setPackageName

setPackageVersion

setPackageTitle

setPackageProductName

setPackageDescription

setPackageCompany

setPackageCopyright

setPackageAuthors

setSourceFolder

getInterfacePrefix

setInterfacePrefix

toEnumVarName

toEnumName

testPackageName

escapeQuotationMark

escapeUnsafeCharacters