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

Class MuleSdkOptionalParameterModelParser

java.lang.Object

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

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

All Implemented Interfaces:

AllowedStereotypesModelParser, ParameterModelParser, SemanticTermsParser

public class MuleSdkOptionalParameterModelParser
extends MuleSdkParameterModelParser
implements ParameterModelParser

ParameterModelParser implementation for Mule SDK (optional parameters).

Since:

4.5.0

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEPRECATED_CONSTRUCT_NAME

Fields inherited from class org.mule.runtime.module.extension.mule.internal.loader.parser.MuleSdkParameterModelParser

parameterAst

Constructor Summary

Constructors

Constructor and Description
MuleSdkOptionalParameterModelParser(org.mule.runtime.ast.api.ComponentAst parameter, 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.
protected Stream<org.mule.runtime.ast.api.ComponentAst>	getChildren(org.mule.runtime.ast.api.ComponentAst component, String childName)
Object	getDefaultValue()
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)
protected Optional<org.mule.runtime.ast.api.ComponentAst>	getSingleChild(org.mule.runtime.ast.api.ComponentAst component, String childName)
boolean	isRequired()

Methods inherited from class org.mule.runtime.module.extension.mule.internal.loader.parser.MuleSdkParameterModelParser

getAdditionalModelProperties, getAllowedStereotypes, getDeprecationModel, getDescription, getDisplayModel, getDslConfiguration, getExpressionSupport, getLayoutModel, getName, getOAuthParameterModelProperty, getRole, getSemanticTerms, getType, isComponentId, isConfigOverride, isExcludedFromConnectivitySchema

Methods inherited from class java.lang.Object

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

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

getAdditionalModelProperties, getDeprecationModel, getDescription, getDisplayModel, getDslConfiguration, getExpressionSupport, getLayoutModel, getName, getOAuthParameterModelProperty, getRole, getType, isComponentId, isConfigOverride, isExcludedFromConnectivitySchema

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

Field Detail

DEPRECATED_CONSTRUCT_NAME

protected static final String DEPRECATED_CONSTRUCT_NAME

See Also:

Constant Field Values

Constructor Detail

MuleSdkOptionalParameterModelParser

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

Method Detail

isRequired

public boolean isRequired()

Specified by:

isRequired in interface ParameterModelParser

Overrides:

isRequired in class MuleSdkParameterModelParser

getDefaultValue

public Object getDefaultValue()

Specified by:

getDefaultValue in interface ParameterModelParser

Overrides:

getDefaultValue in class MuleSdkParameterModelParser

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.