com.mulesoft.connectivity.rest.sdk.internal.webapi.model

Class APIParameterModel

java.lang.Object

com.mulesoft.connectivity.rest.sdk.internal.webapi.model.APIParameterModel

Direct Known Subclasses:

AMFParameterModel

public abstract class APIParameterModel
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected String	defaultValue
protected String	description
protected String	displayName
protected String	externalName
protected boolean	isPassword
protected boolean	isRequired
protected APIParameterType	parameterType
protected String	summary
protected APITypeModel	typeModel

Constructor Summary

Constructors

Constructor and Description
APIParameterModel()

Method Summary

Modifier and Type	Method and Description
String	getDefaultValue()
String	getDescription()
String	getDisplayName()
String	getExternalName()
abstract APILocation	getLocation() Retrieves the location in the API Spec this element was parsed from.
APIParameterType	getParameterType()
String	getSummary()
APITypeModel	getTypeModel()
boolean	isPassword()
boolean	isRequired()

Methods inherited from class java.lang.Object

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

Field Detail

externalName

protected String externalName

displayName

protected String displayName

parameterType

protected APIParameterType parameterType

description

protected String description

isRequired

protected boolean isRequired

defaultValue

protected String defaultValue

isPassword

protected boolean isPassword

typeModel

protected APITypeModel typeModel

summary

protected String summary

Constructor Detail

APIParameterModel

public APIParameterModel()

Method Detail

getExternalName

public String getExternalName()

getDisplayName

public String getDisplayName()

getParameterType

public APIParameterType getParameterType()

getDescription

public String getDescription()

getDefaultValue

public String getDefaultValue()

getTypeModel

public APITypeModel getTypeModel()

isRequired

public boolean isRequired()

isPassword

public boolean isPassword()

getSummary

public String getSummary()

getLocation

public abstract APILocation getLocation()

Retrieves the location in the API Spec this element was parsed from.