org.ballerinalang.composer.service.workspace.swagger.generators

Class BallerinaCodeGenerator

java.lang.Object

io.swagger.codegen.DefaultCodegen

org.ballerinalang.composer.service.workspace.swagger.generators.BallerinaCodeGenerator

All Implemented Interfaces:

io.swagger.codegen.CodegenConfig

public class BallerinaCodeGenerator
extends io.swagger.codegen.DefaultCodegen
implements io.swagger.codegen.CodegenConfig

This the ballerina connector generator class. Here we can add/update templates to generate different connectors, types services etc.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	apiPath
protected String	apiVersion

Fields inherited from class io.swagger.codegen.DefaultCodegen

additionalProperties, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoId, gitUserId, httpUserAgent, importMapping, instantiationTypes, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, releaseNote, reservedWords, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, templateDir, testPackage, typeMapping, vendorExtensions

Constructor Summary

Constructors

Constructor and Description
BallerinaCodeGenerator()

Method Summary

Modifier and Type	Method and Description
String	apiFileFolder() Location to write api files.
String	apiPackage()
String	escapeQuotationMark(String input)
String	escapeReservedWord(String name) Escapes a reserved word as defined in the `reservedWords` array.
String	escapeUnsafeCharacters(String input)
String	getHelp() Returns human-friendly help for the generator.
String	getName() Configures a friendly name for the generator.
io.swagger.codegen.CodegenType	getTag() Configures the type of generator.
Map<String,Object>	postProcessOperations(Map<String,Object> objs)
String	toApiFilename(String name)
String	toApiName(String name)
String	toModelFilename(String name)
String	toModelName(String name)
String	toOperationId(String operationId)

Methods inherited from class io.swagger.codegen.DefaultCodegen

addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOperationToGroup, addProperties, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, dashize, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromModel, fromModel, fromOperation, fromOperation, fromParameter, fromProperty, fromResponse, fromSecurity, generateExamplePath, getCommonTemplateDir, getGitRepoId, getGitUserId, getHttpUserAgent, getInnerEnumAllowableValues, getLibrary, getOrGenerateOperationId, getOutputDir, getReleaseNote, getSwaggerType, getSymbolName, getterAndSetterCapitalize, getTypeDeclaration, getTypeDeclaration, importMapping, initalizeSpecialCharacterMapping, initialCaps, instantiationTypes, isDataTypeBinary, isPropertyInnerMostEnum, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needToImport, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessModels, postProcessModelsEnum, postProcessParameter, postProcessSupportingFileData, preprocessSwagger, processOpts, processSwagger, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, sanitizeName, sanitizeTag, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoId, setGitUserId, setHttpUserAgent, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setReleaseNote, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiImport, toApiTestFilename, toApiVarName, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExamples, toExampleValue, toInstantiationType, toModelDocFilename, toModelImport, toModelTestFilename, toParamName, toRegularExpression, toVarName, typeMapping, underscore, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional

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, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, fromModel, fromModel, fromOperation, fromOperation, fromSecurity, generateExamplePath, getCommonTemplateDir, getGitRepoId, getGitUserId, getHttpUserAgent, getLibrary, getOutputDir, getReleaseNote, getTypeDeclaration, getTypeDeclaration, importMapping, instantiationTypes, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessModels, postProcessParameter, postProcessSupportingFileData, preprocessSwagger, processOpts, processSwagger, reservedWords, sanitizeTag, setGitRepoId, setGitUserId, setHttpUserAgent, setLibrary, setOutputDir, setReleaseNote, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiImport, toApiTestFilename, toApiVarName, toModelDocFilename, toModelImport, toModelTestFilename, toParamName, typeMapping, vendorExtensions

Field Detail

apiVersion

protected String apiVersion

apiPath

protected String apiPath

Constructor Detail

BallerinaCodeGenerator

public BallerinaCodeGenerator()

Method Detail

apiPackage

public String apiPackage()

Specified by:

apiPackage in interface io.swagger.codegen.CodegenConfig

Overrides:

apiPackage in class io.swagger.codegen.DefaultCodegen

getTag

public io.swagger.codegen.CodegenType getTag()

Configures the type of generator.

Specified by:

getTag in interface io.swagger.codegen.CodegenConfig

Returns:

the CodegenType for this generator

See Also:

CodegenType

getName

public String getName()

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

Specified by:

getName in interface io.swagger.codegen.CodegenConfig

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 io.swagger.codegen.CodegenConfig

Returns:

A string value for the help message

toApiName

public String toApiName(String name)

Specified by:

toApiName in interface io.swagger.codegen.CodegenConfig

Overrides:

toApiName in class io.swagger.codegen.DefaultCodegen

escapeReservedWord

public String escapeReservedWord(String name)

Escapes a reserved word as defined in the `reservedWords` array. Handle escaping those terms here. This logic is only called if a variable matches the reseved words

Specified by:

escapeReservedWord in interface io.swagger.codegen.CodegenConfig

Overrides:

escapeReservedWord in class io.swagger.codegen.DefaultCodegen

Returns:

the escaped term

postProcessOperations

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

Specified by:

postProcessOperations in interface io.swagger.codegen.CodegenConfig

Overrides:

postProcessOperations in class io.swagger.codegen.DefaultCodegen

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 io.swagger.codegen.CodegenConfig

Overrides:

apiFileFolder in class io.swagger.codegen.DefaultCodegen

toModelName

public String toModelName(String name)

Specified by:

toModelName in interface io.swagger.codegen.CodegenConfig

Overrides:

toModelName in class io.swagger.codegen.DefaultCodegen

toOperationId

public String toOperationId(String operationId)

Overrides:

toOperationId in class io.swagger.codegen.DefaultCodegen

toModelFilename

public String toModelFilename(String name)

Specified by:

toModelFilename in interface io.swagger.codegen.CodegenConfig

Overrides:

toModelFilename in class io.swagger.codegen.DefaultCodegen

toApiFilename

public String toApiFilename(String name)

Specified by:

toApiFilename in interface io.swagger.codegen.CodegenConfig

Overrides:

toApiFilename in class io.swagger.codegen.DefaultCodegen

escapeQuotationMark

public String escapeQuotationMark(String input)

Specified by:

escapeQuotationMark in interface io.swagger.codegen.CodegenConfig

Overrides:

escapeQuotationMark in class io.swagger.codegen.DefaultCodegen

escapeUnsafeCharacters

public String escapeUnsafeCharacters(String input)

Specified by:

escapeUnsafeCharacters in interface io.swagger.codegen.CodegenConfig

Overrides:

escapeUnsafeCharacters in class io.swagger.codegen.DefaultCodegen