org.mule.tooling.client.api.artifact.ast

Class ComponentAst

java.lang.Object

org.mule.tooling.client.api.artifact.ast.ComponentAst

public class ComponentAst
extends Object

Represents the user configuration of a component (flow, config, message processor, etc) defined in an artifact.

Every ComponentAst represents the configuration of a core configuration or an extension configuration. Which configuration element this object represents is identified by a ComponentIdentifier that can be retrieved using #getIdentifier().

Since:

1.4

Constructor Summary

Constructors

Constructor and Description
ComponentAst(String componentId, ComponentType componentType, ExtensionModel extension, ComponentGenerationInformation generationInformation, ComponentIdentifier identifier, ComponentLocation location, SourceCodeLocation metadata, Object model, org.mule.metadata.api.model.MetadataType type, List<ComponentParameterAst> parameters, List<ComponentAst> directChildren)

Method Summary

Modifier and Type	Method and Description
List<ComponentParameterAst>	getAllParameters() A parameter may have a value either because it is explicitly set in the DSL, or because the extension model defines a default value for it.
Optional<String>	getComponentId()
ComponentType	getComponentType()
List<ComponentAst>	getDirectChildren()
ExtensionModel	getExtension()
ComponentGenerationInformation	getGenerationInformation()
ComponentIdentifier	getIdentifier()
ComponentLocation	getLocation()
SourceCodeLocation	getMetadata()
<M> Optional<M>	getModel(Class<M> modelClass) A component may be represented by different kinds of models, depending on the actual type of this component.
ComponentParameterAst	getParameter(String paramName)
Map<String,ComponentParameterAst>	getParameters() A parameter may have a value either because it is explicitly set in the DSL, or because the extension model defines a default value for it.
org.mule.metadata.api.model.MetadataType	getType()

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentAst

public ComponentAst(String componentId,
                    ComponentType componentType,
                    ExtensionModel extension,
                    ComponentGenerationInformation generationInformation,
                    ComponentIdentifier identifier,
                    ComponentLocation location,
                    SourceCodeLocation metadata,
                    Object model,
                    org.mule.metadata.api.model.MetadataType type,
                    List<ComponentParameterAst> parameters,
                    List<ComponentAst> directChildren)

Method Detail

getIdentifier

public ComponentIdentifier getIdentifier()

Returns:

the identifier for the configuration element this object represents.

getComponentType

public ComponentType getComponentType()

Returns:

a general typification of the role of this component.

getLocation

public ComponentLocation getLocation()

Returns:

the location of the component in the configuration.

getMetadata

public SourceCodeLocation getMetadata()

Returns:

the parser metadata for this component.

getGenerationInformation

public ComponentGenerationInformation getGenerationInformation()

Returns:

an object containing information about the generation of this component.

getComponentId

public Optional<String> getComponentId()

Returns:

the id of this component if it has one defined, or empty otherwise.

getExtension

public ExtensionModel getExtension()

Returns:

the extension that declares the model that represents this component.

getModel

public <M> Optional<M> getModel(Class<M> modelClass)

A component may be represented by different kinds of models, depending on the actual type of this component. Possible values may be, for instance, instances of ConfigurationModel, ComponentModel or ConnectionProviderModel (but not necessarily limited to those).

Parameters:

modelClass - the class of the model this method should return.

Returns:

the model that represents this component.

getType

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

Returns:

the type that represents this component, if it is represented by a type.

getParameter

public ComponentParameterAst getParameter(String paramName)

Parameters:

paramName - the name of the parameter to get AST for.

Returns:

the AST of the parameter, or null if it doesn't exist.

getAllParameters

public List<ComponentParameterAst> getAllParameters()

A parameter may have a value either because it is explicitly set in the DSL, or because the extension model defines a default value for it.

Returns:

the ASTs of all the parameters that have a value.

getParameters

public Map<String,ComponentParameterAst> getParameters()

A parameter may have a value either because it is explicitly set in the DSL, or because the extension model defines a default value for it.

Returns:

the ASTs of all the parameters that have a value with the name of the parameter as the key.

getDirectChildren

public List<ComponentAst> getDirectChildren()

Returns:

a Stream for this component's children.