org.openapitools.codegen.languages

Class AbstractScalaCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractScalaCodegen

All Implemented Interfaces:

CodegenConfig

Direct Known Subclasses:

ScalaAkkaClientCodegen, ScalaGatlingCodegen, ScalaHttpClientCodegen, ScalaLagomServerCodegen, ScalaPlayFrameworkServerCodegen, ScalatraServerCodegen, ScalazClientCodegen

public abstract class AbstractScalaCodegen
extends DefaultCodegen

Field Summary

Fields

Modifier and Type	Field and Description
protected String	invokerPackage
protected String	modelPropertyNaming
protected String	sourceFolder
protected boolean	stripPackageName

Fields inherited from class org.openapitools.codegen.DefaultCodegen

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiNameSuffix, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, DefaultFeatureSet, defaultIncludes, docExtension, embeddedTemplateDir, enableMinimalUpdate, enablePostProcessFile, ensureUniqueParams, featureSet, fileSuffix, generatorMetadata, gitHost, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importMapping, inputSpec, instantiationTypes, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, outputFolder, prependFormOrBodyParameters, releaseNote, removeOperationIdPrefix, reservedWords, reservedWordsMappings, serverVariables, skipOverwrite, sortModelPropertiesByRequiredFlag, sortParamsByRequiredFlag, specialCharReplacements, strictSpecBehavior, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, supportsMultipleInheritance, templateDir, testPackage, typeAliases, typeMapping, vendorExtensions

Constructor Summary

Constructors

Constructor and Description
AbstractScalaCodegen()

Method Summary

Modifier and Type	Method and Description
String	apiFileFolder()
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
protected String	formatIdentifier(String name, boolean capitalized)
CodegenProperty	fromProperty(String name, io.swagger.v3.oas.models.media.Schema p) Convert OAS Property object to Codegen Property object
String	getSchemaType(io.swagger.v3.oas.models.media.Schema p) returns the OpenAPI type for the property.
String	getSourceFolder()
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p) Output the type declaration of the property
String	modelFileFolder()
void	postProcessFile(File file, String fileType) Post-process the auto-generated file, e.g.
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 String	stripPackageName(String input)
String	toDefaultValue(io.swagger.v3.oas.models.media.Schema p) Return the default value of the property
String	toInstantiationType(io.swagger.v3.oas.models.media.Schema 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	toOperationId(String operationId) Return the operation ID (method name)

Methods inherited from class org.openapitools.codegen.DefaultCodegen

addAdditionPropertiesToCodeGenModel, addHeaders, addImport, additionalProperties, addMustacheLambdas, addOperationToGroup, addOption, addParentContainer, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, defaultIncludes, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromModel, fromOperation, fromParameter, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, getAlias, getAllModels, getAllowUnicodeIdentifiers, getApiNameSuffix, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getDocExtension, getEnsureUniqueParams, getFeatureSet, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHelp, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getModelNamePrefix, getModelNameSuffix, getMostInnerItems, getName, getOrGenerateOperationId, getOutputDir, getParameterDataType, getPrependFormOrBodyParameters, getProducesInfo, getReleaseNote, getSchemaItems, getSortModelPropertiesByRequiredFlag, getSortParamsByRequiredFlag, getSymbolName, getTag, getTemplatingEngine, getterAndSetterCapitalize, getTypeDeclaration, handleMethodResponse, hasBodyParameter, hasFormParameter, importMapping, initalizeSpecialCharacterMapping, instantiationTypes, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, lowerCamelCase, modelDocFileFolder, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needToImport, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessModelsEnum, postProcessOperationsWithModels, postProcessParameter, postProcessSupportingFileData, preprocessOpenAPI, processOpenAPI, processTemplatingEngine, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, sanitizeTag, serverVariableOverrides, setAllowUnicodeIdentifiers, setApiNameSuffix, setApiPackage, setCircularReferences, setCommonTemplateDir, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnsureUniqueParams, setFeatureSet, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOpenAPI, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setParameterExampleValue, setParameterExampleValue, setPrependFormOrBodyParameters, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortModelPropertiesByRequiredFlag, setSortParamsByRequiredFlag, setStrictSpecBehavior, setTemplateDir, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toAllOfName, toAnyOfName, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExamples, toExampleValue, toGetter, toModelDocFilename, toModelImport, toModelName, toModelTestFilename, toOneOfName, toParamName, toRegularExpression, toSetter, toVarName, typeMapping, updateAllModels, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateEnumVarsWithExtensions, updateOption, 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

modelPropertyNaming

protected String modelPropertyNaming

invokerPackage

protected String invokerPackage

sourceFolder

protected String sourceFolder

stripPackageName

protected boolean stripPackageName

Constructor Detail

AbstractScalaCodegen

public AbstractScalaCodegen()

Method Detail

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class DefaultCodegen

getSourceFolder

public String getSourceFolder()

setSourceFolder

public void setSourceFolder(String sourceFolder)

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)

processCompiler

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

Specified by:

processCompiler in interface CodegenConfig

Overrides:

processCompiler in class DefaultCodegen

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

getTypeDeclaration

public String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema 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 - 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

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

toDefaultValue

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

Description copied from class: DefaultCodegen

Return the default value of the property

Overrides:

toDefaultValue in class DefaultCodegen

Parameters:

p - Property schema

Returns:

string presentation of the default value of the property

fromProperty

public CodegenProperty fromProperty(String name,
                                    io.swagger.v3.oas.models.media.Schema p)

Convert OAS Property object to Codegen Property object

Overrides:

fromProperty in class DefaultCodegen

Parameters:

name - name of the property

p - OAS property object

Returns:

Codegen Property object

postProcessModels

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

Specified by:

postProcessModels in interface CodegenConfig

Overrides:

postProcessModels in class DefaultCodegen

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

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

formatIdentifier

protected String formatIdentifier(String name,
                                  boolean capitalized)

stripPackageName

protected String stripPackageName(String input)

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

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

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