io.swagger.codegen.v3.generators.scala

Class ScalaClientCodegen

java.lang.Object

io.swagger.codegen.v3.generators.DefaultCodegenConfig

io.swagger.codegen.v3.generators.scala.AbstractScalaCodegen

io.swagger.codegen.v3.generators.scala.ScalaClientCodegen

All Implemented Interfaces:

io.swagger.codegen.v3.CodegenConfig

public class ScalaClientCodegen
extends AbstractScalaCodegen

Field Summary

Fields

Modifier and Type	Field and Description
protected String	artifactId
protected String	artifactVersion
protected boolean	asyncHttpClient
protected boolean	authPreemptive
protected String	authScheme
protected String	clientName
protected String	gradleWrapperPackage
protected String	groupId
protected String	invokerPackage

Fields inherited from class io.swagger.codegen.v3.generators.scala.AbstractScalaCodegen

modelPropertyNaming, sourceFolder

Fields inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, copyFistAllOfProperties, DEFAULT_CONTENT_TYPE, DEFAULT_TEMPLATE_DIR, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importMapping, inputSpec, inputURL, instantiationTypes, languageArguments, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, outputFolder, releaseNote, removeOperationIdPrefix, REQUEST_BODY_NAME, reservedWords, reservedWordsMappings, schemaHandler, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, templateDir, templateEngine, templateVersion, testPackage, typeAliases, typeMapping, unflattenedOpenAPI, useOas2, vendorExtensions

Constructor Summary

Constructors

Constructor and Description
ScalaClientCodegen()

Method Summary

Modifier and Type	Method and Description
String	escapeQuotationMark(String input) Escape single and/or double quote to avoid code injection
String	getDefaultTemplateDir()
String	getHelp()
String	getModelPropertyNaming()
String	getName()
String	getNameUsingModelPropertyNaming(String name)
io.swagger.codegen.v3.CodegenType	getTag()
void	processOpts()
void	setModelPropertyNaming(String naming)
String	toEnumName(io.swagger.codegen.v3.CodegenProperty property) Return the Enum name (e.g.
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 io.swagger.codegen.v3.generators.scala.AbstractScalaCodegen

apiFileFolder, escapeReservedWord, escapeUnsafeCharacters, formatIdentifier, getSchemaType, getSourceFolder, getTypeDeclaration, modelFileFolder, postProcessModels, processCompiler, setSourceFolder, setTemplateEngine, stripPackageName, toDefaultValue, toInstantiationType, toModelFilename

Methods inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig

addAdditionPropertiesToCodeGenModel, addConsumesInfo, addHandlebarHelpers, addImport, additionalProperties, addOperationToGroup, addOption, addOption, addProducesInfo, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, configureDataForTestTemplate, configuresParameterForMediaType, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, detectParent, embeddedTemplateDir, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromModel, fromModel, fromOperation, fromOperation, fromParameter, fromProperty, fromRequestBody, fromResponse, fromSecurity, generateExamplePath, getAlias, getArgumentsLocation, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getGitRepoId, getGitUserId, getHideGenerationTimestamp, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getInputURL, getLanguageArguments, getLibrary, getOptionValue, getOrGenerateOperationId, getOutputDir, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSchemaFromBody, getSchemaFromResponse, getSortParamsByRequiredFlag, getSymbolName, getTemplateDir, getTemplateEngine, getTemplateVersion, getterAndSetterCapitalize, getTypeDeclaration, hasSchemaProperties, hasTrueAdditionalProperties, importMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isObjectSchema, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needsUnflattenedSpec, needToImport, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessModelsEnum, postProcessOperations, postProcessOperationsWithModels, postProcessParameter, postProcessSupportingFileData, preprocessOpenAPI, processModelEnums, processOpenAPI, readLanguageArguments, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setInputURL, setLanguageArguments, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setParameterNullable, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, setTemplateVersion, setUnflattenedOpenAPI, setUseOas2, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toDefaultValueWithParam, toEnumDefaultValue, toEnumValue, toEnumVarName, toExamples, toExampleValue, toGetter, toModelDocFilename, toModelImport, toModelTestFilename, toRegularExpression, toSetter, 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

Field Detail

authScheme

protected String authScheme

gradleWrapperPackage

protected String gradleWrapperPackage

authPreemptive

protected boolean authPreemptive

asyncHttpClient

protected boolean asyncHttpClient

groupId

protected String groupId

artifactId

protected String artifactId

artifactVersion

protected String artifactVersion

clientName

protected String clientName

invokerPackage

protected String invokerPackage

Constructor Detail

ScalaClientCodegen

public ScalaClientCodegen()

Method Detail

processOpts

public void processOpts()

Specified by:

processOpts in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

processOpts in class AbstractScalaCodegen

setModelPropertyNaming

public void setModelPropertyNaming(String naming)

getModelPropertyNaming

public String getModelPropertyNaming()

toVarName

public String toVarName(String name)

Description copied from class: DefaultCodegenConfig

Return the variable name by removing invalid characters and proper escaping if it's a reserved word.

Overrides:

toVarName in class DefaultCodegenConfig

Parameters:

name - the variable name

Returns:

the sanitized variable name

toParamName

public String toParamName(String name)

Description copied from class: DefaultCodegenConfig

Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.

Specified by:

toParamName in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toParamName in class DefaultCodegenConfig

Parameters:

name - Codegen property object

Returns:

the sanitized parameter name

getNameUsingModelPropertyNaming

public String getNameUsingModelPropertyNaming(String name)

getTag

public io.swagger.codegen.v3.CodegenType getTag()

getName

public String getName()

getHelp

public String getHelp()

toOperationId

public String toOperationId(String operationId)

Description copied from class: DefaultCodegenConfig

Return the operation ID (method name)

Overrides:

toOperationId in class DefaultCodegenConfig

Parameters:

operationId - operation ID

Returns:

the sanitized method name

toModelName

public String toModelName(String name)

Description copied from class: DefaultCodegenConfig

Output the proper model name (capitalized). In case the name belongs to the TypeSystem it won't be renamed.

Specified by:

toModelName in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toModelName in class DefaultCodegenConfig

Parameters:

name - the name of the model

Returns:

capitalized model name

getDefaultTemplateDir

public String getDefaultTemplateDir()

Specified by:

getDefaultTemplateDir in class DefaultCodegenConfig

toEnumName

public String toEnumName(io.swagger.codegen.v3.CodegenProperty property)

Description copied from class: DefaultCodegenConfig

Return the Enum name (e.g. StatusEnum given 'status')

Overrides:

toEnumName in class DefaultCodegenConfig

Parameters:

property - Codegen property

Returns:

the Enum name

escapeQuotationMark

public String escapeQuotationMark(String input)

Description copied from class: DefaultCodegenConfig

Escape single and/or double quote to avoid code injection

Specified by:

escapeQuotationMark in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

escapeQuotationMark in class DefaultCodegenConfig

Parameters:

input - String to be cleaned up

Returns:

string with quotation mark removed or escaped