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

All Implemented Interfaces:: CodegenConfig

public class Swift5ClientCodegen
extends DefaultCodegen
implements CodegenConfig

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`apiDocPath`
`static String`	`DEFAULT_POD_AUTHORS`
`static String`	`GENERATE_MODEL_ADDITIONAL_PROPERTIES`
`protected boolean`	`generateModelAdditionalProperties`
`static String`	`HASHABLE_MODELS`
`protected boolean`	`hashableModels`
`static String`	`LENIENT_TYPE_CAST`
`protected boolean`	`lenientTypeCast`
`protected static String`	`LIBRARY_ALAMOFIRE`
`protected static String`	`LIBRARY_URLSESSION`
`protected static String`	`LIBRARY_VAPOR`
`static String`	`MAP_FILE_BINARY_TO_DATA`
`protected boolean`	`mapFileBinaryToData`
`protected String`	`modelDocPath`
`protected boolean`	`nonPublicApi`
`static String`	`OBJC_COMPATIBLE`
`protected boolean`	`objcCompatible`
`protected HashSet`	`objcReservedWords`
`static String`	`POD_AUTHORS`
`static String`	`POD_DESCRIPTION`
`static String`	`POD_DOCUMENTATION_URL`
`static String`	`POD_HOMEPAGE`
`static String`	`POD_LICENSE`
`static String`	`POD_SCREENSHOTS`
`static String`	`POD_SOCIAL_MEDIA_URL`
`static String`	`POD_SOURCE`
`static String`	`POD_SUMMARY`
`static String`	`PROJECT_NAME`
`protected String`	`projectName`
`static String`	`READONLY_PROPERTIES`
`protected boolean`	`readonlyProperties`
`static String`	`RESPONSE_AS`
`protected static String[]`	`RESPONSE_LIBRARIES`
`protected static String`	`RESPONSE_LIBRARY_ASYNC_AWAIT`
`protected static String`	`RESPONSE_LIBRARY_COMBINE`
`protected static String`	`RESPONSE_LIBRARY_PROMISE_KIT`
`protected static String`	`RESPONSE_LIBRARY_RESULT`
`protected static String`	`RESPONSE_LIBRARY_RX_SWIFT`
`protected String[]`	`responseAs`
`protected String`	`sourceFolder`
`static String`	`SWIFT_PACKAGE_PATH`
`static String`	`SWIFT_USE_API_NAMESPACE`
`protected String`	`swiftPackagePath`
`protected boolean`	`swiftUseApiNamespace`
`static String`	`USE_BACKTICK_ESCAPES`
`static String`	`USE_CLASSES`
`static String`	`USE_CUSTOM_DATE_WITHOUT_TIME`
`static String`	`USE_JSON_ENCODABLE`
`static String`	`USE_SPM_FILE_STRUCTURE`
`protected boolean`	`useBacktickEscapes`
`protected boolean`	`useClasses`
`protected boolean`	`useCustomDateWithoutTime`
`protected boolean`	`useJsonEncodable`
`protected boolean`	`useSPMFileStructure`
`protected boolean`	`validatable`
`static String`	`VALIDATABLE`

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

Constructor Summary

Constructors
Constructor Description

Swift5ClientCodegen()
Constructor for the swift5 language codegen module.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`addAdditionPropertiesToCodeGenModel(CodegenModel codegenModel, io.swagger.v3.oas.models.media.Schema schema)`	Handle the model for the 'additionalProperties' keyword in the OAS schema.
`String`	`apiDocFileFolder()`
`String`	`apiFileFolder()`
`String`	`constructExampleCode(CodegenModel codegenModel, HashMap<String,CodegenModel> modelMaps, Set<String> visitedModels)`
`String`	`constructExampleCode(CodegenParameter codegenParameter, HashMap<String,CodegenModel> modelMaps, Set<String> visitedModels)`
`String`	`constructExampleCode(CodegenProperty codegenProperty, HashMap<String,CodegenModel> modelMaps, Set<String> visitedModels)`
`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
`CodegenModel`	`fromModel(String name, io.swagger.v3.oas.models.media.Schema model)`	Convert OAS Model object to Codegen Model object.
`GeneratorLanguage`	`generatorLanguage()`
`String`	`getHelp()`
`String`	`getName()`
`String`	`getSchemaType(io.swagger.v3.oas.models.media.Schema p)`	returns the OpenAPI type for the property.
`CodegenType`	`getTag()`
`String`	`getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)`	Output the language-specific type declaration of the property.
`boolean`	`isDataTypeBinary(String dataType)`
`boolean`	`isDataTypeFile(String dataType)`
`boolean`	`isMapFileBinaryToData()`
`protected boolean`	`isReservedWord(String word)`
`String`	`modelDocFileFolder()`
`String`	`modelFileFolder()`
`void`	`postProcess()`
`void`	`postProcessFile(File file, String fileType)`	Post-process the auto-generated file, e.g.
`void`	`postProcessModelProperty(CodegenModel model, CodegenProperty property)`
`ModelsMap`	`postProcessModels(ModelsMap objs)`
`OperationsMap`	`postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels)`
`void`	`processOpts()`
`void`	`setGenerateModelAdditionalProperties(boolean generateModelAdditionalProperties)`
`void`	`setHashableModels(boolean hashableModels)`
`void`	`setLenientTypeCast(boolean lenientTypeCast)`
`void`	`setMapFileBinaryToData(boolean mapFileBinaryToData)`
`void`	`setNonPublicApi(boolean nonPublicApi)`
`void`	`setObjcCompatible(boolean objcCompatible)`
`void`	`setProjectName(String projectName)`
`void`	`setReadonlyProperties(boolean readonlyProperties)`
`void`	`setResponseAs(String[] responseAs)`
`void`	`setSwiftPackagePath(String swiftPackagePath)`
`void`	`setSwiftUseApiNamespace(boolean swiftUseApiNamespace)`
`void`	`setUseBacktickEscapes(boolean useBacktickEscapes)`
`void`	`setUseClasses(boolean useClasses)`
`void`	`setUseCustomDateWithoutTime(boolean useCustomDateWithoutTime)`
`void`	`setUseJsonEncodable(boolean useJsonEncodable)`
`void`	`setUseSPMFileStructure(boolean useSPMFileStructure)`
`void`	`setValidatable(boolean validatable)`
`String`	`toApiDocFilename(String name)`	Return the file name of the Api Documentation
`String`	`toApiName(String name)`	Output the API (class) name (capitalized) ending with the specified or default suffix Return DefaultApi if name is empty
`String`	`toDefaultValue(io.swagger.v3.oas.models.media.Schema p)`	Return the default value of the property
`String`	`toEnumDefaultValue(String value, String datatype)`	Return the enum default value in the language specified format
`String`	`toEnumName(CodegenProperty property)`	Return the Enum name (e.g.
`String`	`toEnumValue(String value, String datatype)`	Return the enum value in the language specified format e.g.
`String`	`toEnumVarName(String name, String datatype)`	Return the sanitized variable name for enum
`String`	`toInstantiationType(io.swagger.v3.oas.models.media.Schema 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`	`toModelName(String name)`	Output the proper model name (capitalized).
`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 org.openapitools.codegen.DefaultCodegen
addBodyModelSchema, addHeaders, addImport, addImport, addImport, addImports, addImports, addImports, addImportsForPropertyType, addImportsToOneOfInterface, additionalProperties, addMustacheLambdas, addOneOfInterfaceModel, addOneOfNameExtension, addOperationToGroup, addOption, addOption, addParentContainer, addParentFromContainer, addProperties, addRegularExpressionDelimiter, addRequiredVarsMap, addSwitch, addVars, addVars, addVarsRequiredVarsAdditionalProps, apiDocFilename, apiDocTemplateFiles, apiFilename, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildEnumVars, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, createDiscriminator, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, enumNameMapping, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromOperation, fromParameter, fromProperty, fromProperty, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, generatorLanguageVersion, getAdditionalPropertiesName, getAddSuffixToDuplicateOperationNicknames, getAlias, getAllModels, getAllOfDescendants, getAllowUnicodeIdentifiers, getApiNamePrefix, getApiNameSuffix, getCollectionFormat, getCollectionFormat, getConsumesInfo, getContent, getContentType, getDisallowAdditionalPropertiesIfNotPresent, getDocExtension, getEnsureUniqueParams, getEnumDefaultValue, getEnumUnknownDefaultCase, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getItemsName, getLegacyDiscriminatorBehavior, getLibrary, getModelNamePrefix, getModelNameSuffix, getModelNameToSchemaCache, getMostInnerItems, getOneOfAnyOfDescendants, getOpenAPIGeneratorIgnoreList, getOrGenerateOperationId, getOutputDir, getParameterDataType, getPrependFormOrBodyParameters, getProducesInfo, getReleaseNote, getRemoveOperationIdPrefixCount, getRemoveOperationIdPrefixDelimiter, getSchemaAdditionalProperties, getSchemaFromBooleanOrSchema, getSchemaItems, getSingleSchemaType, getSortModelPropertiesByRequiredFlag, getSortParamsByRequiredFlag, getSupportedVendorExtensions, getSymbolName, getTemplatingEngine, getterAndSetterCapitalize, getTypeDeclaration, getUseInlineModelResolver, getUseOneOfInterfaces, getUseOpenAPINormalizer, getVersionMetadataFilename, handleConstantParams, handleMethodResponse, handleMethodResponse, handleSpecialCharacters, hasBodyParameter, hasFormParameter, importMapping, initializeSpecialCharacterMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isAnyTypeSchema, isDataTypeString, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isJsonMimeType, isJsonVendorMimeType, isLibrary, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, isXmlMimeType, languageSpecificPrimitives, lowerCamelCase, modelDocTemplateFiles, modelFilename, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, modifyFeatureSet, nameMapping, needToImport, openapiGeneratorIgnoreList, openapiNormalizer, outputFolder, parameterNameMapping, postProcessAllModels, postProcessEnumVars, postProcessModelsEnum, postProcessParameter, postProcessResponseWithProperty, postProcessSupportingFileData, postProcessWebhooksWithModels, preprocessOpenAPI, processCompiler, processOpenAPI, processTemplatingEngine, processTestExampleData, removeImport, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, removeSelfReferenceImports, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, sanitizeTag, schemaMapping, serverVariableOverrides, setAddProps, setAllowUnicodeIdentifiers, setApiNamePrefix, setApiNameSuffix, setApiPackage, setAutosetConstants, setCircularReferences, setDisallowAdditionalPropertiesIfNotPresent, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnsureUniqueParams, setEnumUnknownDefaultCase, setFilesMetadataFilename, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLegacyDiscriminatorBehavior, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOpenAPI, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterEncodingValues, setParameterExamples, setParameterExampleValue, setParameterExampleValue, setParameterExampleValue, setParameterNullable, setPrependFormOrBodyParameters, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setRemoveOperationIdPrefixCount, setRemoveOperationIdPrefixDelimiter, setReservedWordsLowerCase, setSkipOperationExample, setSkipOverwrite, setSortModelPropertiesByRequiredFlag, setSortParamsByRequiredFlag, setStrictSpecBehavior, setTemplateDir, setTemplatingEngine, setUseOneOfInterfaces, setVersionMetadataFilename, shouldAddImport, shouldOverwrite, specVersionGreaterThanOrEqualTo310, supportedLibraries, supportingFiles, templateDir, templateOutputDirs, testPackage, toAllOfName, toAnyOfName, toApiFilename, toApiImport, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultParameterValue, toDefaultParameterValue, toDefaultValue, toDefaultValueWithParam, toExamples, toExampleValue, toGetter, toMediaTypeSchemaName, toModelImport, toModelImportMap, toModelTestFilename, toOneOfName, toRegularExpression, toSetter, toTestCaseName, typeMapping, unaliasPropertySchema, unaliasSchema, updateAllModels, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateEnumVarsWithExtensions, updateModelForAnyType, updateModelForComposedSchema, updateModelForInteger, updateModelForNumber, updateModelForObject, updateModelForString, updateOption, updateParameterForString, updatePropertyForAnyType, updatePropertyForArray, updatePropertyForInteger, updatePropertyForMap, updatePropertyForMap, updatePropertyForNumber, updatePropertyForObject, updatePropertyForString, updateRequestBodyForArray, updateRequestBodyForMap, updateRequestBodyForObject, updateRequestBodyForPrimitiveType, updateRequestBodyForString, vendorExtensions, writePropertyBack

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

Methods inherited from interface org.openapitools.codegen.CodegenConfig
additionalProperties, addOperationToGroup, apiDocFilename, apiDocTemplateFiles, apiFilename, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, enumNameMapping, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generatorLanguageVersion, getAddSuffixToDuplicateOperationNicknames, getDocExtension, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOpenAPIGeneratorIgnoreList, getOutputDir, getReleaseNote, getSupportedVendorExtensions, getTemplatingEngine, getTypeDeclaration, getUseInlineModelResolver, getUseOpenAPINormalizer, getVersionMetadataFilename, importMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, modelDocTemplateFiles, modelFilename, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, nameMapping, openapiGeneratorIgnoreList, openapiNormalizer, outputFolder, parameterNameMapping, postProcessAllModels, postProcessParameter, postProcessResponseWithProperty, postProcessSupportingFileData, postProcessWebhooksWithModels, preprocessOpenAPI, processCompiler, processOpenAPI, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, schemaMapping, serverVariableOverrides, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOpenAPI, setOutputDir, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setSkipOperationExample, setSkipOverwrite, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, templateOutputDirs, testPackage, toApiFilename, toApiImport, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelImport, toModelImportMap, toModelTestFilename, toSetter, typeMapping, unaliasSchema, updateAllModels, vendorExtensions

- Field Detail
  - PROJECT_NAME
```
public static final String PROJECT_NAME
```
    See Also:
    
    Constant Field Values
  - RESPONSE_AS
```
public static final String RESPONSE_AS
```
    See Also:
    
    Constant Field Values
  - OBJC_COMPATIBLE
```
public static final String OBJC_COMPATIBLE
```
    See Also:
    
    Constant Field Values
  - POD_SOURCE
```
public static final String POD_SOURCE
```
    See Also:
    
    Constant Field Values
  - POD_AUTHORS
```
public static final String POD_AUTHORS
```
    See Also:
    
    Constant Field Values
  - POD_SOCIAL_MEDIA_URL
```
public static final String POD_SOCIAL_MEDIA_URL
```
    See Also:
    
    Constant Field Values
  - POD_LICENSE
```
public static final String POD_LICENSE
```
    See Also:
    
    Constant Field Values
  - POD_HOMEPAGE
```
public static final String POD_HOMEPAGE
```
    See Also:
    
    Constant Field Values
  - POD_SUMMARY
```
public static final String POD_SUMMARY
```
    See Also:
    
    Constant Field Values
  - POD_DESCRIPTION
```
public static final String POD_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - POD_SCREENSHOTS
```
public static final String POD_SCREENSHOTS
```
    See Also:
    
    Constant Field Values
  - POD_DOCUMENTATION_URL
```
public static final String POD_DOCUMENTATION_URL
```
    See Also:
    
    Constant Field Values
  - READONLY_PROPERTIES
```
public static final String READONLY_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - SWIFT_USE_API_NAMESPACE
```
public static final String SWIFT_USE_API_NAMESPACE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_POD_AUTHORS
```
public static final String DEFAULT_POD_AUTHORS
```
    See Also:
    
    Constant Field Values
  - LENIENT_TYPE_CAST
```
public static final String LENIENT_TYPE_CAST
```
    See Also:
    
    Constant Field Values
  - USE_SPM_FILE_STRUCTURE
```
public static final String USE_SPM_FILE_STRUCTURE
```
    See Also:
    
    Constant Field Values
  - SWIFT_PACKAGE_PATH
```
public static final String SWIFT_PACKAGE_PATH
```
    See Also:
    
    Constant Field Values
  - USE_CLASSES
```
public static final String USE_CLASSES
```
    See Also:
    
    Constant Field Values
  - USE_BACKTICK_ESCAPES
```
public static final String USE_BACKTICK_ESCAPES
```
    See Also:
    
    Constant Field Values
  - GENERATE_MODEL_ADDITIONAL_PROPERTIES
```
public static final String GENERATE_MODEL_ADDITIONAL_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - HASHABLE_MODELS
```
public static final String HASHABLE_MODELS
```
    See Also:
    
    Constant Field Values
  - USE_JSON_ENCODABLE
```
public static final String USE_JSON_ENCODABLE
```
    See Also:
    
    Constant Field Values
  - MAP_FILE_BINARY_TO_DATA
```
public static final String MAP_FILE_BINARY_TO_DATA
```
    See Also:
    
    Constant Field Values
  - USE_CUSTOM_DATE_WITHOUT_TIME
```
public static final String USE_CUSTOM_DATE_WITHOUT_TIME
```
    See Also:
    
    Constant Field Values
  - VALIDATABLE
```
public static final String VALIDATABLE
```
    See Also:
    
    Constant Field Values
  - LIBRARY_ALAMOFIRE
```
protected static final String LIBRARY_ALAMOFIRE
```
    See Also:
    
    Constant Field Values
  - LIBRARY_URLSESSION
```
protected static final String LIBRARY_URLSESSION
```
    See Also:
    
    Constant Field Values
  - LIBRARY_VAPOR
```
protected static final String LIBRARY_VAPOR
```
    See Also:
    
    Constant Field Values
  - RESPONSE_LIBRARY_PROMISE_KIT
```
protected static final String RESPONSE_LIBRARY_PROMISE_KIT
```
    See Also:
    
    Constant Field Values
  - RESPONSE_LIBRARY_RX_SWIFT
```
protected static final String RESPONSE_LIBRARY_RX_SWIFT
```
    See Also:
    
    Constant Field Values
  - RESPONSE_LIBRARY_RESULT
```
protected static final String RESPONSE_LIBRARY_RESULT
```
    See Also:
    
    Constant Field Values
  - RESPONSE_LIBRARY_COMBINE
```
protected static final String RESPONSE_LIBRARY_COMBINE
```
    See Also:
    
    Constant Field Values
  - RESPONSE_LIBRARY_ASYNC_AWAIT
```
protected static final String RESPONSE_LIBRARY_ASYNC_AWAIT
```
    See Also:
    
    Constant Field Values
  - RESPONSE_LIBRARIES
```
protected static final String[] RESPONSE_LIBRARIES
```
  - projectName
```
protected String projectName
```
  - nonPublicApi
```
protected boolean nonPublicApi
```
  - objcCompatible
```
protected boolean objcCompatible
```
  - lenientTypeCast
```
protected boolean lenientTypeCast
```
  - readonlyProperties
```
protected boolean readonlyProperties
```
  - swiftUseApiNamespace
```
protected boolean swiftUseApiNamespace
```
  - useSPMFileStructure
```
protected boolean useSPMFileStructure
```
  - swiftPackagePath
```
protected String swiftPackagePath
```
  - useClasses
```
protected boolean useClasses
```
  - useBacktickEscapes
```
protected boolean useBacktickEscapes
```
  - generateModelAdditionalProperties
```
protected boolean generateModelAdditionalProperties
```
  - hashableModels
```
protected boolean hashableModels
```
  - useJsonEncodable
```
protected boolean useJsonEncodable
```
  - mapFileBinaryToData
```
protected boolean mapFileBinaryToData
```
  - useCustomDateWithoutTime
```
protected boolean useCustomDateWithoutTime
```
  - validatable
```
protected boolean validatable
```
  - responseAs
```
protected String[] responseAs
```
  - sourceFolder
```
protected String sourceFolder
```
  - objcReservedWords
```
protected HashSet objcReservedWords
```
  - apiDocPath
```
protected String apiDocPath
```
  - modelDocPath
```
protected String modelDocPath
```
- Constructor Detail
  - Swift5ClientCodegen
```
public Swift5ClientCodegen()
```
    Constructor for the swift5 language codegen module.
- Method Detail
  - getTag
```
public CodegenType getTag()
```
    Specified by:
    
    getTag in interface CodegenConfig
    
    Overrides:
    
    getTag in class DefaultCodegen
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface CodegenConfig
    
    Overrides:
    
    getName in class DefaultCodegen
  - getHelp
```
public String getHelp()
```
    Specified by:
    
    getHelp in interface CodegenConfig
    
    Overrides:
    
    getHelp in class DefaultCodegen
  - addAdditionPropertiesToCodeGenModel
```
protected void addAdditionPropertiesToCodeGenModel(CodegenModel codegenModel,
                                                   io.swagger.v3.oas.models.media.Schema schema)
```
    Description copied from class: DefaultCodegen
    
    Handle the model for the 'additionalProperties' keyword in the OAS schema.
    
    Overrides:
    
    addAdditionPropertiesToCodeGenModel in class DefaultCodegen
    
    Parameters:
    
    codegenModel - The codegen representation of the schema.
    
    schema - The input OAS schema.
  - processOpts
```
public void processOpts()
```
    Specified by:
    
    processOpts in interface CodegenConfig
    
    Overrides:
    
    processOpts in class DefaultCodegen
  - isMapFileBinaryToData
```
public boolean isMapFileBinaryToData()
```
  - setMapFileBinaryToData
```
public void setMapFileBinaryToData(boolean mapFileBinaryToData)
```
  - setUseCustomDateWithoutTime
```
public void setUseCustomDateWithoutTime(boolean useCustomDateWithoutTime)
```
  - isReservedWord
```
protected boolean isReservedWord(String word)
```
    Overrides:
    
    isReservedWord 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)
  - modelFileFolder
```
public String modelFileFolder()
```
    Specified by:
    
    modelFileFolder in interface CodegenConfig
    
    Overrides:
    
    modelFileFolder in class DefaultCodegen
  - apiFileFolder
```
public String apiFileFolder()
```
    Specified by:
    
    apiFileFolder in interface CodegenConfig
    
    Overrides:
    
    apiFileFolder in class DefaultCodegen
  - getTypeDeclaration
```
public String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)
```
    Description copied from class: DefaultCodegen
    
    Output the language-specific type declaration of the property.
    
    Specified by:
    
    getTypeDeclaration in interface CodegenConfig
    
    Overrides:
    
    getTypeDeclaration in class DefaultCodegen
    
    Parameters:
    
    p - property schema
    
    Returns:
    
    a string presentation of the property type
  - getSchemaType
```
public String getSchemaType(io.swagger.v3.oas.models.media.Schema p)
```
    Description copied from class: DefaultCodegen
    
    returns the OpenAPI type for the property. Use getAlias to handle $ref of primitive type
    
    Overrides:
    
    getSchemaType in class DefaultCodegen
    
    Parameters:
    
    p - property schema
    
    Returns:
    
    string presentation of the type
  - isDataTypeFile
```
public boolean isDataTypeFile(String dataType)
```
    Overrides:
    
    isDataTypeFile in class DefaultCodegen
  - isDataTypeBinary
```
public boolean isDataTypeBinary(String dataType)
```
    Overrides:
    
    isDataTypeBinary in class DefaultCodegen
  - toModelName
```
public String toModelName(String name)
```
    Output the proper model name (capitalized).
    
    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)
```
    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
  - toDefaultValue
```
public String toDefaultValue(io.swagger.v3.oas.models.media.Schema p)
```
    Description copied from class: DefaultCodegen
    
    Return the default value of the property
    This method should be overridden in the generator to meet its requirement. Return null if you do NOT want a default value. Any non-null value will cause {{#defaultValue} check to pass.
    
    Overrides:
    
    toDefaultValue in class DefaultCodegen
    
    Parameters:
    
    p - Property schema
    
    Returns:
    
    string presentation of the default value of the property
  - toInstantiationType
```
public String toInstantiationType(io.swagger.v3.oas.models.media.Schema p)
```
    Description copied from class: DefaultCodegen
    
    Return the instantiation type of the property, especially for map and array
    
    Overrides:
    
    toInstantiationType in class DefaultCodegen
    
    Parameters:
    
    p - property schema
    
    Returns:
    
    string presentation of the instantiation type of the property
  - toApiName
```
public String toApiName(String name)
```
    Description copied from class: DefaultCodegen
    
    Output the API (class) name (capitalized) ending with the specified or default suffix Return DefaultApi if name is empty
    
    Specified by:
    
    toApiName in interface CodegenConfig
    
    Overrides:
    
    toApiName in class DefaultCodegen
    
    Parameters:
    
    name - the name of the Api
    
    Returns:
    
    capitalized Api name
  - 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
  - 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
  - fromModel
```
public CodegenModel fromModel(String name,
                              io.swagger.v3.oas.models.media.Schema model)
```
    Description copied from class: DefaultCodegen
    
    Convert OAS Model object to Codegen Model object.
    
    Specified by:
    
    fromModel in interface CodegenConfig
    
    Overrides:
    
    fromModel in class DefaultCodegen
    
    Parameters:
    
    name - the name of the model
    
    model - OAS Model object
    
    Returns:
    
    Codegen Model object
  - setProjectName
```
public void setProjectName(String projectName)
```
  - setNonPublicApi
```
public void setNonPublicApi(boolean nonPublicApi)
```
  - setObjcCompatible
```
public void setObjcCompatible(boolean objcCompatible)
```
  - setLenientTypeCast
```
public void setLenientTypeCast(boolean lenientTypeCast)
```
  - setReadonlyProperties
```
public void setReadonlyProperties(boolean readonlyProperties)
```
  - setResponseAs
```
public void setResponseAs(String[] responseAs)
```
  - setSwiftUseApiNamespace
```
public void setSwiftUseApiNamespace(boolean swiftUseApiNamespace)
```
  - setUseSPMFileStructure
```
public void setUseSPMFileStructure(boolean useSPMFileStructure)
```
  - setSwiftPackagePath
```
public void setSwiftPackagePath(String swiftPackagePath)
```
  - setUseClasses
```
public void setUseClasses(boolean useClasses)
```
  - setUseBacktickEscapes
```
public void setUseBacktickEscapes(boolean useBacktickEscapes)
```
  - setGenerateModelAdditionalProperties
```
public void setGenerateModelAdditionalProperties(boolean generateModelAdditionalProperties)
```
  - setHashableModels
```
public void setHashableModels(boolean hashableModels)
```
  - setUseJsonEncodable
```
public void setUseJsonEncodable(boolean useJsonEncodable)
```
  - setValidatable
```
public void setValidatable(boolean validatable)
```
  - 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
  - postProcessModels
```
public ModelsMap postProcessModels(ModelsMap objs)
```
    Specified by:
    
    postProcessModels in interface CodegenConfig
    
    Overrides:
    
    postProcessModels in class DefaultCodegen
  - postProcessModelProperty
```
public void postProcessModelProperty(CodegenModel model,
                                     CodegenProperty property)
```
    Specified by:
    
    postProcessModelProperty in interface CodegenConfig
    
    Overrides:
    
    postProcessModelProperty in class DefaultCodegen
  - 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
  - postProcessFile
```
public void postProcessFile(File file,
                            String fileType)
```
    Description copied from class: DefaultCodegen
    
    Post-process the auto-generated file, e.g. using go-fmt to format the Go code. The file type can be "model-test", "model-doc", "model", "api", "api-test", "api-doc", "supporting-mustache", "supporting-common", "openapi-generator-ignore", "openapi-generator-version"
    TODO: store these values in enum instead
    
    Specified by:
    
    postProcessFile in interface CodegenConfig
    
    Overrides:
    
    postProcessFile in class DefaultCodegen
    
    Parameters:
    
    file - file to be processed
    
    fileType - file type
  - postProcessOperationsWithModels
```
public OperationsMap postProcessOperationsWithModels(OperationsMap objs,
                                                     List<ModelMap> allModels)
```
    Specified by:
    
    postProcessOperationsWithModels in interface CodegenConfig
    
    Overrides:
    
    postProcessOperationsWithModels in class DefaultCodegen
  - constructExampleCode
```
public String constructExampleCode(CodegenParameter codegenParameter,
                                   HashMap<String,CodegenModel> modelMaps,
                                   Set<String> visitedModels)
```
  - constructExampleCode
```
public String constructExampleCode(CodegenProperty codegenProperty,
                                   HashMap<String,CodegenModel> modelMaps,
                                   Set<String> visitedModels)
```
  - constructExampleCode
```
public String constructExampleCode(CodegenModel codegenModel,
                                   HashMap<String,CodegenModel> modelMaps,
                                   Set<String> visitedModels)
```
  - postProcess
```
public void postProcess()
```
    Specified by:
    
    postProcess in interface CodegenConfig
    
    Overrides:
    
    postProcess in class DefaultCodegen
  - generatorLanguage
```
public GeneratorLanguage generatorLanguage()
```
    Specified by:
    
    generatorLanguage in interface CodegenConfig
    
    Overrides:
    
    generatorLanguage in class DefaultCodegen

Class Swift5ClientCodegen

Field Summary

Fields inherited from class org.openapitools.codegen.DefaultCodegen

Constructor Summary

Method Summary

Methods inherited from class org.openapitools.codegen.DefaultCodegen

Methods inherited from class java.lang.Object

Methods inherited from interface org.openapitools.codegen.CodegenConfig

Field Detail

PROJECT_NAME

RESPONSE_AS

OBJC_COMPATIBLE

POD_SOURCE

POD_AUTHORS

POD_SOCIAL_MEDIA_URL

POD_LICENSE

POD_HOMEPAGE

POD_SUMMARY

POD_DESCRIPTION

POD_SCREENSHOTS

POD_DOCUMENTATION_URL

READONLY_PROPERTIES

SWIFT_USE_API_NAMESPACE

DEFAULT_POD_AUTHORS

LENIENT_TYPE_CAST

USE_SPM_FILE_STRUCTURE

SWIFT_PACKAGE_PATH

USE_CLASSES

USE_BACKTICK_ESCAPES

GENERATE_MODEL_ADDITIONAL_PROPERTIES

HASHABLE_MODELS

USE_JSON_ENCODABLE

MAP_FILE_BINARY_TO_DATA

USE_CUSTOM_DATE_WITHOUT_TIME

VALIDATABLE

LIBRARY_ALAMOFIRE

LIBRARY_URLSESSION

LIBRARY_VAPOR

RESPONSE_LIBRARY_PROMISE_KIT

RESPONSE_LIBRARY_RX_SWIFT

RESPONSE_LIBRARY_RESULT

RESPONSE_LIBRARY_COMBINE

RESPONSE_LIBRARY_ASYNC_AWAIT

RESPONSE_LIBRARIES

projectName

nonPublicApi

objcCompatible

lenientTypeCast

readonlyProperties

swiftUseApiNamespace

useSPMFileStructure

swiftPackagePath

useClasses

useBacktickEscapes

generateModelAdditionalProperties

hashableModels

useJsonEncodable

mapFileBinaryToData

useCustomDateWithoutTime

validatable

responseAs

sourceFolder

objcReservedWords

apiDocPath

modelDocPath

Constructor Detail

Swift5ClientCodegen

Method Detail

getTag

getName

getHelp

addAdditionPropertiesToCodeGenModel

processOpts

isMapFileBinaryToData

setMapFileBinaryToData

setUseCustomDateWithoutTime

isReservedWord

escapeReservedWord

modelFileFolder

apiFileFolder