public class OptionsCheckRule extends java.lang.Object implements IRule
Modifier and Type | Class and Description |
---|---|
private static class |
OptionsCheckRule.DeprecatedOption |
private static class |
OptionsCheckRule.OptionWarning |
Modifier and Type | Field and Description |
---|---|
private static TypedPreference<java.lang.String> |
ACCEPTED_OPTIONS |
static TypedCollectionResult<OptionsCheckRule.OptionWarning> |
DEPRECATED_OPTIONS |
private static OptionsCheckRule.DeprecatedOption[] |
DEPRECATED_OPTIONS_X |
private static OptionsCheckRule.DeprecatedOption[] |
DEPRECATED_OPTIONS_XX |
private static java.lang.String[] |
JAVA_7_DOCUMENTED_XX |
private static java.lang.String[] |
JAVA_8_DOCUMENTED_XX |
static TypedCollectionResult<OptionsCheckRule.OptionWarning> |
NOT_RECOMMENDED_OPTIONS |
private static ContentType<OptionsCheckRule.OptionWarning> |
OPTION_WARNING |
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 |
static TypedCollectionResult<java.lang.String> |
UNDOCUMENTED_OPTIONS |
private static java.util.regex.Pattern |
XX_OPTION_PATTERN
Match group 1 will contain the option name.
|
Constructor and Description |
---|
OptionsCheckRule() |
Modifier and Type | Method and Description |
---|---|
private static boolean |
checkDeprecatedX(java.lang.String option,
JavaVersion usedVersion,
java.util.List<OptionsCheckRule.OptionWarning> deprecatedList) |
private static boolean |
checkDeprecatedXX(java.lang.String option,
java.lang.String optionName,
JavaVersion usedVersion,
java.util.List<OptionsCheckRule.OptionWarning> deprecatedList) |
private static boolean |
checkDocumentedXX(java.lang.String option,
java.lang.String optionName,
JavaVersion usedVersion,
java.util.List<java.lang.String> undocumentedList) |
private static boolean |
checkNotRecommended(java.lang.String option,
JavaVersion usedVersion,
java.util.List<OptionsCheckRule.OptionWarning> notRecommendedList) |
private static void |
checkOption(java.lang.String option,
JavaVersion usedVersion,
java.util.List<java.lang.String> undocumentedList,
java.util.List<OptionsCheckRule.OptionWarning> deprecatedList,
java.util.List<OptionsCheckRule.OptionWarning> notRecommendedList) |
private static void |
checkOptions(java.lang.String optionList,
JavaVersion usedVersion,
java.util.List<java.lang.String> undocumentedList,
java.util.List<OptionsCheckRule.OptionWarning> deprecatedList,
java.util.List<OptionsCheckRule.OptionWarning> notRecommendedList,
java.util.Set<java.lang.String> acceptedOptions) |
private java.lang.String |
composeShortMessage(java.util.List<java.lang.String> undocumentedList,
java.util.List<OptionsCheckRule.OptionWarning> deprecatedList,
java.util.List<OptionsCheckRule.OptionWarning> notRecommendedList) |
java.util.concurrent.RunnableFuture<IResult> |
createEvaluation(IItemCollection items,
IPreferenceValueProvider valueProvider,
IResultValueProvider resultProvider)
Gets a future representing the result of the evaluation of this rule.
|
private static java.lang.String |
extractOptionName(java.lang.String option) |
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 valueProvider,
IResultValueProvider resultProvider) |
java.util.Collection<TypedResult<?>> |
getResults()
Gets information about which results may be part of an
IResult instance. |
java.lang.String |
getTopic() |
private java.util.Set<java.lang.String> |
getUserAcceptedOptions(IPreferenceValueProvider valueProvider) |
private static boolean |
isUserAcceptedOption(java.lang.String option,
java.util.Set<java.lang.String> acceptedOptions) |
private static final java.lang.String RESULT_ID
private static final TypedPreference<java.lang.String> ACCEPTED_OPTIONS
private static final java.util.regex.Pattern XX_OPTION_PATTERN
private static final java.lang.String[] JAVA_7_DOCUMENTED_XX
private static final java.lang.String[] JAVA_8_DOCUMENTED_XX
private static final OptionsCheckRule.DeprecatedOption[] DEPRECATED_OPTIONS_XX
private static final OptionsCheckRule.DeprecatedOption[] DEPRECATED_OPTIONS_X
private static final java.util.Map<java.lang.String,RulesToolkit.EventAvailability> REQUIRED_EVENTS
private static final ContentType<OptionsCheckRule.OptionWarning> OPTION_WARNING
public static final TypedCollectionResult<java.lang.String> UNDOCUMENTED_OPTIONS
public static final TypedCollectionResult<OptionsCheckRule.OptionWarning> DEPRECATED_OPTIONS
public static final TypedCollectionResult<OptionsCheckRule.OptionWarning> NOT_RECOMMENDED_OPTIONS
private static final java.util.Collection<TypedResult<?>> RESULT_ATTRIBUTES
private static void checkOptions(java.lang.String optionList, JavaVersion usedVersion, java.util.List<java.lang.String> undocumentedList, java.util.List<OptionsCheckRule.OptionWarning> deprecatedList, java.util.List<OptionsCheckRule.OptionWarning> notRecommendedList, java.util.Set<java.lang.String> acceptedOptions)
private static boolean isUserAcceptedOption(java.lang.String option, java.util.Set<java.lang.String> acceptedOptions)
private static java.lang.String extractOptionName(java.lang.String option)
private static void checkOption(java.lang.String option, JavaVersion usedVersion, java.util.List<java.lang.String> undocumentedList, java.util.List<OptionsCheckRule.OptionWarning> deprecatedList, java.util.List<OptionsCheckRule.OptionWarning> notRecommendedList)
private static boolean checkDeprecatedXX(java.lang.String option, java.lang.String optionName, JavaVersion usedVersion, java.util.List<OptionsCheckRule.OptionWarning> deprecatedList)
private static boolean checkDeprecatedX(java.lang.String option, JavaVersion usedVersion, java.util.List<OptionsCheckRule.OptionWarning> deprecatedList)
private static boolean checkDocumentedXX(java.lang.String option, java.lang.String optionName, JavaVersion usedVersion, java.util.List<java.lang.String> undocumentedList)
private static boolean checkNotRecommended(java.lang.String option, JavaVersion usedVersion, java.util.List<OptionsCheckRule.OptionWarning> notRecommendedList)
public java.util.concurrent.RunnableFuture<IResult> createEvaluation(IItemCollection items, IPreferenceValueProvider valueProvider, IResultValueProvider resultProvider)
IRule
createEvaluation
in interface IRule
items
- items to evaluatevalueProvider
- 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.private IResult getResult(IItemCollection items, IPreferenceValueProvider valueProvider, IResultValueProvider resultProvider)
private java.util.Set<java.lang.String> getUserAcceptedOptions(IPreferenceValueProvider valueProvider)
private java.lang.String composeShortMessage(java.util.List<java.lang.String> undocumentedList, java.util.List<OptionsCheckRule.OptionWarning> deprecatedList, java.util.List<OptionsCheckRule.OptionWarning> notRecommendedList)
public java.util.Collection<TypedPreference<?>> getConfigurationAttributes()
IRule
getConfigurationAttributes
in interface IRule
public java.lang.String getId()
public java.lang.String getName()
public java.lang.String getTopic()
public java.util.Map<java.lang.String,RulesToolkit.EventAvailability> getRequiredEvents()
getRequiredEvents
in interface IRule
RulesToolkit.EventAvailability
this rule
requires for that event typepublic java.util.Collection<TypedResult<?>> getResults()
IRule
IResult
instance.getResults
in interface IRule