Module org.mule.runtime.artifact.ast

Package org.mule.runtime.ast.internal.builder

Class BaseComponentAstBuilder<B extends BaseComponentAstBuilder>

java.lang.Object

org.mule.runtime.ast.internal.builder.BaseComponentAstBuilder<B>

All Implemented Interfaces:

Supplier<ComponentAst>, ComponentAstBuilder

Direct Known Subclasses:

DefaultComponentAstBuilder, LightComponentAstBuilder

public abstract class BaseComponentAstBuilder<B extends BaseComponentAstBuilder>
extends Object
implements ComponentAstBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BODY_RAW_PARAM_NAME
protected Supplier<Optional<String>>	componentId
static final String	SOURCE_TYPE
static final String	TARGET_TYPE

Constructor Summary

Constructors

Constructor	Description
BaseComponentAstBuilder(PropertiesResolver propertiesResolver, ParameterModelUtils parameterModelUtils)

Method Summary

Modifier and Type	Method	Description
ComponentAstBuilder	addChildComponent(B childComponent)
Stream<B>	childComponentsStream()
protected Map<ParameterKey,ComponentParameterAst>	createParameterAsts()
protected void	doRemoveParamChild(org.mule.runtime.api.component.ComponentIdentifier componentIdentifier)
Map<String,Object>	getAnnotations()
Optional<String>	getComponentId()
org.mule.runtime.api.component.TypedComponentIdentifier.ComponentType	getComponentType()
org.mule.runtime.api.meta.model.ExtensionModel	getExtensionModel()
org.mule.runtime.ast.internal.DefaultComponentGenerationInformation.Builder	getGenerationInformation()
org.mule.runtime.api.component.ComponentIdentifier	getIdentifier()
org.mule.runtime.api.component.location.ComponentLocation	getLocation()
ComponentMetadataAst	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.
ParameterModelUtils	getParameterModelUtils()
protected Set<B>	getParamsChildren()
protected PropertiesResolver	getPropertiesResolver()
Map<String,String>	getRawParameters()
org.mule.metadata.api.model.MetadataType	getType()
void	prepareForBuild()
ComponentAstBuilder	removeChildComponent(B childComponent)
protected void	removeParamChild(org.mule.runtime.api.meta.model.parameter.ParameterModel paramModel, org.mule.runtime.api.meta.model.parameter.ParameterGroupModel parameterGroupModel)
protected Optional<String>	resolveComponentId(Map<ParameterKey,ComponentParameterAst> parameterAsts)
void	setComponentId(Supplier<Optional<String>> componentId)
protected void	validateSingleModelSet()
ComponentAstBuilder	withAnnotation(String name, Object value)	Adds an annotation as defined in the DSL to this component builder.
ComponentAstBuilder	withBodyParameter(String parameterRawValue)	Adds a body parameter as defined in the DSL to this component builder.
ComponentAstBuilder	withComponentModel(org.mule.runtime.api.meta.model.ComponentModel componentModel)	Sets the model declaration of the target component.
ComponentAstBuilder	withComponentType(org.mule.runtime.api.component.TypedComponentIdentifier.ComponentType componentType)
ComponentAstBuilder	withConfigurationModel(org.mule.runtime.api.meta.model.config.ConfigurationModel configurationModel)	Sets the model declaration of the target component.
ComponentAstBuilder	withConnectionProviderModel(org.mule.runtime.api.meta.model.connection.ConnectionProviderModel connectionProviderModel)	Sets the model declaration of the target component.
ComponentAstBuilder	withExtensionModel(org.mule.runtime.api.meta.model.ExtensionModel extensionModel)
ComponentAstBuilder	withIdentifier(org.mule.runtime.api.component.ComponentIdentifier identifier)
ComponentAstBuilder	withLocation(org.mule.runtime.api.component.location.ComponentLocation location)
ComponentAstBuilder	withMetadata(ComponentMetadataAst metadata)
ComponentAstBuilder	withNestableElementModel(org.mule.runtime.api.meta.model.nested.NestableElementModel nestableElementModel)	Sets the model declaration of the target component.
BaseComponentAstBuilder<B>	withParameter(org.mule.runtime.api.meta.model.parameter.ParameterModel paramModel, org.mule.runtime.api.meta.model.parameter.ParameterGroupModel parameterGroupModel, ComponentParameterAst paramValue, Iterable<org.mule.runtime.api.component.ComponentIdentifier> paramIdentifiers)
BaseComponentAstBuilder<B>	withParameter(org.mule.runtime.api.meta.model.parameter.ParameterModel paramModel, org.mule.runtime.api.meta.model.parameter.ParameterGroupModel parameterGroupModel, ComponentParameterAst paramValue, Optional<org.mule.runtime.api.component.ComponentIdentifier> paramIdentifier)
BaseComponentAstBuilder<B>	withParameterizedModel(org.mule.runtime.api.meta.model.parameter.ParameterizedModel parameterizedModel)	Sets the model declaration of the target component.
ComponentAstBuilder	withRawParameter(String paramName, String paramRawValue)	Adds a parameter as defined in the DSL to this component builder.

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.ast.api.builder.ComponentAstBuilder

addChildComponent, build

Methods inherited from interface java.util.function.Supplier

get

Field Details

BODY_RAW_PARAM_NAME

public static final String BODY_RAW_PARAM_NAME

See Also:

• Constant Field Values

SOURCE_TYPE

public static final String SOURCE_TYPE

See Also:

• Constant Field Values

TARGET_TYPE

public static final String TARGET_TYPE

See Also:

• Constant Field Values

componentId

protected Supplier<Optional<String>> componentId

Constructor Details

BaseComponentAstBuilder

public BaseComponentAstBuilder(PropertiesResolver propertiesResolver,
 ParameterModelUtils parameterModelUtils)

Method Details

addChildComponent

public ComponentAstBuilder addChildComponent(B childComponent)

removeChildComponent

public ComponentAstBuilder removeChildComponent(B childComponent)

withRawParameter

public ComponentAstBuilder withRawParameter(String paramName,
 String paramRawValue)

Description copied from interface: ComponentAstBuilder

Adds a parameter as defined in the DSL to this component builder.

When the target component is actually being built, these parameter names are matched to the parameters defined in the model provided by ComponentAstBuilder.withParameterizedModel(ParameterizedModel) to create the actual parameters map of the component.

Specified by:

withRawParameter in interface ComponentAstBuilder

Parameters:

paramName - the name of the parameter for which a raw value is provided.

paramRawValue - the raw value of the parameter, as defined in the DSL.

Returns:

this builder

withBodyParameter

public ComponentAstBuilder withBodyParameter(String parameterRawValue)

Description copied from interface: ComponentAstBuilder

Adds a body parameter as defined in the DSL to this component builder.

When the target component is actually being built, these body parameter is matched to the parameters defined in the model provided by ComponentAstBuilder.withParameterizedModel(ParameterizedModel) to create the actual parameters map of the component.

Specified by:

withBodyParameter in interface ComponentAstBuilder

Parameters:

parameterRawValue - the raw value of the body parameter.

Returns:

this builder

withAnnotation

public ComponentAstBuilder withAnnotation(String name,
 Object value)

Description copied from interface: ComponentAstBuilder

Adds an annotation as defined in the DSL to this component builder.

Specified by:

withAnnotation in interface ComponentAstBuilder

value - the value of the annotation.

Returns:

this builder

withParameter

public BaseComponentAstBuilder<B> withParameter(org.mule.runtime.api.meta.model.parameter.ParameterModel paramModel,
 org.mule.runtime.api.meta.model.parameter.ParameterGroupModel parameterGroupModel,
 ComponentParameterAst paramValue,
 Optional<org.mule.runtime.api.component.ComponentIdentifier> paramIdentifier)

withParameter

public BaseComponentAstBuilder<B> withParameter(org.mule.runtime.api.meta.model.parameter.ParameterModel paramModel,
 org.mule.runtime.api.meta.model.parameter.ParameterGroupModel parameterGroupModel,
 ComponentParameterAst paramValue,
 Iterable<org.mule.runtime.api.component.ComponentIdentifier> paramIdentifiers)

prepareForBuild

public void prepareForBuild()

removeParamChild

protected void removeParamChild(org.mule.runtime.api.meta.model.parameter.ParameterModel paramModel,
 org.mule.runtime.api.meta.model.parameter.ParameterGroupModel parameterGroupModel)

doRemoveParamChild

protected void doRemoveParamChild(org.mule.runtime.api.component.ComponentIdentifier componentIdentifier)

getRawParameters

public Map<String,String> getRawParameters()

createParameterAsts

protected Map<ParameterKey,ComponentParameterAst> createParameterAsts()

getAnnotations

public Map<String,Object> getAnnotations()

withExtensionModel

public ComponentAstBuilder withExtensionModel(org.mule.runtime.api.meta.model.ExtensionModel extensionModel)

Parameters:

extensionModel - the extension that declares the model that represents this compoennt.

Returns:

this builder

getExtensionModel

public org.mule.runtime.api.meta.model.ExtensionModel getExtensionModel()

Specified by:

getExtensionModel in interface ComponentAstBuilder

Returns:

the extension model that declares the model this component represents.

withComponentModel

public ComponentAstBuilder withComponentModel(org.mule.runtime.api.meta.model.ComponentModel componentModel)

Sets the model declaration of the target component.

This method is exclusive with withNestableElementModel(NestableElementModel), withConfigurationModel(ConfigurationModel), withConnectionProviderModel(ConnectionProviderModel) and withParameterizedModel(ParameterizedModel); only one of these may be called for a single builder.

Parameters:

componentModel - the model that represents this component.

Returns:

this builder

withNestableElementModel

public ComponentAstBuilder withNestableElementModel(org.mule.runtime.api.meta.model.nested.NestableElementModel nestableElementModel)

Sets the model declaration of the target component.

This method is exclusive with withComponentModel(ComponentModel), withConfigurationModel(ConfigurationModel), withConnectionProviderModel(ConnectionProviderModel) and withParameterizedModel(ParameterizedModel); only one of these may be called for a single builder.

Parameters:

nestableElementModel - the model that represents this component.

Returns:

this builder

withConfigurationModel

public ComponentAstBuilder withConfigurationModel(org.mule.runtime.api.meta.model.config.ConfigurationModel configurationModel)

Sets the model declaration of the target component.

This method is exclusive with withComponentModel(ComponentModel), withNestableElementModel(NestableElementModel), withConnectionProviderModel(ConnectionProviderModel) and withParameterizedModel(ParameterizedModel); only one of these may be called for a single builder.

Parameters:

configurationModel - the model that represents this component.

Returns:

this builder

withConnectionProviderModel

public ComponentAstBuilder withConnectionProviderModel(org.mule.runtime.api.meta.model.connection.ConnectionProviderModel connectionProviderModel)

Sets the model declaration of the target component.

This method is exclusive with withComponentModel(ComponentModel), withNestableElementModel(NestableElementModel), withConfigurationModel(ConfigurationModel) and withParameterizedModel(ParameterizedModel); only one of these may be called for a single builder.

Parameters:

connectionProviderModel - the model that represents this component.

Returns:

this builder

withParameterizedModel

public BaseComponentAstBuilder<B> withParameterizedModel(org.mule.runtime.api.meta.model.parameter.ParameterizedModel parameterizedModel)

Sets the model declaration of the target component.

This method is exclusive with withComponentModel(ComponentModel), withNestableElementModel(NestableElementModel), withConfigurationModel(ConfigurationModel) and withConnectionProviderModel(ConnectionProviderModel); only one of these may be called for a single builder.

Specified by:

withParameterizedModel in interface ComponentAstBuilder

Parameters:

parameterizedModel - the model that represents this component.

Returns:

this builder

validateSingleModelSet

protected void validateSingleModelSet()

getModel

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

Description copied from interface: ComponentAstBuilder

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).

Specified by:

getModel in interface ComponentAstBuilder

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()

withMetadata

public ComponentAstBuilder withMetadata(ComponentMetadataAst metadata)

Specified by:

withMetadata in interface ComponentAstBuilder

Parameters:

metadata - the parser metadata for this component.

Returns:

this builder

getMetadata

public ComponentMetadataAst getMetadata()

withLocation

public ComponentAstBuilder withLocation(org.mule.runtime.api.component.location.ComponentLocation location)

Parameters:

location - the location of the component in the configuration.

Returns:

this builder

withComponentType

public ComponentAstBuilder withComponentType(org.mule.runtime.api.component.TypedComponentIdentifier.ComponentType componentType)

Parameters:

componentType - a general typification of the role of this component.

Returns:

this builder

getComponentType

public org.mule.runtime.api.component.TypedComponentIdentifier.ComponentType getComponentType()

withIdentifier

public ComponentAstBuilder withIdentifier(org.mule.runtime.api.component.ComponentIdentifier identifier)

Specified by:

withIdentifier in interface ComponentAstBuilder

Parameters:

identifier - the identifier for the configuration element this object represents.

Returns:

this builder

getIdentifier

public org.mule.runtime.api.component.ComponentIdentifier getIdentifier()

Specified by:

getIdentifier in interface ComponentAstBuilder

Returns:

the identifier for the configuration element this object represents.

getLocation

public org.mule.runtime.api.component.location.ComponentLocation getLocation()

getGenerationInformation

public org.mule.runtime.ast.internal.DefaultComponentGenerationInformation.Builder getGenerationInformation()

childComponentsStream

public Stream<B> childComponentsStream()

getParamsChildren

protected Set<B> getParamsChildren()

resolveComponentId

protected Optional<String> resolveComponentId(Map<ParameterKey,ComponentParameterAst> parameterAsts)

setComponentId

public void setComponentId(Supplier<Optional<String>> componentId)

getComponentId

public Optional<String> getComponentId()

getPropertiesResolver

protected PropertiesResolver getPropertiesResolver()

getParameterModelUtils

public ParameterModelUtils getParameterModelUtils()