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

Class JavaParameterModelParser

java.lang.Object

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

All Implemented Interfaces:

AllowedStereotypesModelParser, ParameterModelParser, SemanticTermsParser

public class JavaParameterModelParser
extends Object
implements ParameterModelParser

ParameterModelParser for Java based syntax

Since:

4.5.0

Constructor Summary

Constructors

Constructor and Description
JavaParameterModelParser(ExtensionParameter parameter, Optional<ParameterGroupModelParser.ExclusiveOptionalDescriptor> exclusiveOptionals, ParameterDeclarationContext context)

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.
List<org.mule.runtime.api.meta.model.stereotype.StereotypeModel>	getAllowedStereotypes(StereotypeModelFactory factory) Returns a List of allowed stereotypes.
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()
Set<String>	getSemanticTerms()
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 class java.lang.Object

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

Constructor Detail

JavaParameterModelParser

public JavaParameterModelParser(ExtensionParameter parameter,
                                Optional<ParameterGroupModelParser.ExclusiveOptionalDescriptor> exclusiveOptionals,
                                ParameterDeclarationContext context)

Method Detail

getName

public String getName()

Specified by:

getName in interface ParameterModelParser

Returns:

the parameter's name

getDescription

public String getDescription()

Specified by:

getDescription in interface ParameterModelParser

Returns:

the parameter's description

getType

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

Specified by:

getType in interface ParameterModelParser

Returns:

a MetadataType describing the parameter's type

isRequired

public boolean isRequired()

Specified by:

isRequired in interface ParameterModelParser

Returns:

whether the parameter is required

getDefaultValue

public Object getDefaultValue()

Specified by:

getDefaultValue in interface ParameterModelParser

Returns:

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

getRole

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

Specified by:

getRole in interface ParameterModelParser

Returns:

the parameter's role

getExpressionSupport

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

Specified by:

getExpressionSupport in interface ParameterModelParser

Returns:

the parameter's ExpressionSupport

getLayoutModel

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

Specified by:

getLayoutModel in interface ParameterModelParser

Returns:

the parameter's LayoutModel if one was defined

getDslConfiguration

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

Specified by:

getDslConfiguration in interface ParameterModelParser

Returns:

the parameter's ParameterDslConfiguration if one was defined

getDeprecationModel

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

Specified by:

getDeprecationModel in interface ParameterModelParser

Returns:

the parameter's DeprecationModel if one was defined

getDisplayModel

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

Specified by:

getDisplayModel in interface ParameterModelParser

Returns:

the parameter's DisplayModel

isConfigOverride

public boolean isConfigOverride()

Specified by:

isConfigOverride in interface ParameterModelParser

Returns:

whether this parameter is a config override

isComponentId

public boolean isComponentId()

Specified by:

isComponentId in interface ParameterModelParser

Returns:

whether this parameter acts as the id of the owning component

getAllowedStereotypes

public List<org.mule.runtime.api.meta.model.stereotype.StereotypeModel> getAllowedStereotypes(StereotypeModelFactory factory)

Description copied from interface: AllowedStereotypesModelParser

Returns a List of allowed stereotypes. Each item is created through the provided factory.

Specified by:

getAllowedStereotypes in interface AllowedStereotypesModelParser

Parameters:

factory - a StereotypeModelFactory

Returns:

a list. Might be empty but will never be null

getAdditionalModelProperties

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

Description copied from interface: ParameterModelParser

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.

Specified by:

getAdditionalModelProperties in interface ParameterModelParser

Returns:

a list with ModelProperty instances.

isExcludedFromConnectivitySchema

public boolean isExcludedFromConnectivitySchema()

Specified by:

isExcludedFromConnectivitySchema in interface ParameterModelParser

Returns:

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

getSemanticTerms

public Set<String> getSemanticTerms()

Specified by:

getSemanticTerms in interface SemanticTermsParser

Returns:

a Set with the model's semantic terms

getOAuthParameterModelProperty

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

Specified by:

getOAuthParameterModelProperty in interface ParameterModelParser

Returns:

the parameter's OAuthParameterModelProperty

getSinceMuleVersionModelProperty

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

Specified by:

getSinceMuleVersionModelProperty in interface ParameterModelParser