org.openjdk.jmc.flightrecorder.rules

Interface IRule

All Known Implementing Classes:

AbstractRule

public interface IRule

Rules are used for analyzing flight recordings and creating results that can inform a user about problems.

The key method to implement is evaluate(IItemCollection, IPreferenceValueProvider). getId() must return an id that is unique for each implementation and getName() should return a human readable name.

Rule instances may be reused for multiple evaluations with different input data so it is recommended that they are stateless.

Method Summary

Modifier and Type	Method and Description
RunnableFuture<Result>	evaluate(org.openjdk.jmc.common.item.IItemCollection items, org.openjdk.jmc.common.util.IPreferenceValueProvider valueProvider) Gets a future representing the result of the evaluation of this rule.
Collection<org.openjdk.jmc.common.util.TypedPreference<?>>	getConfigurationAttributes() Gets information about which attributes may be configured during rule evaluation.
String	getId()
String	getName()
String	getTopic()

Method Detail

evaluate

RunnableFuture<Result> evaluate(org.openjdk.jmc.common.item.IItemCollection items,
                                org.openjdk.jmc.common.util.IPreferenceValueProvider valueProvider)

Gets a future representing the result of the evaluation of this rule. Running the RunnableFuture is the responsibility of the caller of this method, not the implementation.

Parameters:

items - items to evaluate

valueProvider - Provider of configuration values used for evaluation. The attributes that will be asked for from the provider should be provided by getConfigurationAttributes().

Returns:

a RunnableFuture that when run will return the evaluation result

getConfigurationAttributes

Collection<org.openjdk.jmc.common.util.TypedPreference<?>> getConfigurationAttributes()

Gets information about which attributes may be configured during rule evaluation.

Returns:

a list of configuration attributes

getId

String getId()

Returns:

a unique id for this rule implementation

getName

String getName()

Returns:

a human readable name for this rule

getTopic

String getTopic()

Returns:

the topic for this rule, may be null