|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectnet.sourceforge.pmd.RuleSets
public class RuleSets
Grouping of Rules per Language in a RuleSet.
| Constructor Summary | |
|---|---|
RuleSets()
Public constructor. |
|
RuleSets(RuleSet ruleSet)
Public constructor. |
|
| Method Summary | |
|---|---|
void |
addRuleSet(RuleSet ruleSet)
Add a ruleset for a language. |
boolean |
applies(java.io.File file)
Check if a given source file should be checked by rules in this RuleSets. |
boolean |
applies(Language languageOfSource,
Language languageOfRule)
Check if a source with given language should be checked by rules for a given language. |
void |
apply(java.util.List<CompilationUnit> acuList,
RuleContext ctx,
Language language)
Apply all applicable rules to the compilation units. |
void |
end(RuleContext ctx)
Notify all rules of the end of processing. |
java.util.Set<Rule> |
getAllRules()
Return all rules from all rulesets. |
RuleSet[] |
getAllRuleSets()
Get all the RuleSets. |
Rule |
getRuleByName(java.lang.String ruleName)
Returns the Rule with the given name |
java.util.Iterator<RuleSet> |
getRuleSetsIterator()
|
void |
start(RuleContext ctx)
Notify all rules of the start of processing. |
boolean |
usesDFA(Language language)
Check if the rules that apply to a source of the given language use DFA. |
boolean |
usesTypeResolution(Language language)
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public RuleSets()
public RuleSets(RuleSet ruleSet)
ruleSet - the RuleSet| Method Detail |
|---|
public void addRuleSet(RuleSet ruleSet)
ruleSet - the RuleSetpublic RuleSet[] getAllRuleSets()
public java.util.Iterator<RuleSet> getRuleSetsIterator()
public java.util.Set<Rule> getAllRules()
public boolean applies(java.io.File file)
file - the source file to check
true if the file should be checked, false otherwise
public boolean applies(Language languageOfSource,
Language languageOfRule)
languageOfSource - language of a source; can not be nulllanguageOfRule - language of a ruleset; can be null
public void start(RuleContext ctx)
public void apply(java.util.List<CompilationUnit> acuList,
RuleContext ctx,
Language language)
acuList - the List of compilation units; the type these must have,
depends on the source languagectx - the RuleContextlanguage - the Language of the sourcepublic void end(RuleContext ctx)
public boolean usesDFA(Language language)
language - the language of a source
public Rule getRuleByName(java.lang.String ruleName)
ruleName - the name of the rule to find
public boolean usesTypeResolution(Language language)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||