org.mule.runtime.module.extension.internal.loader.parser

Interface ParameterModelParser

All Superinterfaces:

AllowedStereotypesModelParser, SemanticTermsParser

All Known Implementing Classes:

JavaParameterModelParser, ParameterModelParserDecorator

public interface ParameterModelParser
extends SemanticTermsParser, AllowedStereotypesModelParser

Parses the syntactic definition of a ParameterModel so that the semantics reflected in it can be extracted in a uniform way, regardless of the actual syntax used by the extension developer.

Since:

4.5.0

See Also:

ExtensionModelParser

Method Summary

Modifier and Type	Method and Description
List<org.mule.runtime.api.meta.model.ModelProperty>	getAdditionalModelProperties() Returns a list with all the model properties to be applied at the parameter level which are specifically linked to the type of syntax used to define the extension.
Object	getDefaultValue()
Optional<org.mule.runtime.api.meta.model.deprecated.DeprecationModel>	getDeprecationModel()
String	getDescription()
Optional<org.mule.runtime.api.meta.model.display.DisplayModel>	getDisplayModel()
Optional<org.mule.runtime.api.meta.model.ParameterDslConfiguration>	getDslConfiguration()
org.mule.runtime.api.meta.ExpressionSupport	getExpressionSupport()
Optional<org.mule.runtime.api.meta.model.display.LayoutModel>	getLayoutModel()
String	getName()
Optional<org.mule.runtime.extension.api.connectivity.oauth.OAuthParameterModelProperty>	getOAuthParameterModelProperty()
org.mule.runtime.api.meta.model.parameter.ParameterRole	getRole()
Optional<org.mule.runtime.extension.api.property.SinceMuleVersionModelProperty>	getSinceMuleVersionModelProperty()
org.mule.metadata.api.model.MetadataType	getType()
boolean	isComponentId()
boolean	isConfigOverride()
boolean	isExcludedFromConnectivitySchema()
boolean	isRequired()

Methods inherited from interface org.mule.runtime.module.extension.internal.loader.parser.SemanticTermsParser

getSemanticTerms

Methods inherited from interface org.mule.runtime.module.extension.internal.loader.parser.AllowedStereotypesModelParser

getAllowedStereotypes

Method Detail

getName

String getName()

Returns:

the parameter's name

getDescription

String getDescription()

Returns:

the parameter's description

getType

org.mule.metadata.api.model.MetadataType getType()

Returns:

a MetadataType describing the parameter's type

isRequired

boolean isRequired()

Returns:

whether the parameter is required

getDefaultValue

Object getDefaultValue()

Returns:

the parameter's default value or null if the parameter is required or no default value provided

getRole

org.mule.runtime.api.meta.model.parameter.ParameterRole getRole()

Returns:

the parameter's role

getExpressionSupport

org.mule.runtime.api.meta.ExpressionSupport getExpressionSupport()

Returns:

the parameter's ExpressionSupport

getLayoutModel

Optional<org.mule.runtime.api.meta.model.display.LayoutModel> getLayoutModel()

Returns:

the parameter's LayoutModel if one was defined

getDslConfiguration

Optional<org.mule.runtime.api.meta.model.ParameterDslConfiguration> getDslConfiguration()

Returns:

the parameter's ParameterDslConfiguration if one was defined

isExcludedFromConnectivitySchema

boolean isExcludedFromConnectivitySchema()

Returns:

whether this parameter should be skipped when generating the extension's connectivity schemas

isConfigOverride

boolean isConfigOverride()

Returns:

whether this parameter is a config override

isComponentId

boolean isComponentId()

Returns:

whether this parameter acts as the id of the owning component

getAdditionalModelProperties

List<org.mule.runtime.api.meta.model.ModelProperty> getAdditionalModelProperties()

Returns a list with all the model properties to be applied at the parameter level which are specifically linked to the type of syntax used to define the extension.

Returns:

a list with ModelProperty instances.

getDeprecationModel

Optional<org.mule.runtime.api.meta.model.deprecated.DeprecationModel> getDeprecationModel()

Returns:

the parameter's DeprecationModel if one was defined

getDisplayModel

Optional<org.mule.runtime.api.meta.model.display.DisplayModel> getDisplayModel()

Returns:

the parameter's DisplayModel

getOAuthParameterModelProperty

Optional<org.mule.runtime.extension.api.connectivity.oauth.OAuthParameterModelProperty> getOAuthParameterModelProperty()

Returns:

the parameter's OAuthParameterModelProperty

getSinceMuleVersionModelProperty

Optional<org.mule.runtime.extension.api.property.SinceMuleVersionModelProperty> getSinceMuleVersionModelProperty()