org.mule.runtime.ast.api.util

Class MuleAstUtils

java.lang.Object

org.mule.runtime.ast.api.util.MuleAstUtils

public final class MuleAstUtils
extends Object

Set of utility methods for working with ArtifactAsts and ComponentAsts.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
static void	doOnParamComponents(ComponentParameterAst param, Consumer<ComponentAst> action) Performs a given action on the ComponentAsts that form the value of the provided parameter.
static ArtifactAst	emptyArtifact() Provides a singleton empty ArtifactAst instance.
static Optional<ComponentParameterAst>	parameterOfType(ComponentAst referent, org.mule.runtime.api.meta.model.stereotype.StereotypeModel referenceStereotype) Given a ComponentAst, lookup for a parameter that references an object with a certain stereotype.
static List<ComponentParameterAst>	parametersOfType(ComponentAst referent, org.mule.runtime.api.meta.model.stereotype.StereotypeModel referenceStereotype) Given a ComponentAst, lookup for all parameters that reference an object with a certain stereotype.
static Stream<org.mule.runtime.api.util.Pair<ComponentAst,List<ComponentAst>>>	recursiveStreamWithHierarchy(ArtifactAst artifact) Similar to ArtifactAst.recursiveStream(), but it enhances the Stream by adding hierarchy context to each item.
static Stream<org.mule.runtime.api.util.Pair<ComponentAst,List<ComponentAst>>>	recursiveStreamWithHierarchy(ArtifactAst artifact, AstTraversalDirection direction) Similar to ArtifactAst.recursiveStream(), but it enhances the Stream by adding hierarchy context to each item.
static Stream<org.mule.runtime.api.util.Pair<ComponentAst,List<ComponentAst>>>	recursiveStreamWithHierarchy(ArtifactAst artifact, AstTraversalDirection direction, boolean ignoreParameterComplexValues) Similar to ArtifactAst.recursiveStream(), but it enhances the Stream by adding hierarchy context to each item.
static Set<ComponentAst>	resolveOrphanComponents(ArtifactAst appModel) Given an ArtifactAst, return all those components within it that are not accessible from a top-level component.
static ValidationResult	validate(ArtifactAst artifact) Runs all validations available from the current Thread.getContextClassLoader().
static ValidationResult	validate(ArtifactAst artifact, Predicate<Validation> validationsFilter) Runs all validations available from the current Thread.getContextClassLoader().

Methods inherited from class java.lang.Object

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

Method Detail

resolveOrphanComponents

public static Set<ComponentAst> resolveOrphanComponents(ArtifactAst appModel)

Given an ArtifactAst, return all those components within it that are not accessible from a top-level component.

Parameters:

appModel - the model to determine orphan components from.

Returns:

components within the provided appModel that are not accessible from a top-level component.

emptyArtifact

public static ArtifactAst emptyArtifact()

Provides a singleton empty ArtifactAst instance.

Returns:

an ArtifactAst without components.

parameterOfType

public static Optional<ComponentParameterAst> parameterOfType(ComponentAst referent,
                                                              org.mule.runtime.api.meta.model.stereotype.StereotypeModel referenceStereotype)

Given a ComponentAst, lookup for a parameter that references an object with a certain stereotype.

Parameters:

referent - the ComponentAst that will be checked for the reference.

referenceStereotype - the StereotypeModel to check for.

Returns:

any ComponentParameterAst representing a parameter of referent that references an object assignable to referenceStereotype, if it exists.

parametersOfType

public static List<ComponentParameterAst> parametersOfType(ComponentAst referent,
                                                           org.mule.runtime.api.meta.model.stereotype.StereotypeModel referenceStereotype)

Given a ComponentAst, lookup for all parameters that reference an object with a certain stereotype.

Parameters:

referent - the ComponentAst that will be checked for the reference.

referenceStereotype - the StereotypeModel to check for.

Returns:

all ComponentParameterAsts representing parameters of referent that reference an object assignable to referenceStereotype.

doOnParamComponents

public static void doOnParamComponents(ComponentParameterAst param,
                                       Consumer<ComponentAst> action)

Performs a given action on the ComponentAsts that form the value of the provided parameter.

Parameters:

param - the parameter on which complex parameter values the action will be called.

action - the callback to perform on each found parameter item.

recursiveStreamWithHierarchy

public static Stream<org.mule.runtime.api.util.Pair<ComponentAst,List<ComponentAst>>> recursiveStreamWithHierarchy(ArtifactAst artifact)

Similar to ArtifactAst.recursiveStream(), but it enhances the Stream by adding hierarchy context to each item. The ArtifactAst is traversed in TOP_DOWN direction.

The elements of the Stream are Pairs:

• the first element is the same component that would be obtained by calling ArtifactAst.recursiveStream().
• the second element is the hierarchy that was traversed to get to the first element, the first element being a root and the last being the direct parent of the first element of the pair.

Parameters:

artifact - the ArtifactAst to generate a Stream for.

Returns:

an enhanced Stream with hierarchy context.

recursiveStreamWithHierarchy

public static Stream<org.mule.runtime.api.util.Pair<ComponentAst,List<ComponentAst>>> recursiveStreamWithHierarchy(ArtifactAst artifact,
                                                                                                                   AstTraversalDirection direction)

Similar to ArtifactAst.recursiveStream(), but it enhances the Stream by adding hierarchy context to each item. The ArtifactAst is traversed in AstTraversalDirection direction

The elements of the Stream are Pairs:

• the first element is the same component that would be obtained by calling ArtifactAst.recursiveStream().
• the second element is the hierarchy that was traversed to get to the first element, the first element being a root and the last being the direct parent of the first element of the pair.

Parameters:

artifact - the ArtifactAst to generate a Stream for.

direction - the AstTraversalDirection used to navigate the artifact.

ignoreParameterComplexValues - whether the returned Stream will contain any complex values in component parameters.

Returns:

an enhanced Stream with hierarchy context.

recursiveStreamWithHierarchy

public static Stream<org.mule.runtime.api.util.Pair<ComponentAst,List<ComponentAst>>> recursiveStreamWithHierarchy(ArtifactAst artifact,
                                                                                                                   AstTraversalDirection direction,
                                                                                                                   boolean ignoreParameterComplexValues)

Similar to ArtifactAst.recursiveStream(), but it enhances the Stream by adding hierarchy context to each item. The ArtifactAst is traversed in AstTraversalDirection direction

The elements of the Stream are Pairs:

• the first element is the same component that would be obtained by calling ArtifactAst.recursiveStream().
• the second element is the hierarchy that was traversed to get to the first element, the first element being a root and the last being the direct parent of the first element of the pair.

Parameters:

artifact - the ArtifactAst to generate a Stream for.

direction - the AstTraversalDirection used to navigate the artifact.

ignoreParameterComplexValues - whether the returned Stream will contain any complex values in component parameters.

Returns:

an enhanced Stream with hierarchy context.

validate

public static ValidationResult validate(ArtifactAst artifact)

Runs all validations available from the current Thread.getContextClassLoader().

All validations will be run even if failures are found in some. The result will contain all failures.

Parameters:

artifact - the artifact to validate

Returns:

the result of the validation

validate

public static ValidationResult validate(ArtifactAst artifact,
                                        Predicate<Validation> validationsFilter)

Runs all validations available from the current Thread.getContextClassLoader().

All validations will be run even if failures are found in some. The result will contain all failures.

Parameters:

artifact - the artifact to validate

validationsFilter - additional filter to apply on the discovered validations before evaluating them.

Returns:

the result of the validation