org.mule.runtime.extension.api.values

Interface ComponentValueProvider

@NoImplement
public interface ComponentValueProvider

This interface allows the exposure of the values associated to a parameter of a Component.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
default List<org.mule.runtime.api.meta.model.parameter.ValueProviderModel>	getModels(String providerName) Deprecated.
Set<org.mule.runtime.api.value.Value>	getValues(String providerName)
Set<org.mule.runtime.api.value.Value>	getValues(String parameterName, String targetSelector) Gets the values for the parameter of the given parameterName, using the given targetSelector.

Method Detail

getValues

Set<org.mule.runtime.api.value.Value> getValues(String providerName)
                                         throws ValueResolvingException

Parameters:

providerName - the name of the parameter for which resolve their possible values

Returns:

the resolved values

Throws:

ValueResolvingException

getValues

Set<org.mule.runtime.api.value.Value> getValues(String parameterName,
                                                String targetSelector)
                                         throws ValueResolvingException

Gets the values for the parameter of the given parameterName, using the given targetSelector. See FieldValues.targetSelectors()

Parameters:

parameterName - the name of the parameter for which its values will be resolved

targetSelector - the target selector to use to resolve the values

Returns:

the resolved values

Throws:

ValueResolvingException - if there was an error resolving the values

Since:

1.4

getModels

@Deprecated
default List<org.mule.runtime.api.meta.model.parameter.ValueProviderModel> getModels(String providerName)

Deprecated.

Retrieves the list of associated ValueProviderModel with the given provider name in the component

Parameters:

providerName - The name of the value provider

Returns:

The associated ValueProviderModel