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

Class MuleSdkParameterModelParser

java.lang.Object

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

All Implemented Interfaces:

AllowedStereotypesModelParser, ParameterModelParser, SemanticTermsParser

Direct Known Subclasses:

MuleSdkOptionalParameterModelParser

public class MuleSdkParameterModelParser
extends Object
implements ParameterModelParser

ParameterModelParser implementation for Mule SDK (required parameters).

Since:

4.5.0

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEPRECATED_CONSTRUCT_NAME
protected org.mule.runtime.ast.api.ComponentAst	parameterAst

Constructor Summary

Constructors

Constructor and Description
MuleSdkParameterModelParser(org.mule.runtime.ast.api.ComponentAst parameterAst, org.mule.metadata.api.TypeLoader typeLoader, org.mule.runtime.ast.internal.model.ExtensionModelHelper extensionModelHelper)

Method Summary

Modifier and Type	Method and Description
protected org.mule.runtime.api.meta.model.deprecated.DeprecationModel	buildDeprecationModel(org.mule.runtime.ast.api.ComponentAst deprecationAst) Builds a deprecation model by parsing the content of the deprecated parameter AST.
List<org.mule.runtime.api.meta.model.ModelProperty>	getAdditionalModelProperties()
List<org.mule.runtime.api.meta.model.stereotype.StereotypeModel>	getAllowedStereotypes(StereotypeModelFactory factory)
protected Stream<org.mule.runtime.ast.api.ComponentAst>	getChildren(org.mule.runtime.ast.api.ComponentAst component, String childName)
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()
protected <T> Optional<T>	getOptionalParameter(org.mule.runtime.ast.api.ComponentAst ast, String paramName) Returns the value of an optional parameter in the give ast.
protected <T> T	getParameter(org.mule.runtime.ast.api.ComponentAst ast, String paramName) Returns the value of a parameter in the given ast.
protected org.mule.runtime.ast.api.ComponentAst	getRequiredTopLevelComponent(org.mule.runtime.ast.api.ArtifactAst ast, org.mule.runtime.api.component.ComponentIdentifier childIdentifier)
org.mule.runtime.api.meta.model.parameter.ParameterRole	getRole()
Set<String>	getSemanticTerms()
Optional<org.mule.runtime.extension.api.property.SinceMuleVersionModelProperty>	getSinceMuleVersionModelProperty()
protected Optional<org.mule.runtime.ast.api.ComponentAst>	getSingleChild(org.mule.runtime.ast.api.ComponentAst component, String childName)
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

Field Detail

parameterAst

protected final org.mule.runtime.ast.api.ComponentAst parameterAst

DEPRECATED_CONSTRUCT_NAME

protected static final String DEPRECATED_CONSTRUCT_NAME

See Also:

Constant Field Values

Constructor Detail

MuleSdkParameterModelParser

public MuleSdkParameterModelParser(org.mule.runtime.ast.api.ComponentAst parameterAst,
                                   org.mule.metadata.api.TypeLoader typeLoader,
                                   org.mule.runtime.ast.internal.model.ExtensionModelHelper extensionModelHelper)

Method Detail

getAllowedStereotypes

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

Specified by:

getAllowedStereotypes in interface AllowedStereotypesModelParser

getName

public String getName()

Specified by:

getName in interface ParameterModelParser

getDescription

public String getDescription()

Specified by:

getDescription in interface ParameterModelParser

getType

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

Specified by:

getType in interface ParameterModelParser

isRequired

public boolean isRequired()

Specified by:

isRequired in interface ParameterModelParser

getDefaultValue

public Object getDefaultValue()

Specified by:

getDefaultValue in interface ParameterModelParser

getRole

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

Specified by:

getRole in interface ParameterModelParser

getExpressionSupport

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

Specified by:

getExpressionSupport in interface ParameterModelParser

getLayoutModel

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

Specified by:

getLayoutModel in interface ParameterModelParser

getDslConfiguration

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

Specified by:

getDslConfiguration in interface ParameterModelParser

isExcludedFromConnectivitySchema

public boolean isExcludedFromConnectivitySchema()

Specified by:

isExcludedFromConnectivitySchema in interface ParameterModelParser

isConfigOverride

public boolean isConfigOverride()

Specified by:

isConfigOverride in interface ParameterModelParser

isComponentId

public boolean isComponentId()

Specified by:

isComponentId in interface ParameterModelParser

getAdditionalModelProperties

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

Specified by:

getAdditionalModelProperties in interface ParameterModelParser

getDeprecationModel

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

Specified by:

getDeprecationModel in interface ParameterModelParser

getDisplayModel

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

Specified by:

getDisplayModel in interface ParameterModelParser

getOAuthParameterModelProperty

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

Specified by:

getOAuthParameterModelProperty in interface ParameterModelParser

getSinceMuleVersionModelProperty

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

Specified by:

getSinceMuleVersionModelProperty in interface ParameterModelParser

getSemanticTerms

public Set<String> getSemanticTerms()

Specified by:

getSemanticTerms in interface SemanticTermsParser

getParameter

protected <T> T getParameter(org.mule.runtime.ast.api.ComponentAst ast,
                             String paramName)

Returns the value of a parameter in the given ast. The parameter is assumed to either be required or have a default defined.

Type Parameters:

T - the param's generic type

Parameters:

ast - a ComponentAst

paramName - the name of the parameter

Returns:

The parameter value

getOptionalParameter

protected <T> Optional<T> getOptionalParameter(org.mule.runtime.ast.api.ComponentAst ast,
                                               String paramName)

Returns the value of an optional parameter in the give ast.

Type Parameters:

T - the param's generic type

Parameters:

ast - a ComponentAst

paramName - the name of the parameter

Returns:

an Optional for the parameter's value

getChildren

protected Stream<org.mule.runtime.ast.api.ComponentAst> getChildren(org.mule.runtime.ast.api.ComponentAst component,
                                                                    String childName)

Parameters:

component - a ComponentAst

childName - the child element name

Returns:

A Stream with all the direct children with the given childName

getSingleChild

protected Optional<org.mule.runtime.ast.api.ComponentAst> getSingleChild(org.mule.runtime.ast.api.ComponentAst component,
                                                                         String childName)

Parameters:

component - a ComponentAst

childName - the child element name

Returns:

The first direct child (if any) with the given childName

getRequiredTopLevelComponent

protected org.mule.runtime.ast.api.ComponentAst getRequiredTopLevelComponent(org.mule.runtime.ast.api.ArtifactAst ast,
                                                                             org.mule.runtime.api.component.ComponentIdentifier childIdentifier)

Parameters:

ast - a ComponentAst

childIdentifier - the child ComponentIdentifier

Returns:

The first top level component with the given childIdentifier

Throws:

org.mule.runtime.api.exception.MuleRuntimeException - if not found.

buildDeprecationModel

protected org.mule.runtime.api.meta.model.deprecated.DeprecationModel buildDeprecationModel(org.mule.runtime.ast.api.ComponentAst deprecationAst)

Builds a deprecation model by parsing the content of the deprecated parameter AST.

Parameters:

deprecationAst - The deprecation parameter AST.

Returns:

The corresponding DeprecationModel.