net.sourceforge.pmd

Class RuleSetFactory

public class RuleSetFactory extends Object

RuleSetFactory is responsible for creating RuleSet instances from XML content.
Method Summary
RuleSetcreateRuleSet(String name, ClassLoader classLoader)
Create a ruleset from a name or from a list of names
RuleSetcreateRuleSet(InputStream inputStream)
Create a RuleSet from an InputStream.
RuleSetcreateRuleSet(InputStream inputStream, ClassLoader classLoader)
Create a RuleSet from an InputStream with a specified ClassLoader.
RuleSetscreateRuleSets(String ruleSetFileNames)
Create a RuleSets from a list of names.
RuleSetscreateRuleSets(String ruleSetFileNames, ClassLoader classLoader)
Create a RuleSets from a list of names with a specified ClassLoader.
RuleSetcreateSingleRuleSet(String ruleSetFileName)
Create a RuleSet from a file name resource.
Iterator<RuleSet>getRegisteredRuleSets()
Returns an Iterator of RuleSet objects loaded from descriptions from the "rulesets.properties" resource.
voidsetMinimumPriority(int minPriority)
Set the minimum rule priority threshold for all Rules which are loaded from RuleSets via reference.

Method Detail

createRuleSet

public RuleSet createRuleSet(String name, ClassLoader classLoader)

Deprecated: Use createRuleSets instead, because this method puts all rules in one single RuleSet object, and thus removes name and language of the originating rule set files.

Create a ruleset from a name or from a list of names

Parameters: name name of rule set file loaded as a resource classLoader the classloader used to load the ruleset and subsequent rules

Returns: the new ruleset

Throws: RuleSetNotFoundException

createRuleSet

public RuleSet createRuleSet(InputStream inputStream)
Create a RuleSet from an InputStream. The ClassLoader of the RuleSetFactory class is used.

Parameters: inputStream InputStream containing the RuleSet XML configuration.

Returns: A new RuleSet.

createRuleSet

public RuleSet createRuleSet(InputStream inputStream, ClassLoader classLoader)
Create a RuleSet from an InputStream with a specified ClassLoader.

Parameters: inputStream InputStream containing the RuleSet XML configuration. classLoader The ClassLoader to load Classes and resources.

Returns: A new RuleSet.

createRuleSets

public RuleSets createRuleSets(String ruleSetFileNames)
Create a RuleSets from a list of names. The ClassLoader of the RuleSetFactory class is used.

Parameters: ruleSetFileNames A comma-separated list of rule set files.

Returns: The new RuleSets.

Throws: RuleSetNotFoundException if unable to find a resource.

createRuleSets

public RuleSets createRuleSets(String ruleSetFileNames, ClassLoader classLoader)
Create a RuleSets from a list of names with a specified ClassLoader.

Parameters: ruleSetFileNames A comma-separated list of rule set files. classLoader The ClassLoader to load Classes and resources.

Returns: The new RuleSets.

Throws: RuleSetNotFoundException if unable to find a resource.

createSingleRuleSet

public RuleSet createSingleRuleSet(String ruleSetFileName)
Create a RuleSet from a file name resource. The ClassLoader of the RuleSetFactory class is used.

Parameters: ruleSetFileName The name of rule set file loaded as a resource.

Returns: A new RuleSet.

Throws: RuleSetNotFoundException if unable to find a resource.

getRegisteredRuleSets

public Iterator<RuleSet> getRegisteredRuleSets()
Returns an Iterator of RuleSet objects loaded from descriptions from the "rulesets.properties" resource.

Returns: An Iterator of RuleSet objects.

setMinimumPriority

public void setMinimumPriority(int minPriority)
Set the minimum rule priority threshold for all Rules which are loaded from RuleSets via reference.

Parameters: minPriority The minimum priority.