org.mule.runtime.extension.api.component

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

Type Parameters:

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

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

Represents a specific configuration for a concrete ParameterizedModel.

Instances are validated during creation, so no instances must contain invalid parameters according to the model.

Since:

1.5

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ComponentParameterization.Builder<M extends org.mule.runtime.api.meta.model.parameter.ParameterizedModel> Builder that allows to create new ComponentParameterization instances.
static interface	ComponentParameterization.ParameterAction Callback to be used with forEachParameter(ParameterAction).

Method Summary

Modifier and Type	Method and Description
static <M extends org.mule.runtime.api.meta.model.parameter.ParameterizedModel> ComponentParameterization.Builder<M>	builder(M model) Provides a brand new builder instance for creating a ComponentParameterization.
void	forEachParameter(ComponentParameterization.ParameterAction action) Iterates through the parameters that have values and calls the provided action on each one.
Optional<org.mule.runtime.api.component.ComponentIdentifier>	getComponentIdentifier()
M	getModel()
Object	getParameter(org.mule.runtime.api.meta.model.parameter.ParameterGroupModel paramGroup, org.mule.runtime.api.meta.model.parameter.ParameterModel param) Obtains the value of a parameter of the declared component.
Object	getParameter(String paramGroupName, String paramName) Obtains the value of a parameter of the declared component.
Map<org.mule.runtime.api.util.Pair<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel,org.mule.runtime.api.meta.model.parameter.ParameterModel>,Object>	getParameters() Returns all the parameters of the declared model that have values.

Method Detail

getModel

M getModel()

Returns:

the actual model of the declared component.

getParameter

Object getParameter(String paramGroupName,
                    String paramName)

Obtains the value of a parameter of the declared component.

Parameters:

paramGroupName - the name of the parameter group

paramName - the name of the parameter within the group

Returns:

the value of the parameter.

getParameter

Object getParameter(org.mule.runtime.api.meta.model.parameter.ParameterGroupModel paramGroup,
                    org.mule.runtime.api.meta.model.parameter.ParameterModel param)

Obtains the value of a parameter of the declared component.

Parameters:

paramGroup - the model of the parameter group

param - the model of the parameter within the group

Returns:

the value of the parameter.

getParameters

Map<org.mule.runtime.api.util.Pair<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel,org.mule.runtime.api.meta.model.parameter.ParameterModel>,Object> getParameters()

Returns all the parameters of the declared model that have values.

Parameters with a default value but no explicit value set are contained in the returned map.

Returns:

the parameters as a map.

forEachParameter

void forEachParameter(ComponentParameterization.ParameterAction action)

Iterates through the parameters that have values and calls the provided action on each one.

Parameters with a default value but no explicit value set have the action called for.

Parameters:

action - a callback to be called for every parameter.

getComponentIdentifier

Optional<org.mule.runtime.api.component.ComponentIdentifier> getComponentIdentifier()

Returns:

ComponentIdentifier of the component this parameterizes.

builder

static <M extends org.mule.runtime.api.meta.model.parameter.ParameterizedModel> ComponentParameterization.Builder<M> builder(M model)

Provides a brand new builder instance for creating a ComponentParameterization.

Type Parameters:

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

Parameters:

model - the actual model of the declared component.

Returns:

a new builder instance.