Package org.openjdk.jmc.flightrecorder.rules.jdk.general

Class OptionsCheckRule

java.lang.Object

org.openjdk.jmc.flightrecorder.rules.jdk.general.OptionsCheckRule

All Implemented Interfaces:

IRule

public class OptionsCheckRule
extends Object
implements IRule

Check that used command line options are:

• Not on a list of known not recommended options/values
• Not deprecated (also check Java versions later than the one currently used)
• Documented

Warn for any detected options that do not fulfill these criteria.

Field Summary

Fields

Modifier and Type	Field	Description
static TypedCollectionResult<org.openjdk.jmc.flightrecorder.rules.jdk.general.OptionsCheckRule.OptionWarning>	DEPRECATED_OPTIONS
static TypedCollectionResult<org.openjdk.jmc.flightrecorder.rules.jdk.general.OptionsCheckRule.OptionWarning>	NOT_RECOMMENDED_OPTIONS
static TypedCollectionResult<String>	UNDOCUMENTED_OPTIONS

Constructor Summary

Constructors

Constructor	Description
OptionsCheckRule()

Method Summary

Modifier and Type	Method	Description
RunnableFuture<IResult>	createEvaluation(IItemCollection items, IPreferenceValueProvider valueProvider, IResultValueProvider resultProvider)
Collection<TypedPreference<?>>	getConfigurationAttributes()
String	getId()
String	getName()
Map<String,RulesToolkit.EventAvailability>	getRequiredEvents()
Collection<TypedResult<?>>	getResults()
String	getTopic()

Methods inherited from class java.lang.Object

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

Field Detail

UNDOCUMENTED_OPTIONS

public static final TypedCollectionResult<String> UNDOCUMENTED_OPTIONS

DEPRECATED_OPTIONS

public static final TypedCollectionResult<org.openjdk.jmc.flightrecorder.rules.jdk.general.OptionsCheckRule.OptionWarning> DEPRECATED_OPTIONS

NOT_RECOMMENDED_OPTIONS

public static final TypedCollectionResult<org.openjdk.jmc.flightrecorder.rules.jdk.general.OptionsCheckRule.OptionWarning> NOT_RECOMMENDED_OPTIONS

Constructor Detail

OptionsCheckRule

public OptionsCheckRule()

Method Detail

createEvaluation

public RunnableFuture<IResult> createEvaluation(IItemCollection items,
                                                IPreferenceValueProvider valueProvider,
                                                IResultValueProvider resultProvider)

Specified by:

createEvaluation in interface IRule

getConfigurationAttributes

public Collection<TypedPreference<?>> getConfigurationAttributes()

Specified by:

getConfigurationAttributes in interface IRule

getId

public String getId()

Specified by:

getId in interface IRule

getName

public String getName()

Specified by:

getName in interface IRule

getTopic

public String getTopic()

Specified by:

getTopic in interface IRule

getRequiredEvents

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

Specified by:

getRequiredEvents in interface IRule

getResults

public Collection<TypedResult<?>> getResults()

Specified by:

getResults in interface IRule