io.swagger.codegen.v3.generators.scala

Class AbstractScalaCodegen

java.lang.Object

io.swagger.codegen.v3.generators.DefaultCodegenConfig

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

All Implemented Interfaces:

io.swagger.codegen.v3.CodegenConfig

Direct Known Subclasses:

AkkaHttpServerCodegen, ScalaClientCodegen

public abstract class AbstractScalaCodegen
extends DefaultCodegenConfig

Field Summary

Fields

Modifier and Type	Field and Description
protected String	modelPropertyNaming
protected String	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
AbstractScalaCodegen()

Method Summary

Modifier and Type	Method and Description
String	apiFileFolder()
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
protected String	formatIdentifier(String name, boolean capitalized)
String	getSchemaType(io.swagger.v3.oas.models.media.Schema propertySchema) returns the swagger type for the property
String	getSourceFolder()
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema propertySchema) Output the type declaration of the property
String	modelFileFolder()
Map<String,Object>	postProcessModels(Map<String,Object> objs)
com.samskivert.mustache.Mustache.Compiler	processCompiler(com.samskivert.mustache.Mustache.Compiler compiler)
void	processOpts()
void	setSourceFolder(String sourceFolder)
protected void	setTemplateEngine()
protected String	stripPackageName(String input)
String	toDefaultValue(io.swagger.v3.oas.models.media.Schema propertySchema) Return the default value of the property
String	toInstantiationType(io.swagger.v3.oas.models.media.Schema schemaProperty) Return the instantiation type of the property, especially for map and array
String	toModelFilename(String name) Return the capitalized file name of the model

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, escapeQuotationMark, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromModel, fromModel, fromOperation, fromOperation, fromParameter, fromProperty, fromRequestBody, fromResponse, fromSecurity, generateExamplePath, getAlias, getArgumentsLocation, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getDefaultTemplateDir, 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, toEnumName, toEnumValue, toEnumVarName, toExamples, toExampleValue, toGetter, toModelDocFilename, toModelImport, toModelName, toModelTestFilename, toOperationId, toParamName, toRegularExpression, toSetter, toVarName, 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.v3.CodegenConfig

getHelp, getName, getTag

Field Detail

modelPropertyNaming

protected String modelPropertyNaming

sourceFolder

protected String sourceFolder

Constructor Detail

AbstractScalaCodegen

public AbstractScalaCodegen()

Method Detail

processOpts

public void processOpts()

Specified by:

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

Overrides:

processOpts in class DefaultCodegenConfig

setSourceFolder

public void setSourceFolder(String sourceFolder)

getSourceFolder

public String getSourceFolder()

escapeReservedWord

public String escapeReservedWord(String name)

Description copied from class: DefaultCodegenConfig

Return the escaped name of the reserved word

Specified by:

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

Overrides:

escapeReservedWord in class DefaultCodegenConfig

Parameters:

name - the name to be escaped

Returns:

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

processCompiler

public com.samskivert.mustache.Mustache.Compiler processCompiler(com.samskivert.mustache.Mustache.Compiler compiler)

Specified by:

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

Overrides:

processCompiler in class DefaultCodegenConfig

apiFileFolder

public String apiFileFolder()

Specified by:

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

Overrides:

apiFileFolder in class DefaultCodegenConfig

modelFileFolder

public String modelFileFolder()

Specified by:

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

Overrides:

modelFileFolder in class DefaultCodegenConfig

getTypeDeclaration

public String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema propertySchema)

Description copied from class: DefaultCodegenConfig

Output the type declaration of the property

Specified by:

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

Overrides:

getTypeDeclaration in class DefaultCodegenConfig

Parameters:

propertySchema - Schema Property object

Returns:

a string presentation of the property type

getSchemaType

public String getSchemaType(io.swagger.v3.oas.models.media.Schema propertySchema)

Description copied from class: DefaultCodegenConfig

returns the swagger type for the property

Overrides:

getSchemaType in class DefaultCodegenConfig

Parameters:

propertySchema - Schema property object

Returns:

string presentation of the type

toInstantiationType

public String toInstantiationType(io.swagger.v3.oas.models.media.Schema schemaProperty)

Description copied from class: DefaultCodegenConfig

Return the instantiation type of the property, especially for map and array

Overrides:

toInstantiationType in class DefaultCodegenConfig

Parameters:

schemaProperty - Swagger property object

Returns:

string presentation of the instantiation type of the property

toDefaultValue

public String toDefaultValue(io.swagger.v3.oas.models.media.Schema propertySchema)

Description copied from class: DefaultCodegenConfig

Return the default value of the property

Overrides:

toDefaultValue in class DefaultCodegenConfig

Parameters:

propertySchema - Schema property object

Returns:

string presentation of the default value of the property

postProcessModels

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

Specified by:

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

Overrides:

postProcessModels in class DefaultCodegenConfig

toModelFilename

public String toModelFilename(String name)

Description copied from class: DefaultCodegenConfig

Return the capitalized file name of the model

Specified by:

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

Overrides:

toModelFilename in class DefaultCodegenConfig

Parameters:

name - the model name

Returns:

the file name of the model

escapeUnsafeCharacters

public String escapeUnsafeCharacters(String input)

Description copied from class: DefaultCodegenConfig

override with any special text escaping logic to handle unsafe characters so as to avoid code injection

Specified by:

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

Overrides:

escapeUnsafeCharacters in class DefaultCodegenConfig

Parameters:

input - String to be cleaned up

Returns:

string with unsafe characters removed or escaped

formatIdentifier

protected String formatIdentifier(String name,
                                  boolean capitalized)

stripPackageName

protected String stripPackageName(String input)

setTemplateEngine

protected void setTemplateEngine()

Overrides:

setTemplateEngine in class DefaultCodegenConfig