org.mule.runtime.api.meta.model.parameter

Class ValueProviderModel

java.lang.Object

org.mule.runtime.api.meta.model.parameter.ValueProviderModel

All Implemented Interfaces:

EnrichableModel

Direct Known Subclasses:

FieldValueProviderModel

@NoExtend
 @NoInstantiate
public class ValueProviderModel
extends Object
implements EnrichableModel

Model for ParameterModel to communicate if one of these are capable to provide values.

The element with this model will considered as a one that provides values.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
ValueProviderModel(List<ActingParameterModel> parameters, boolean requiresConfiguration, boolean requiresConnection, boolean isOpen, Integer partOrder, String providerName, String providerId) Creates a new instance
ValueProviderModel(List<ActingParameterModel> parameters, boolean requiresConfiguration, boolean requiresConnection, boolean isOpen, Integer partOrder, String providerName, String providerId, ModelProperty... modelProperties) Creates a new instance

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
List<String>	getActingParameters() Deprecated. since 1.4.0, use getParameters() instead.
Set<ModelProperty>	getModelProperties() Returns all the model properties registered for this model
<T extends ModelProperty> Optional<T>	getModelProperty(Class<T> propertyType) Returns a registered model property of type propertyType.
List<ActingParameterModel>	getParameters()
Integer	getPartOrder()
String	getProviderId()
String	getProviderName()
int	hashCode()
boolean	isOpen()
boolean	requiresConfiguration()
boolean	requiresConnection()

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueProviderModel

public ValueProviderModel(List<ActingParameterModel> parameters,
                          boolean requiresConfiguration,
                          boolean requiresConnection,
                          boolean isOpen,
                          Integer partOrder,
                          String providerName,
                          String providerId)

Creates a new instance

Parameters:

parameters - the list of parameters that the Value Provider takes into account for its resolution

requiresConfiguration - indicates if the configuration is required to resolve the values

requiresConnection - indicates if the connection is required to resolve the values

isOpen - indicates if the calculated values should be considered as an open or closed set

partOrder - the position in the value

providerName - the category of the associated value provider for this parameter

providerId - the id of the associated value provider for this parameter

Since:

1.4.0

ValueProviderModel

public ValueProviderModel(List<ActingParameterModel> parameters,
                          boolean requiresConfiguration,
                          boolean requiresConnection,
                          boolean isOpen,
                          Integer partOrder,
                          String providerName,
                          String providerId,
                          ModelProperty... modelProperties)

Creates a new instance

Parameters:

parameters - the list of parameters that the Value Provider takes into account for its resolution

requiresConfiguration - indicates if the configuration is required to resolve the values

requiresConnection - indicates if the connection is required to resolve the values

isOpen - indicates if the calculated values should be considered as an open or closed set

partOrder - the position in the value

providerName - the category of the associated value provider for this parameter

providerId - the id of the associated value provider for this parameter

modelProperties - the model properties this model is enriched with

Since:

1.4.0

Method Detail

getActingParameters

@Deprecated
public List<String> getActingParameters()

Deprecated. since 1.4.0, use getParameters() instead.

Returns:

the list of parameters that are required to execute the Value Provider resolution.

getParameters

public List<ActingParameterModel> getParameters()

Returns:

the list of parameters that the Value Provider takes into account for its resolution

Since:

1.4.0

getPartOrder

public Integer getPartOrder()

Returns:

the order of this part in the value

getProviderName

public String getProviderName()

Returns:

The name of the element that provides values

getProviderId

public String getProviderId()

Returns:

The id of the element that provides values

Since:

1.4.0

requiresConfiguration

public boolean requiresConfiguration()

Returns:

a boolean indicating if the configuration is required to resolve the values

requiresConnection

public boolean requiresConnection()

Returns:

a boolean indicating if the connection is required to resolve the values

isOpen

public boolean isOpen()

Returns:

a boolean indicating if the calculated values should be considered as an open or closed set

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getModelProperty

public <T extends ModelProperty> Optional<T> getModelProperty(Class<T> propertyType)

Returns a registered model property of type propertyType.

This search considers hierarchies. If no explicit value exists for the given propertyType, then it will look for properties which extend the given type or, in the case of an interface, implement it.

Specified by:

getModelProperty in interface EnrichableModel

Type Parameters:

T - the generic type of the return value

Parameters:

propertyType - the Class of the ModelProperty which is being queried

Returns:

an Optional ModelProperty

getModelProperties

public Set<ModelProperty> getModelProperties()

Returns all the model properties registered for this model

Specified by:

getModelProperties in interface EnrichableModel

Returns:

an immutable Set containing all the model properties