org.openjdk.jmc.flightrecorder.rules

Class AbstractRule

java.lang.Object

org.openjdk.jmc.flightrecorder.rules.AbstractRule

All Implemented Interfaces:

IRule

Direct Known Subclasses:

ApplicationHaltsRule, AutoBoxingRule, CompareCpuRule, ErrorRule, FatalErrorRule, FewSampledThreadsRule, GcFreedRatioRule, GcPauseRatioRule, StringDeduplicationRule

public abstract class AbstractRule
extends java.lang.Object
implements IRule

Abstract base class for rules, supplying some boiler plate code.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Collection<TypedPreference<?>>	configAttributes
protected java.util.concurrent.FutureTask<IResult>	evaluationTask
private java.lang.String	id
private java.lang.String	name
private java.util.Map<java.lang.String,RulesToolkit.EventAvailability>	requiredEvents
private java.util.Collection<TypedResult<?>>	resultAttributes
private java.lang.String	topic

Constructor Summary

Constructors

Constructor and Description
AbstractRule(java.lang.String id, java.lang.String name, java.lang.String topic, java.util.Collection<TypedPreference<?>> configAttributes, java.util.Collection<TypedResult<?>> resultAttributes, java.util.Map<java.lang.String,RulesToolkit.EventAvailability> requiredEvents)

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.RunnableFuture<IResult>	createEvaluation(IItemCollection items, IPreferenceValueProvider valueProvider, IResultValueProvider resultProvider) Gets a future representing the result of the evaluation of this rule.
java.util.Collection<TypedPreference<?>>	getConfigurationAttributes() Gets information about which attributes may be configured during rule evaluation.
java.lang.String	getId()
java.lang.String	getName()
java.util.Map<java.lang.String,RulesToolkit.EventAvailability>	getRequiredEvents()
protected abstract IResult	getResult(IItemCollection items, IPreferenceValueProvider vp, IResultValueProvider rp)
java.util.Collection<TypedResult<?>>	getResults() Gets information about which results may be part of an IResult instance.
java.lang.String	getTopic()

Methods inherited from class java.lang.Object

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

Field Detail

evaluationTask

protected java.util.concurrent.FutureTask<IResult> evaluationTask

id

private final java.lang.String id

name

private final java.lang.String name

topic

private final java.lang.String topic

configAttributes

private final java.util.Collection<TypedPreference<?>> configAttributes

resultAttributes

private final java.util.Collection<TypedResult<?>> resultAttributes

requiredEvents

private final java.util.Map<java.lang.String,RulesToolkit.EventAvailability> requiredEvents

Constructor Detail

AbstractRule

public AbstractRule(java.lang.String id,
                    java.lang.String name,
                    java.lang.String topic,
                    java.util.Collection<TypedPreference<?>> configAttributes,
                    java.util.Collection<TypedResult<?>> resultAttributes,
                    java.util.Map<java.lang.String,RulesToolkit.EventAvailability> requiredEvents)

Method Detail

getResult

protected abstract IResult getResult(IItemCollection items,
                                     IPreferenceValueProvider vp,
                                     IResultValueProvider rp)

createEvaluation

public java.util.concurrent.RunnableFuture<IResult> createEvaluation(IItemCollection items,
                                                                     IPreferenceValueProvider valueProvider,
                                                                     IResultValueProvider resultProvider)

Description copied from interface: IRule

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.

Specified by:

createEvaluation in interface IRule

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 IRule.getConfigurationAttributes().

resultProvider - Provider of results from rules evaluated prior to this rule and which this rule explicitly depends on via a DependsOn annotation. The attributes that will be asked for from the provider will be provided by each dependant rule, e.g. via public static constants.

Returns:

a RunnableFuture that when run will return the evaluation result

getConfigurationAttributes

public java.util.Collection<TypedPreference<?>> getConfigurationAttributes()

Description copied from interface: IRule

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

Specified by:

getConfigurationAttributes in interface IRule

Returns:

a list of configuration attributes

getId

public java.lang.String getId()

Specified by:

getId in interface IRule

Returns:

a unique id for this rule implementation

getName

public java.lang.String getName()

Specified by:

getName in interface IRule

Returns:

a human readable name for this rule

getTopic

public java.lang.String getTopic()

Specified by:

getTopic in interface IRule

Returns:

the topic for this rule, may be null

getResults

public java.util.Collection<TypedResult<?>> getResults()

Description copied from interface: IRule

Gets information about which results may be part of an IResult instance.

Specified by:

getResults in interface IRule

Returns:

a list of result attributes

getRequiredEvents

public java.util.Map<java.lang.String,RulesToolkit.EventAvailability> getRequiredEvents()

Specified by:

getRequiredEvents in interface IRule

Returns:

a map of all event type IDs and the minimum RulesToolkit.EventAvailability this rule requires for that event type