io.swagger.codegen.languages

Class ObjcClientCodegen

java.lang.Object

io.swagger.codegen.DefaultCodegen

io.swagger.codegen.languages.ObjcClientCodegen

All Implemented Interfaces:

CodegenConfig

public class ObjcClientCodegen
extends DefaultCodegen
implements CodegenConfig

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTHOR_EMAIL
static String	AUTHOR_NAME
protected String	authorEmail
protected String	authorName
static String	CLASS_PREFIX
protected String	classPrefix
protected Set<String>	foundationClasses
static String	GIT_REPO_URL
protected String	gitRepoURL
protected String	license
static String	LICENSE
static String	POD_NAME
protected String	podName
protected String	podVersion
protected String[]	specialWords

Fields inherited from class io.swagger.codegen.DefaultCodegen

additionalProperties, apiPackage, apiTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, importMapping, instantiationTypes, languageSpecificPrimitives, library, LOGGER, modelPackage, modelTemplateFiles, outputFolder, reservedWords, skipOverwrite, sortParamsByRequiredFlag, supportedLibraries, supportingFiles, supportsInheritance, templateDir, typeMapping

Constructor Summary

Constructors

Constructor and Description
ObjcClientCodegen()

Method Summary

Methods

Modifier and Type	Method and Description
String	apiFileFolder()
String	escapeReservedWord(String name) Return the escaped name of the reserved word
String	escapeSpecialWord(String name)
String	getHelp()
String	getName()
String	getSwaggerType(io.swagger.models.properties.Property p) returns the swagger type for the property
CodegenType	getTag()
String	getTypeDeclaration(io.swagger.models.properties.Property p) Output the type declaration of the property
String	getTypeDeclaration(String name) Output the type declaration of a given name
String	modelFileFolder()
void	processOpts()
void	setAuthorEmail(String authorEmail)
void	setAuthorName(String authorName)
void	setClassPrefix(String classPrefix)
void	setGitRepoURL(String gitRepoURL)
void	setLicense(String license)
protected void	setNonArrayMapProperty(CodegenProperty property, String type)
void	setPodName(String podName)
void	setPodVersion(String podVersion)
String	toApiFilename(String name) Return the file name of the Api
String	toApiName(String name) Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty
String	toDefaultValue(io.swagger.models.properties.Property p) Return the default value of the property
String	toInstantiationType(io.swagger.models.properties.Property p) Return the instantiation type of the property, especially for map and array
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 type) 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 io.swagger.codegen.DefaultCodegen

additionalProperties, addOperationToGroup, apiFilename, apiPackage, apiTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, dashize, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, fromModel, fromModel, fromOperation, fromOperation, fromParameter, fromProperty, fromResponse, fromSecurity, generateExamplePath, getLibrary, getOrGenerateOperationId, getOutputDir, getterAndSetterCapitalize, importMapping, initialCaps, instantiationTypes, isSkipOverwrite, languageSpecificPrimitives, modelPackage, modelTemplateFiles, needToImport, outputFolder, postProcessModelProperty, postProcessModels, postProcessOperations, postProcessParameter, postProcessSupportingFileData, preprocessSwagger, processSwagger, removeNonNameElementToCamelCase, reservedWords, sanitizeName, setApiPackage, setEnsureUniqueParams, setLibrary, setModelPackage, setOutputDir, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, toApiImport, toApiVarName, toDefaultValueWithParam, toEnumName, toExamples, typeMapping, underscore

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, apiFilename, apiPackage, apiTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, fromModel, fromModel, fromOperation, fromOperation, fromSecurity, generateExamplePath, getLibrary, getOutputDir, importMapping, instantiationTypes, isSkipOverwrite, languageSpecificPrimitives, modelPackage, modelTemplateFiles, outputFolder, postProcessModelProperty, postProcessModels, postProcessOperations, postProcessParameter, postProcessSupportingFileData, preprocessSwagger, processSwagger, reservedWords, setLibrary, setOutputDir, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, toApiImport, toApiVarName, typeMapping

Field Detail

CLASS_PREFIX

public static final String CLASS_PREFIX

See Also:

Constant Field Values

POD_NAME

public static final String POD_NAME

See Also:

Constant Field Values

AUTHOR_NAME

public static final String AUTHOR_NAME

See Also:

Constant Field Values

AUTHOR_EMAIL

public static final String AUTHOR_EMAIL

See Also:

Constant Field Values

GIT_REPO_URL

public static final String GIT_REPO_URL

See Also:

Constant Field Values

LICENSE

public static final String LICENSE

See Also:

Constant Field Values

foundationClasses

protected Set<String> foundationClasses

podName

protected String podName

podVersion

protected String podVersion

classPrefix

protected String classPrefix

authorName

protected String authorName

authorEmail

protected String authorEmail

license

protected String license

gitRepoURL

protected String gitRepoURL

specialWords

protected String[] specialWords

Constructor Detail

ObjcClientCodegen

public ObjcClientCodegen()

Method Detail

getTag

public CodegenType getTag()

Specified by:

getTag in interface CodegenConfig

getName

public String getName()

Specified by:

getName in interface CodegenConfig

getHelp

public String getHelp()

Specified by:

getHelp in interface CodegenConfig

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class DefaultCodegen

toInstantiationType

public String toInstantiationType(io.swagger.models.properties.Property 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 - Swagger property object

Returns:

string presentation of the instantiation type of the property

getTypeDeclaration

public String getTypeDeclaration(String name)

Description copied from class: DefaultCodegen

Output the type declaration of a given name

Specified by:

getTypeDeclaration in interface CodegenConfig

Overrides:

getTypeDeclaration in class DefaultCodegen

Parameters:

name - name

Returns:

a string presentation of the type

getSwaggerType

public String getSwaggerType(io.swagger.models.properties.Property p)

Description copied from class: DefaultCodegen

returns the swagger type for the property

Overrides:

getSwaggerType in class DefaultCodegen

Parameters:

p - Swagger property object

Returns:

string presentation of the type

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 type)

Description copied from class: DefaultCodegen

Output the proper model name (capitalized)

Specified by:

toModelName in interface CodegenConfig

Overrides:

toModelName in class DefaultCodegen

Parameters:

type - the name of the model

Returns:

capitalized model name

toModelFilename

public String toModelFilename(String name)

Description copied from class: DefaultCodegen

Return the capitalized file name of the model

Specified by:

toModelFilename in interface CodegenConfig

Overrides:

toModelFilename in class DefaultCodegen

Parameters:

name - the model name

Returns:

the file name of the model

setNonArrayMapProperty

protected void setNonArrayMapProperty(CodegenProperty property,
                          String type)

Overrides:

setNonArrayMapProperty in class DefaultCodegen

toModelImport

public String toModelImport(String name)

Description copied from class: DefaultCodegen

Return the fully-qualified "Model" name for import

Specified by:

toModelImport in interface CodegenConfig

Overrides:

toModelImport in class DefaultCodegen

Parameters:

name - the name of the "Model"

Returns:

the fully-qualified "Model" name for import

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

toApiName

public String toApiName(String name)

Description copied from class: DefaultCodegen

Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty

Specified by:

toApiName in interface CodegenConfig

Overrides:

toApiName in class DefaultCodegen

Parameters:

name - the name of the Api

Returns:

capitalized Api name ending with "Api"

toApiFilename

public String toApiFilename(String name)

Description copied from class: DefaultCodegen

Return the file name of the Api

Specified by:

toApiFilename in interface CodegenConfig

Overrides:

toApiFilename in class DefaultCodegen

Parameters:

name - the file name of the Api

Returns:

the file name of the Api

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)

escapeSpecialWord

public String escapeSpecialWord(String name)

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

setClassPrefix

public void setClassPrefix(String classPrefix)

setPodName

public void setPodName(String podName)

setPodVersion

public void setPodVersion(String podVersion)

setAuthorEmail

public void setAuthorEmail(String authorEmail)

setAuthorName

public void setAuthorName(String authorName)

setGitRepoURL

public void setGitRepoURL(String gitRepoURL)

setLicense

public void setLicense(String license)

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