org.mule.runtime.api.meta.model

Interface EnrichableModel

All Known Subinterfaces:

ComponentModel, ConfigurationModel, ConnectableComponentModel, ConnectionProviderModel, ConstructModel, ExtensionModel, FunctionModel, NestableElementModel, NestedChainModel, NestedComponentModel, NestedRouteModel, OperationModel, OutputModel, ParameterGroupModel, ParameterModel, SourceCallbackModel, SourceModel

All Known Implementing Classes:

FieldValueProviderModel, ValueProviderModel

@NoImplement
public interface EnrichableModel

A model which can be augmented with custom pieces of information that are not part of the canonical introspection model. We call these pieces model properties

This is useful for pieces of metadata which might not apply to all extensions or might be specific to particular implementations.

Examples of a model property are the namespace URI and schema version for extensions that support XML configuration, vendor specific information, custom policies, etc.

The values added as model properties must be of implementations of the ModelProperty interface. As explained on the ModelProperty javadoc, those objects should be immutable. This is because if a model definition keeps changing the runtime behaviour could become inconsistent. They should also be thread-safe since several threads should be able to query the model safely.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

getModelProperty

<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.

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

Throws:

IllegalArgumentException - if propertyType is null

getModelProperties

Set<ModelProperty> getModelProperties()

Returns all the model properties registered for this model

Returns:

an immutable Set containing all the model properties