org.mule.runtime.internal.parameterization

Class ComponentParameterizationBuilder<M extends ParameterizedModel>

java.lang.Object

org.mule.runtime.internal.parameterization.ComponentParameterizationBuilder<M>

Type Parameters:

M - the actual ParameterizedModel sub-type of the component being built.

All Implemented Interfaces:

ComponentParameterization.Builder<M>

public class ComponentParameterizationBuilder<M extends ParameterizedModel>
extends Object
implements ComponentParameterization.Builder<M>

Builder class for creating ComponentParameterization instances. The created instances of ComponentParameterization are immutable.

Since:

1.5

Constructor Summary

Constructors

Constructor and Description
ComponentParameterizationBuilder()

Method Summary

Modifier and Type	Method and Description
ComponentParameterization<M>	build() Performs validations on the parameters provided through ComponentParameterization.Builder.withParameter(String, String, Object).
ComponentParameterization.Builder<M>	withComponentIdentifier(ComponentIdentifier identifier)
ComponentParameterization.Builder<M>	withModel(M model)
ComponentParameterization.Builder<M>	withParameter(ParameterGroupModel paramGroup, ParameterModel paramModel, Object paramValue) Sets a parameter with the given ParameterGroupModel and ParameterModel
ComponentParameterization.Builder<M>	withParameter(String paramName, Object paramValue) Sets a parameter with a given value, automatically determining the group the parameter belongs to.
ComponentParameterization.Builder<M>	withParameter(String paramGroupName, String paramName, Object paramValue) Sets a parameter with a given value.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentParameterizationBuilder

public ComponentParameterizationBuilder()

Method Detail

withModel

public ComponentParameterization.Builder<M> withModel(M model)

withParameter

public ComponentParameterization.Builder<M> withParameter(String paramGroupName,
                                                          String paramName,
                                                          Object paramValue)
                                                   throws IllegalArgumentException

Description copied from interface: ComponentParameterization.Builder

Sets a parameter with a given value.

Specified by:

withParameter in interface ComponentParameterization.Builder<M extends ParameterizedModel>

Parameters:

paramGroupName - the name of the group containing the parameter to set.

paramName - the name of the parameter within the paramGroupName group to set.

paramValue - the value of the parameter to set

Returns:

this builder

Throws:

IllegalArgumentException - if the provided parameter group and name does not exist for the model or is not of a valid type.

withParameter

public ComponentParameterization.Builder<M> withParameter(ParameterGroupModel paramGroup,
                                                          ParameterModel paramModel,
                                                          Object paramValue)

Description copied from interface: ComponentParameterization.Builder

Sets a parameter with the given ParameterGroupModel and ParameterModel

Specified by:

withParameter in interface ComponentParameterization.Builder<M extends ParameterizedModel>

Parameters:

paramGroup - - the ParameterGroupModel of the Parameter

paramModel - - the ParameterModel of the Parameter

paramValue - - the value of the parameter to set.

Returns:

this Builder.

withParameter

public ComponentParameterization.Builder<M> withParameter(String paramName,
                                                          Object paramValue)
                                                   throws IllegalArgumentException

Description copied from interface: ComponentParameterization.Builder

Sets a parameter with a given value, automatically determining the group the parameter belongs to.

Specified by:

withParameter in interface ComponentParameterization.Builder<M extends ParameterizedModel>

Parameters:

paramName - the name of the parameter within the paramGroupName group to set.

paramValue - the value of the parameter to set

Returns:

this builder

Throws:

IllegalArgumentException - if the provided parameter name does not exist for the model, a parameter with the same name exists in more than on parameter group, or is not of a valid type.

withComponentIdentifier

public ComponentParameterization.Builder<M> withComponentIdentifier(ComponentIdentifier identifier)

Specified by:

withComponentIdentifier in interface ComponentParameterization.Builder<M extends ParameterizedModel>

Parameters:

identifier - - the ComponentIdentifier of the parameterized component.

Returns:

this builder

build

public ComponentParameterization<M> build()

Description copied from interface: ComponentParameterization.Builder

Performs validations on the parameters provided through ComponentParameterization.Builder.withParameter(String, String, Object). If valid, returns a ComponentParameterization, otherwise an IllegalStateException is thrown.

Specified by:

build in interface ComponentParameterization.Builder<M extends ParameterizedModel>

Returns:

a valid ComponentParameterization.