org.openjdk.jmc.flightrecorder.rules.jdk.memory

Class GarbageCollectionInfoRule

java.lang.Object

org.openjdk.jmc.flightrecorder.rules.jdk.memory.GarbageCollectionInfoRule

All Implemented Interfaces:

IRule

public class GarbageCollectionInfoRule
extends java.lang.Object
implements IRule

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	GARBAGE_COLLECTION_RESULT_ID
static TypedResult<GarbageCollectionsInfo>	GC_INFO
private static ContentType<GarbageCollectionsInfo>	GC_INFO_TYPE
private static java.util.Map<java.lang.String,RulesToolkit.EventAvailability>	REQUIRED_EVENTS
private static java.util.Collection<TypedResult<?>>	RESULT_ATTRIBUTES

Constructor Summary

Constructors

Constructor and Description
GarbageCollectionInfoRule()

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.RunnableFuture<IResult>	createEvaluation(IItemCollection items, IPreferenceValueProvider preferenceValueProvider, IResultValueProvider dependencyResults) 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()
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

GARBAGE_COLLECTION_RESULT_ID

private static final java.lang.String GARBAGE_COLLECTION_RESULT_ID

See Also:

Constant Field Values

REQUIRED_EVENTS

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

GC_INFO_TYPE

private static final ContentType<GarbageCollectionsInfo> GC_INFO_TYPE

GC_INFO

public static final TypedResult<GarbageCollectionsInfo> GC_INFO

RESULT_ATTRIBUTES

private static final java.util.Collection<TypedResult<?>> RESULT_ATTRIBUTES

Constructor Detail

GarbageCollectionInfoRule

public GarbageCollectionInfoRule()

Method Detail

getId

public java.lang.String getId()

Specified by:

getId in interface IRule

Returns:

a unique id for this rule implementation

getTopic

public java.lang.String getTopic()

Specified by:

getTopic in interface IRule

Returns:

the topic for this rule, may be null

getName

public java.lang.String getName()

Specified by:

getName in interface IRule

Returns:

a human readable name for this rule

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

createEvaluation

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

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

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

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

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