org.mule.runtime.api.meta.model.declaration.fluent.util

Class DeclarationWalker

java.lang.Object

org.mule.runtime.api.meta.model.declaration.fluent.util.DeclarationWalker

public abstract class DeclarationWalker
extends Object

Navigates a ExtensionDeclaration and invokes methods when important model components are found.

This is useful to centralize the logic of how to iterate through a model's structure without coupling to it. For example, the onOperation(WithOperationsDeclaration, OperationDeclaration) method allows handling operations without requiring to know that they can exist at global or configuration level. Something similar can be said about the onParameter(ParameterizedDeclaration, ParameterGroupDeclaration, ParameterDeclaration), etc.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
DeclarationWalker()

Method Summary

Modifier and Type	Method and Description
protected void	onConfiguration(ConfigurationDeclaration declaration) Invoked when a ConfigurationDeclaration is found in the traversed extensionDeclaration
protected void	onConnectionProvider(ConnectedDeclaration owner, ConnectionProviderDeclaration declaration) Invoked when an ConnectedDeclaration is found in the traversed extensionDeclaration
protected void	onConstruct(WithConstructsDeclaration owner, ConstructDeclaration declaration) Invoked when a ConstructDeclaration is found in the traversed extensionDeclaration.
protected void	onFunction(WithFunctionsDeclaration owner, FunctionDeclaration model) Invoked when an FunctionDeclaration is found in the traversed extensionDeclaration.
protected void	onOperation(WithOperationsDeclaration owner, OperationDeclaration declaration) Invoked when an OperationDeclaration is found in the traversed extensionDeclaration.
protected void	onParameter(ParameterizedDeclaration owner, ParameterGroupDeclaration parameterGroup, ParameterDeclaration declaration) Invoked when an ParameterDeclaration is found in the traversed extensionDeclaration
protected void	onParameterGroup(ParameterizedDeclaration owner, ParameterGroupDeclaration declaration) Invoked when an ParameterGroupDeclaration is found in the traversed extensionDeclaration
protected void	onSource(WithSourcesDeclaration owner, SourceDeclaration declaration) Invoked when an SourceDeclaration is found in the traversed extensionDeclaration
protected void	stop() When invoked, the traversal of the ExtensionDeclaration will stop once the current visit is completed.
void	walk(ExtensionDeclaration extensionDeclaration) Navigates the given extensionDeclaration and invokes the other public method's in this class as the navigation progresses

Methods inherited from class java.lang.Object

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

Constructor Detail

DeclarationWalker

public DeclarationWalker()

Method Detail

walk

public final void walk(ExtensionDeclaration extensionDeclaration)

Navigates the given extensionDeclaration and invokes the other public method's in this class as the navigation progresses

Parameters:

extensionDeclaration - the model to navigate

stop

protected final void stop()

When invoked, the traversal of the ExtensionDeclaration will stop once the current visit is completed. This will not break the execution within the invoking method, but instead avoid further traversal of the model from that point on.

onConfiguration

protected void onConfiguration(ConfigurationDeclaration declaration)

Invoked when a ConfigurationDeclaration is found in the traversed extensionDeclaration

Parameters:

declaration - a ConfigurationDeclaration

onOperation

protected void onOperation(WithOperationsDeclaration owner,
                           OperationDeclaration declaration)

Invoked when an OperationDeclaration is found in the traversed extensionDeclaration.

Parameters:

owner - The declaration that owns the operation

declaration - the WithOperationsDeclaration

onFunction

protected void onFunction(WithFunctionsDeclaration owner,
                          FunctionDeclaration model)

Invoked when an FunctionDeclaration is found in the traversed extensionDeclaration.

Parameters:

owner - The declaration that owns the function

model - the FunctionDeclaration

onConstruct

protected void onConstruct(WithConstructsDeclaration owner,
                           ConstructDeclaration declaration)

Invoked when a ConstructDeclaration is found in the traversed extensionDeclaration.

Parameters:

owner - The declaration that owns the operation

declaration - the WithOperationsDeclaration

onConnectionProvider

protected void onConnectionProvider(ConnectedDeclaration owner,
                                    ConnectionProviderDeclaration declaration)

Invoked when an ConnectedDeclaration is found in the traversed extensionDeclaration

Parameters:

owner - The declaration that owns the provider

declaration - the ConnectionProviderDeclaration

onSource

protected void onSource(WithSourcesDeclaration owner,
                        SourceDeclaration declaration)

Invoked when an SourceDeclaration is found in the traversed extensionDeclaration

Parameters:

owner - The declaration that owns the source

declaration - the SourceDeclaration

onParameterGroup

protected void onParameterGroup(ParameterizedDeclaration owner,
                                ParameterGroupDeclaration declaration)

Invoked when an ParameterGroupDeclaration is found in the traversed extensionDeclaration

Parameters:

owner - The declaration that owns the parameter

declaration - the ParameterGroupDeclaration

onParameter

protected void onParameter(ParameterizedDeclaration owner,
                           ParameterGroupDeclaration parameterGroup,
                           ParameterDeclaration declaration)

Invoked when an ParameterDeclaration is found in the traversed extensionDeclaration

Parameters:

owner - The declaration that owns the parameter

parameterGroup - the group to which the declaration belongs

declaration - the ParameterDeclaration