Uses of Interface
net.sourceforge.pmd.Rule

Packages that use Rule

Package	Description
net.sourceforge.pmd	This is the PMD programming mistake detector.
net.sourceforge.pmd.benchmark
net.sourceforge.pmd.cache
net.sourceforge.pmd.lang.dfa
net.sourceforge.pmd.lang.rule
net.sourceforge.pmd.lang.rule.stat
net.sourceforge.pmd.properties
net.sourceforge.pmd.renderers
net.sourceforge.pmd.rules

Uses of Rule in net.sourceforge.pmd

Methods in net.sourceforge.pmd that return Rule

Modifier and Type	Method	Description
Rule	Rule.deepCopy()	Creates a new copy of this rule.
Rule	RuleViolation.getRule()	Get the Rule which identified this violation.
Rule	RuleSet.getRuleByName(java.lang.String ruleName)	Returns the first Rule found with the given name (case-sensitive).
Rule	RuleSets.getRuleByName(java.lang.String ruleName)	Returns the first Rule found with the given name.
Rule	Report.ConfigurationError.rule()	Gets the wrongly configured rule

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

Modifier and Type	Method	Description
java.util.Set<Rule>	RuleSets.getAllRules()	Return all rules from all rulesets.
java.util.Collection<Rule>	RuleSet.getRules()	Returns the actual Collection of rules in this ruleset

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

Modifier and Type	Method	Description
static boolean	RuleSet.applies(Rule rule, LanguageVersion languageVersion)	Does the given Rule apply to the given LanguageVersion? If so, the Language must be the same and be between the minimum and maximums versions on the Rule.
RuleSet	RuleSetFactory.createSingleRuleRuleSet(Rule rule)	Creates a new RuleSet containing a single rule.

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

Modifier and Type	Method	Description
void	RuleSet.removeDysfunctionalRules(java.util.Collection<Rule> collector)	Remove and collect any misconfigured rules.
void	RuleSets.removeDysfunctionalRules(java.util.Collection<Rule> collector)	Remove and collect any rules that report problems.

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

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

Uses of Rule in net.sourceforge.pmd.benchmark

Fields in net.sourceforge.pmd.benchmark declared as Rule

Modifier and Type	Field	Description
Rule	RuleDuration.rule	Deprecated.

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

Constructor	Description
RuleDuration(long elapsed, Rule rule)	Deprecated.

Uses of Rule in net.sourceforge.pmd.cache

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

Modifier and Type	Method	Description
Rule	CachedRuleViolation.getRule()
Rule	CachedRuleMapper.getRuleForClass(java.lang.String className)	Finds a rule instance for the given rule class name

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

Subinterfaces of Rule in net.sourceforge.pmd.lang.dfa

Modifier and Type	Interface	Description
interface	DFAGraphRule

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	AbstractDelegateRule	Deprecated. This is only relevant to RuleReference, but prevents sharing the implementation of AbstractPropertySource.
class	AbstractRule	Basic abstract implementation of all parser-independent methods of the Rule interface.
class	MockRule	This is a Rule implementation which can be used in scenarios where an actual functional Rule is not needed.
class	RuleReference	This class represents a Rule which is a reference to Rule defined in another RuleSet.
class	XPathRule	Rule that tries to match an XPath expression against a DOM view of an AST.

Fields in net.sourceforge.pmd.lang.rule declared as Rule

Modifier and Type	Field	Description
protected Rule	ParametricRuleViolation.rule

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

Modifier and Type	Field	Description
protected java.util.Map<RuleSet,java.util.List<Rule>>	AbstractRuleChainVisitor.ruleSetRules	These are all the rules participating in the RuleChain, grouped by RuleSet.

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

Modifier and Type	Method	Description
Rule	AbstractRule.deepCopy()
Rule	RuleReference.deepCopy()
Rule	AbstractDelegateRule.getRule()	Deprecated.
Rule	ParametricRuleViolation.getRule()

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

Modifier and Type	Method	Description
void	AbstractRuleChainVisitor.add(RuleSet ruleSet, Rule rule)
void	RuleChainVisitor.add(RuleSet ruleSet, Rule rule)	Add the given rule to the visitor.
void	AbstractRuleViolationFactory.addViolation(RuleContext ruleContext, Rule rule, Node node, java.lang.String message, int beginLine, int endLine, java.lang.Object[] args)
void	AbstractRuleViolationFactory.addViolation(RuleContext ruleContext, Rule rule, Node node, java.lang.String message, java.lang.Object[] args)
void	RuleViolationFactory.addViolation(RuleContext ruleContext, Rule rule, Node node, java.lang.String message, int beginLine, int endLine, java.lang.Object[] args)
void	RuleViolationFactory.addViolation(RuleContext ruleContext, Rule rule, Node node, java.lang.String message, java.lang.Object[] args)	Adds a violation to the report.
protected abstract RuleViolation	AbstractRuleViolationFactory.createRuleViolation(Rule rule, RuleContext ruleContext, Node node, java.lang.String message)
protected abstract RuleViolation	AbstractRuleViolationFactory.createRuleViolation(Rule rule, RuleContext ruleContext, Node node, java.lang.String message, int beginLine, int endLine)
void	AbstractDelegateRule.setRule(Rule rule)	Deprecated. This will be removed in 7.0.0 I mark it specially deprecated because it's inherited by rule reference, even though a RuleReference has no business setting its rule after construction
protected abstract void	AbstractRuleChainVisitor.visit(Rule rule, Node node, RuleContext ctx)	Visit the given rule to the given node.

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

Constructor	Description
ParametricRuleViolation(Rule theRule, RuleContext ctx, T node, java.lang.String message)
RuleReference(Rule theRule, RuleSetReference theRuleSetReference)	Create a new reference to the given rule.

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

Subinterfaces of Rule in net.sourceforge.pmd.lang.rule.stat

Modifier and Type	Interface	Description
interface	StatisticalRule	Deprecated. Statistical rules can be implemented much more easily with plain rules, and this framework is confusing and under-documented.

Uses of Rule in net.sourceforge.pmd.properties

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

Modifier and Type	Method	Description
java.lang.String	PropertyDescriptor.propertyErrorFor(Rule rule)	Deprecated. Used nowhere, and fails if the rule doesn't define the property descriptor A better solution will be added on property source

Uses of Rule in net.sourceforge.pmd.renderers

Subinterfaces of Rule in net.sourceforge.pmd.renderers

Modifier and Type	Interface	Description
interface	CodeClimateRule	This interface tags a Rule specifying properties required for the Code Climate output format.

Uses of Rule in net.sourceforge.pmd.rules

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

Modifier and Type	Method	Description
Rule	RuleBuilder.build()
Rule	RuleFactory.buildRule(org.w3c.dom.Element ruleElement)	Parses a rule element and returns a new rule instance.

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

Modifier and Type	Method	Description
RuleReference	RuleFactory.decorateRule(Rule referencedRule, RuleSetReference ruleSetReference, org.w3c.dom.Element ruleElement)	Decorates a referenced rule with the metadata that are overridden in the given rule element.