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 |
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 |
private static java.lang.String |
RESULT_ID |
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<Result> |
evaluate(IItemCollection items,
IPreferenceValueProvider valueProvider)
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() |
private Result |
getResult(IItemCollection items,
IPreferenceValueProvider valueProvider) |
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 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<Result> evaluate(IItemCollection items, IPreferenceValueProvider valueProvider)
IRule
evaluate
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()
.private Result getResult(IItemCollection items, IPreferenceValueProvider valueProvider)
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()