org.mule.runtime.extension.api.component

Interface ComponentParameterization.Builder<M extends org.mule.runtime.api.meta.model.parameter.ParameterizedModel>

Type Parameters:

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

All Known Implementing Classes:

ComponentParameterizationBuilder

Enclosing interface:

ComponentParameterization<M extends org.mule.runtime.api.meta.model.parameter.ParameterizedModel>

public static interface ComponentParameterization.Builder<M extends org.mule.runtime.api.meta.model.parameter.ParameterizedModel>

Builder that allows to create new ComponentParameterization instances.

Method Summary

Modifier and Type	Method and Description
ComponentParameterization<M>	build() Performs validations on the parameters provided through withParameter(String, String, Object).
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.

Method Detail

build

ComponentParameterization<M> build()
                            throws IllegalStateException

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

Returns:

a valid ComponentParameterization.

Throws:

IllegalStateException - if any provided parameter is invalid, indicating which parameter and the reason for it being invalid.

withParameter

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

Sets a parameter with a given value.

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

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

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

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.