org.wso2.apimgt.gateway.cli.model.template.service

Class BallerinaParameter

java.lang.Object

org.wso2.apimgt.gateway.cli.model.template.service.BallerinaParameter

All Implemented Interfaces:

BallerinaOpenAPIObject<BallerinaParameter,io.swagger.v3.oas.models.parameters.Parameter>

public class BallerinaParameter
extends Object
implements BallerinaOpenAPIObject<BallerinaParameter,io.swagger.v3.oas.models.parameters.Parameter>

Wraps the Parameter from swagger models for easier templating.

Constructor Summary

Constructors

Constructor and Description
BallerinaParameter()

Method Summary

Modifier and Type	Method and Description
BallerinaParameter	buildContext(io.swagger.v3.oas.models.parameters.Parameter parameter) Build the Ballerina context model C for Open APIDetailedDTO definition/component in D.
BallerinaParameter	buildContext(io.swagger.v3.oas.models.parameters.Parameter parameter, ExtendedAPI api) Build the Ballerina context model C for Open APIDetailedDTO definition/component in D.
Boolean	getAllowEmptyValue()
BallerinaParameter	getDefaultValue() Retrieve the default value for this type.
String	getDescription()
String	getIn()
String	getName()
Boolean	getRequired()
void	setAllowEmptyValue(Boolean allowEmptyValue)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BallerinaParameter

public BallerinaParameter()

Method Detail

buildContext

public BallerinaParameter buildContext(io.swagger.v3.oas.models.parameters.Parameter parameter)
                                throws BallerinaServiceGenException

Description copied from interface: BallerinaOpenAPIObject

Build the Ballerina context model C for Open APIDetailedDTO definition/component in D.

Specified by:

buildContext in interface BallerinaOpenAPIObject<BallerinaParameter,io.swagger.v3.oas.models.parameters.Parameter>

Parameters:

parameter - Open Api definition or component

Returns:

parsed context model C of Open Api definition/component D

Throws:

BallerinaServiceGenException - on error when parsing the Open Api definition

buildContext

public BallerinaParameter buildContext(io.swagger.v3.oas.models.parameters.Parameter parameter,
                                       ExtendedAPI api)
                                throws BallerinaServiceGenException

Description copied from interface: BallerinaOpenAPIObject

Build the Ballerina context model C for Open APIDetailedDTO definition/component in D.

OpenAPI definition openApi can be used to access the parent context helpful for building the current context

Specified by:

buildContext in interface BallerinaOpenAPIObject<BallerinaParameter,io.swagger.v3.oas.models.parameters.Parameter>

Parameters:

parameter - Swagger Api definition or component

api - openApi object model

Returns:

parsed context model C of Open Api definition/component D

Throws:

BallerinaServiceGenException - on error when parsing the Open Api definition

getDefaultValue

public BallerinaParameter getDefaultValue()

Description copied from interface: BallerinaOpenAPIObject

Retrieve the default value for this type.

Specified by:

getDefaultValue in interface BallerinaOpenAPIObject<BallerinaParameter,io.swagger.v3.oas.models.parameters.Parameter>

Returns:

default values

getName

public String getName()

getIn

public String getIn()

getDescription

public String getDescription()

getRequired

public Boolean getRequired()

getAllowEmptyValue

public Boolean getAllowEmptyValue()

setAllowEmptyValue

public void setAllowEmptyValue(Boolean allowEmptyValue)