Uses of Interface
net.sourceforge.pmd.lang.rule.Rule

Packages that use Rule

Package	Description
net.sourceforge.pmd.lang.rule	Contains Rule and RuleSet related classes.
net.sourceforge.pmd.lang.rule.impl
net.sourceforge.pmd.lang.rule.xpath
net.sourceforge.pmd.reporting	Logic about reporting: violations, suppression etc.

Uses of Rule in net.sourceforge.pmd.lang.rule

Classes in net.sourceforge.pmd.lang.rule that implement Rule

Modifier and Type	Class	Description
class	AbstractRule	Basic abstract implementation of all parser-independent methods of the Rule interface.
class	AbstractVisitorRule
class	RuleReference	This class represents a Rule which is a reference to Rule defined in another RuleSet.

Methods in net.sourceforge.pmd.lang.rule that return Rule

Modifier and Type	Method	Description
Rule	AbstractRule.deepCopy()
Rule	Rule.deepCopy()	Creates a new copy of this rule.
Rule	RuleReference.deepCopy()
Rule	RuleReference.getRule()
Rule	RuleSet.getRuleByName(String ruleName)	Returns the first Rule found with the given name (case-sensitive).

Methods in net.sourceforge.pmd.lang.rule that return types with arguments of type Rule

Modifier and Type	Method	Description
Collection<Rule>	RuleSet.getRules()	Returns the actual Collection of rules in this ruleset

Methods in net.sourceforge.pmd.lang.rule with parameters of type Rule

Modifier and Type	Method	Description
RuleSet.RuleSetBuilder	RuleSet.RuleSetBuilder.addRule(Rule newRule)	Add a new rule to this ruleset.
RuleSet.RuleSetBuilder	RuleSet.RuleSetBuilder.addRuleByReference(String ruleSetFileName, Rule rule)	Add a new rule by reference to this ruleset.
RuleSet.RuleSetBuilder	RuleSet.RuleSetBuilder.addRuleIfNotExists(Rule ruleOrRef)	Only adds a rule to the ruleset if no rule with the same name for the same language was added before, so that the existent rule configuration won't be overridden.
RuleSet.RuleSetBuilder	RuleSet.RuleSetBuilder.addRuleReplaceIfExists(Rule rule)	Adds a rule.
static RuleSet	RuleSet.forSingleRule(Rule rule)	Creates a new ruleset containing a single rule.
static boolean	InternalApiBridge.ruleSetApplies(Rule rule, LanguageVersion languageVersion)

Method parameters in net.sourceforge.pmd.lang.rule with type arguments of type Rule

Modifier and Type	Method	Description
static RuleSet	RuleSet.create(String name, String description, String fileName, Collection<Pattern> excludePatterns, Collection<Pattern> includePatterns, Iterable<? extends Rule> rules)	Creates a new ruleset with the given metadata such as name, description, fileName, exclude/include patterns are used.
void	RuleSet.removeDysfunctionalRules(Collection<Rule> collector)	Remove and collect any misconfigured rules.
boolean	RuleSet.RuleSetBuilder.removeIf(Predicate<? super Rule> filter)	Remove all rules that matched the predicate.

Constructors in net.sourceforge.pmd.lang.rule with parameters of type Rule

Constructor	Description
RuleReference(Rule theRule, net.sourceforge.pmd.lang.rule.internal.RuleSetReference theRuleSetReference)	Create a new reference to the given rule.

Uses of Rule in net.sourceforge.pmd.lang.rule.impl

Classes in net.sourceforge.pmd.lang.rule.impl that implement Rule

Modifier and Type	Class	Description
class	UnnecessaryPmdSuppressionRule	A rule that reports unused suppression annotations and comments.

Uses of Rule in net.sourceforge.pmd.lang.rule.xpath

Classes in net.sourceforge.pmd.lang.rule.xpath that implement Rule

Modifier and Type	Class	Description
class	XPathRule	Rule that tries to match an XPath expression against a DOM view of an AST.

Methods in net.sourceforge.pmd.lang.rule.xpath that return Rule

Modifier and Type	Method	Description
Rule	XPathRule.deepCopy()

Uses of Rule in net.sourceforge.pmd.reporting

Methods in net.sourceforge.pmd.reporting that return Rule

Modifier and Type	Method	Description
static Rule	InternalApiBridge.getRule(RuleContext ruleContext)
Rule	RuleViolation.getRule()	Get the Rule which identified this violation.
Rule	Report.ConfigurationError.rule()	Gets the wrongly configured rule.

Methods in net.sourceforge.pmd.reporting with parameters of type Rule

Modifier and Type	Method	Description
protected boolean	AbstractAnnotationSuppressor.annotationParamSuppresses(String stringVal, Rule rule)	Return whether one of the annotation params suppresses the given rule.
static RuleContext	InternalApiBridge.createRuleContext(FileAnalysisListener listener, Rule rule)	Create a new RuleContext.
static net.sourceforge.pmd.reporting.ParametricRuleViolation	InternalApiBridge.createRuleViolation(Rule theRule, FileLocation location, String message, Map<String,String> additionalInfo)

Constructors in net.sourceforge.pmd.reporting with parameters of type Rule

Constructor	Description
ConfigurationError(Rule theRule, String theIssue)	Creates a new configuration error for a specific rule.