org.openapitools.codegen.languages

Class ScalaGatlingCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractScalaCodegen

org.openapitools.codegen.languages.ScalaGatlingCodegen

All Implemented Interfaces:

CodegenConfig

public class ScalaGatlingCodegen
extends AbstractScalaCodegen
implements CodegenConfig

Field Summary

Fields

Modifier and Type	Field and Description
protected String	apiVersion
protected String	confFolder
protected String	dataFolder
protected String	resourceFolder

Fields inherited from class org.openapitools.codegen.languages.AbstractScalaCodegen

invokerPackage, modelPropertyNaming, sourceFolder, 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
ScalaGatlingCodegen()

Method Summary

Modifier and Type	Method and Description
String	apiFileFolder() Location to write api files.
String	escapeReservedWord(String name) Gatling does not need the models to have escaped words as it builds models dynamically instead of through an instance of the object.
String	getHelp() Returns human-friendly help for the generator.
String	getName() Configures a friendly name for the generator.
String	getSchemaType(io.swagger.v3.oas.models.media.Schema p) Optional - openapi type conversion.
CodegenType	getTag() Configures the type of generator.
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p) Optional - type declaration.
String	modelFileFolder() Location to write model files.
void	preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI) Modifies the openapi doc to make mustache easier to use

Methods inherited from class org.openapitools.codegen.languages.AbstractScalaCodegen

escapeQuotationMark, escapeUnsafeCharacters, formatIdentifier, fromProperty, getSourceFolder, postProcessFile, postProcessModels, processCompiler, processOpts, setSourceFolder, stripPackageName, toDefaultValue, toInstantiationType, toModelFilename, toOperationId

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, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getModelNamePrefix, getModelNameSuffix, getMostInnerItems, getOrGenerateOperationId, getOutputDir, getParameterDataType, getPrependFormOrBodyParameters, getProducesInfo, getReleaseNote, getSchemaItems, getSortModelPropertiesByRequiredFlag, getSortParamsByRequiredFlag, getSymbolName, 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, 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

Methods inherited from interface org.openapitools.codegen.CodegenConfig

additionalProperties, addOperationToGroup, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, encodePath, escapeQuotationMark, escapeText, escapeTextWhileAllowingNewLines, escapeUnsafeCharacters, fileSuffix, fromModel, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getCommonTemplateDir, getDocExtension, getFeatureSet, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getTemplatingEngine, getTypeDeclaration, importMapping, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessFile, postProcessModelProperty, postProcessModels, postProcessOperationsWithModels, postProcessParameter, postProcessSupportingFileData, processCompiler, processOpenAPI, processOpts, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, serverVariableOverrides, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setFeatureSet, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOpenAPI, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipOverwrite, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelFilename, toModelImport, toModelName, toModelTestFilename, toParamName, toSetter, typeMapping, updateAllModels, vendorExtensions

Field Detail

resourceFolder

protected String resourceFolder

confFolder

protected String confFolder

dataFolder

protected String dataFolder

apiVersion

protected String apiVersion

Constructor Detail

ScalaGatlingCodegen

public ScalaGatlingCodegen()

Method Detail

getTag

public CodegenType getTag()

Configures the type of generator.

Specified by:

getTag in interface CodegenConfig

Overrides:

getTag in class DefaultCodegen

Returns:

the CodegenType for this generator

getName

public String getName()

Configures a friendly name for the generator. This will be used by the generator to select the library with the -g flag.

Specified by:

getName in interface CodegenConfig

Overrides:

getName in class DefaultCodegen

Returns:

the friendly name for the generator

getHelp

public String getHelp()

Returns human-friendly help for the generator. Provide the consumer with help tips, parameters here

Specified by:

getHelp in interface CodegenConfig

Overrides:

getHelp in class DefaultCodegen

Returns:

A string value for the help message

escapeReservedWord

public String escapeReservedWord(String name)

Gatling does not need the models to have escaped words as it builds models dynamically instead of through an instance of the object.

Specified by:

escapeReservedWord in interface CodegenConfig

Overrides:

escapeReservedWord in class AbstractScalaCodegen

Parameters:

name - the name to be escaped

Returns:

the escaped term

modelFileFolder

public String modelFileFolder()

Location to write model files. You can use the modelPackage() as defined when the class is instantiated

Specified by:

modelFileFolder in interface CodegenConfig

Overrides:

modelFileFolder in class AbstractScalaCodegen

apiFileFolder

public String apiFileFolder()

Location to write api files. You can use the apiPackage() as defined when the class is instantiated

Specified by:

apiFileFolder in interface CodegenConfig

Overrides:

apiFileFolder in class AbstractScalaCodegen

preprocessOpenAPI

public void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)

Modifies the openapi doc to make mustache easier to use

Specified by:

preprocessOpenAPI in interface CodegenConfig

Overrides:

preprocessOpenAPI in class DefaultCodegen

Parameters:

openAPI - input openapi document

getTypeDeclaration

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

Optional - type declaration. This is a String which is used by the templates to instantiate your types. There is typically special handling for different property types

Specified by:

getTypeDeclaration in interface CodegenConfig

Overrides:

getTypeDeclaration in class AbstractScalaCodegen

Parameters:

p - property schema

Returns:

a string value used as the `dataType` field for model templates, `returnType` for api templates

getSchemaType

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

Optional - openapi type conversion. This is used to map openapi types in a `Schema` into either language specific types via `typeMapping` or into complex models if there is not a mapping.

Overrides:

getSchemaType in class AbstractScalaCodegen

Parameters:

p - property schema

Returns:

a string value of the type or complex model for this property