net.sourceforge.pmd

Class RuleSet

public class RuleSet extends Object

This class represents a collection of rules.

See Also: Rule

Method Summary
void	addRule(Rule rule) Add a new rule to this ruleset
void	addRuleSet(RuleSet ruleSet) Add a whole RuleSet to this RuleSet
void	apply(List acuList, RuleContext ctx)
boolean	equals(Object o)
String	getDescription()
Language	getLanguage()
String	getName()
Rule	getRuleByName(String ruleName) Returns the Rule with the given name
Collection<Rule>	getRules() Returns the actual Collection of rules in this ruleset
int	hashCode()
void	setDescription(String description)
void	setLanguage(Language language)
void	setName(String name)
int	size() Returns the number of rules in this ruleset
boolean	usesDFA()
boolean	usesTypeResolution()

Method Detail

addRule

public void addRule(Rule rule)

Add a new rule to this ruleset

Parameters: rule the rule to be added

addRuleSet

public void addRuleSet(RuleSet ruleSet)

Add a whole RuleSet to this RuleSet

Parameters: ruleSet the RuleSet to add

apply

public void apply(List acuList, RuleContext ctx)

equals

public boolean equals(Object o)

See Also: java.lang.Object#equals(java.lang.Object)

getDescription

public String getDescription()

getLanguage

public Language getLanguage()

getName

public String getName()

getRuleByName

public Rule getRuleByName(String ruleName)

Returns the Rule with the given name

Parameters: ruleName the name of the rule to find

Returns: the rule or null if not found

getRules

public Collection<Rule> getRules()

Returns the actual Collection of rules in this ruleset

Returns: a Collection with the rules. All objects are of type Rule

hashCode

public int hashCode()

See Also: java.lang.Object#hashCode()

setDescription

public void setDescription(String description)

setLanguage

public void setLanguage(Language language)

setName

public void setName(String name)

size

public int size()

Returns the number of rules in this ruleset

Returns: an int representing the number of rules

usesDFA

public boolean usesDFA()

Returns: true if any rule in the RuleSet needs the DFA layer

usesTypeResolution

public boolean usesTypeResolution()