|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sourceforge.pmd.RuleSetFactory
public class RuleSetFactory
RuleSetFactory is responsible for creating RuleSet instances from XML content.
By default Rules will be loaded using the ClassLoader for this class, using
the RulePriority.LOW
priority, with Rule deprecation warnings off.
Constructor Summary | |
---|---|
RuleSetFactory()
|
Method Summary | |
---|---|
RuleSet |
createRuleSet(RuleSetReferenceId ruleSetReferenceId)
Create a RuleSet from a RuleSetReferenceId. |
RuleSet |
createRuleSet(String referenceString)
Create a RuleSet from a RuleSet reference ID string. |
RuleSets |
createRuleSets(List<RuleSetReferenceId> ruleSetReferenceIds)
Create a RuleSets from a list of RuleSetReferenceIds. |
RuleSets |
createRuleSets(String referenceString)
Create a RuleSets from a comma separated list of RuleSet reference IDs. |
Iterator<RuleSet> |
getRegisteredRuleSets()
Returns an Iterator of RuleSet objects loaded from descriptions from the "rulesets.properties" resource for each Language with Rule support. |
void |
setClassLoader(ClassLoader classLoader)
Set the ClassLoader to use when loading Rules. |
void |
setMinimumPriority(RulePriority minimumPriority)
Set the minimum rule priority threshold for all Rules which are loaded from RuleSets via reference. |
void |
setWarnDeprecated(boolean warnDeprecated)
Set whether warning messages should be logged for usage of deprecated Rules. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RuleSetFactory()
Method Detail |
---|
public void setClassLoader(ClassLoader classLoader)
classLoader
- The ClassLoader to use.public void setMinimumPriority(RulePriority minimumPriority)
minimumPriority
- The minimum priority.public void setWarnDeprecated(boolean warnDeprecated)
warnDeprecated
- true
to log warning messages.public Iterator<RuleSet> getRegisteredRuleSets() throws RuleSetNotFoundException
RuleSetNotFoundException
public RuleSets createRuleSets(String referenceString) throws RuleSetNotFoundException
RuleSetReferenceId.parse(String)
, and then calls
createRuleSets(List)
.
The currently configured ClassLoader is used.
referenceString
- A comma separated list of RuleSet reference IDs.
RuleSetNotFoundException
- if unable to find a resource.public RuleSets createRuleSets(List<RuleSetReferenceId> ruleSetReferenceIds) throws RuleSetNotFoundException
ruleSetReferenceIds
- The List of RuleSetReferenceId of the RuleSets to create.
RuleSetNotFoundException
- if unable to find a resource.public RuleSet createRuleSet(String referenceString) throws RuleSetNotFoundException
RuleSetReferenceId.parse(String)
, gets the first
item in the List, and then calls createRuleSet(RuleSetReferenceId)
.
The currently configured ClassLoader is used.
referenceString
- A comma separated list of RuleSet reference IDs.
RuleSetNotFoundException
- if unable to find a resource.public RuleSet createRuleSet(RuleSetReferenceId ruleSetReferenceId) throws RuleSetNotFoundException
ruleSetReferenceId
- The RuleSetReferenceId of the RuleSet to create.
RuleSetNotFoundException
- if unable to find a resource.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |