org.openjdk.jmc.flightrecorder.rules.jdk.exceptions

Class LuceneVersionRule

java.lang.Object

org.openjdk.jmc.flightrecorder.rules.jdk.exceptions.LuceneVersionRule

All Implemented Interfaces:

IRule

public class LuceneVersionRule
extends java.lang.Object
implements IRule

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	LuceneVersionRule.LuceneConsumer

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	LOOKAHEAD_SUCCESS_NAME
private static java.util.Map<java.lang.String,RulesToolkit.EventAvailability>	REQUIRED_EVENTS
private static java.util.Collection<TypedResult<?>>	RESULT_ATTRIBUTES
private static java.lang.String	RESULT_ID

Constructor Summary

Constructors

Constructor and Description
LuceneVersionRule()

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()
private 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()
private LuceneVersionRule.LuceneConsumer	isElasticSearch(IItemCollection items)

Methods inherited from class java.lang.Object

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

Field Detail

RESULT_ID

private static final java.lang.String RESULT_ID

See Also:

Constant Field Values

REQUIRED_EVENTS

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

RESULT_ATTRIBUTES

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

LOOKAHEAD_SUCCESS_NAME

private static final java.lang.String LOOKAHEAD_SUCCESS_NAME

See Also:

Constant Field Values

Constructor Detail

LuceneVersionRule

public LuceneVersionRule()

Method Detail

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

getResult

private IResult getResult(IItemCollection items,
                          IPreferenceValueProvider vp,
                          IResultValueProvider rp)

isElasticSearch

private LuceneVersionRule.LuceneConsumer isElasticSearch(IItemCollection items)

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

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

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