net.sourceforge.pmd

Class RuleSetFactory

public class RuleSetFactory extends Object

BSD-style license; for more info see http://pmd.sourceforge.net/license.html
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 inputsteam.
RuleSetcreateRuleSet(InputStream inputStream, ClassLoader classLoader)
Create a ruleset from an input stream with a specified class loader
RuleSetscreateRuleSets(String ruleSetFileNames, ClassLoader classLoader)
Create a RuleSets from a list of names.
RuleSetscreateRuleSets(String ruleSetFileNames)
Create a RuleSets from a list of names, using the classloader of this class.
RuleSetcreateSingleRuleSet(String ruleSetFileName)
Create a ruleset from a name
Iterator<RuleSet>getRegisteredRuleSets()
Returns an Iterator of RuleSet objects loaded from descriptions from the "rulesets.properties" resource.
voidsetMinimumPriority(int minPriority)

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 inputsteam. Same as createRuleSet(inputStream, ruleSetFactory.getClassLoader()).

Parameters: inputStream an input stream that contains a ruleset descripion

Returns: a new ruleset

createRuleSet

public RuleSet createRuleSet(InputStream inputStream, ClassLoader classLoader)
Create a ruleset from an input stream with a specified class loader

Parameters: inputStream an input stream that contains a ruleset descripion classLoader a class loader used to load rule classes

Returns: a new ruleset

createRuleSets

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

Parameters: ruleSetFileNames comma-separated list of rule set files. classLoader the classloader to load the rulesets

Throws: RuleSetNotFoundException

createRuleSets

public RuleSets createRuleSets(String ruleSetFileNames)
Create a RuleSets from a list of names, using the classloader of this class.

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

Throws: RuleSetNotFoundException

createSingleRuleSet

public RuleSet createSingleRuleSet(String ruleSetFileName)
Create a ruleset from a name

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

Returns: the new ruleset

Throws: RuleSetNotFoundException

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)