io.swagger.codegen.languages

Class AkkaScalaClientCodegen

java.lang.Object

io.swagger.codegen.DefaultCodegen

io.swagger.codegen.languages.AkkaScalaClientCodegen

All Implemented Interfaces:

CodegenConfig

public class AkkaScalaClientCodegen
extends DefaultCodegen
implements CodegenConfig

Field Summary

Fields

Modifier and Type	Field and Description
protected String	artifactId
protected String	artifactVersion
protected String	configKey
protected String	configKeyPath
protected int	defaultTimeoutInMs
protected String	groupId
protected String	invokerPackage
protected String	mainPackage
protected boolean	onlyOneSuccess If set to true, only the default response (the one with le lowest 2XX code) will be considered as a success, and all others as ApiErrors.
protected boolean	registerNonStandardStatusCodes
protected boolean	removeOAuthSecurities
protected boolean	renderJavadoc
protected String	resourcesFolder
protected String	sourceFolder

Fields inherited from class io.swagger.codegen.DefaultCodegen

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

Constructor Summary

Constructors

Constructor and Description
AkkaScalaClientCodegen()

Method Summary

Methods

Modifier and Type	Method and Description
String	apiFileFolder()
String	escapeReservedWord(String name) Return the escaped name of the reserved word
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	getHelp()
String	getName()
String	getSwaggerType(io.swagger.models.properties.Property p) returns the swagger type for the property
CodegenType	getTag()
String	getTypeDeclaration(io.swagger.models.properties.Property p) Output the type declaration of the property
String	modelFileFolder()
Map<String,Object>	postProcessOperations(Map<String,Object> objs)
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	toInstantiationType(io.swagger.models.properties.Property p) Return the instantiation type of the property, especially for map and array
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, generateExamplePath, getLibrary, getOrGenerateOperationId, getOutputDir, getterAndSetterCapitalize, getTypeDeclaration, importMapping, initialCaps, instantiationTypes, isSkipOverwrite, languageSpecificPrimitives, modelPackage, modelTemplateFiles, needToImport, outputFolder, postProcessModelProperty, postProcessModels, postProcessParameter, postProcessSupportingFileData, preprocessSwagger, processOpts, processSwagger, removeNonNameElementToCamelCase, reservedWords, sanitizeName, setApiPackage, setEnsureUniqueParams, setLibrary, setModelPackage, setNonArrayMapProperty, setOutputDir, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, toApiFilename, toApiImport, toApiName, toApiVarName, toDefaultValueWithParam, toExamples, toModelFilename, toModelImport, toModelName, 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, generateExamplePath, getLibrary, getOutputDir, getTypeDeclaration, importMapping, instantiationTypes, isSkipOverwrite, languageSpecificPrimitives, modelPackage, modelTemplateFiles, outputFolder, postProcessModelProperty, postProcessModels, postProcessParameter, postProcessSupportingFileData, preprocessSwagger, processOpts, processSwagger, reservedWords, setLibrary, setOutputDir, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, toApiFilename, toApiImport, toApiName, toApiVarName, toModelFilename, toModelImport, toModelName, typeMapping

Field Detail

mainPackage

protected String mainPackage

invokerPackage

protected String invokerPackage

groupId

protected String groupId

artifactId

protected String artifactId

artifactVersion

protected String artifactVersion

sourceFolder

protected String sourceFolder

resourcesFolder

protected String resourcesFolder

configKey

protected String configKey

defaultTimeoutInMs

protected int defaultTimeoutInMs

configKeyPath

protected String configKeyPath

registerNonStandardStatusCodes

protected boolean registerNonStandardStatusCodes

renderJavadoc

protected boolean renderJavadoc

removeOAuthSecurities

protected boolean removeOAuthSecurities

onlyOneSuccess

protected boolean onlyOneSuccess

If set to true, only the default response (the one with le lowest 2XX code) will be considered as a success, and all others as ApiErrors. If set to false, all responses defined in the model will be considered as a success upon reception. Only http errors, unmarshalling problems and any other RuntimeException will be considered as ApiErrors.

Constructor Detail

AkkaScalaClientCodegen

public AkkaScalaClientCodegen()

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

escapeReservedWord

public String escapeReservedWord(String name)

Description copied from class: DefaultCodegen

Return the escaped name of the reserved word

Specified by:

escapeReservedWord in interface CodegenConfig

Overrides:

escapeReservedWord in class DefaultCodegen

Parameters:

name - the name to be escaped

Returns:

the escaped reserved word throws Runtime exception as reserved word is not allowed (default behavior)

apiFileFolder

public String apiFileFolder()

Specified by:

apiFileFolder in interface CodegenConfig

Overrides:

apiFileFolder in class DefaultCodegen

modelFileFolder

public String modelFileFolder()

Specified by:

modelFileFolder in interface CodegenConfig

Overrides:

modelFileFolder in class DefaultCodegen

postProcessOperations

public Map<String,Object> postProcessOperations(Map<String,Object> objs)

Specified by:

postProcessOperations in interface CodegenConfig

Overrides:

postProcessOperations in class DefaultCodegen

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

fromSecurity

public List<CodegenSecurity> fromSecurity(Map<String,io.swagger.models.auth.SecuritySchemeDefinition> schemes)

Description copied from class: DefaultCodegen

Convert map of Swagger SecuritySchemeDefinition objects to a list of Codegen Security objects

Specified by:

fromSecurity in interface CodegenConfig

Overrides:

fromSecurity in class DefaultCodegen

Parameters:

schemes - a map of Swagger SecuritySchemeDefinition object

Returns:

a list of Codegen Security objects

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

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

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

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 object

Returns:

the Enum name

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

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

toDefaultValue

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

Description copied from class: DefaultCodegen

Return the default value of the property

Overrides:

toDefaultValue in class DefaultCodegen

Parameters:

p - Swagger property object

Returns:

string presentation of the default value of the property