net.sourceforge.pmd

Class RuleSetFactory

java.lang.Object

net.sourceforge.pmd.RuleSetFactory

public class RuleSetFactory
extends Object

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. By default, the ruleset compatibility filter is active, too. See RuleSetFactoryCompatibility.

Constructor Summary

Constructors

Constructor and Description
RuleSetFactory()
RuleSetFactory(ClassLoader classLoader, RulePriority minimumPriority, boolean warnDeprecated, boolean enableCompatibility)
RuleSetFactory(RuleSetFactory factory, boolean warnDeprecated) Constructor copying all configuration from another factory.

Method Summary

Methods

Modifier and Type	Method and Description
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.
RuleSet	createSingleRuleRuleSet(Rule rule) Creates a new RuleSet for a single rule
Iterator<RuleSet>	getRegisteredRuleSets() Returns an Iterator of RuleSet objects loaded from descriptions from the "rulesets.properties" resource for each Language with Rule support.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RuleSetFactory

public RuleSetFactory()

RuleSetFactory

public RuleSetFactory(ClassLoader classLoader,
              RulePriority minimumPriority,
              boolean warnDeprecated,
              boolean enableCompatibility)

RuleSetFactory

public RuleSetFactory(RuleSetFactory factory,
              boolean warnDeprecated)

Constructor copying all configuration from another factory.

Parameters:

factory - The factory whose configuration to copy.

warnDeprecated - Whether deprecation warnings are to be produced by this factory.

Method Detail

getRegisteredRuleSets

public Iterator<RuleSet> getRegisteredRuleSets()
                                        throws RuleSetNotFoundException

Returns an Iterator of RuleSet objects loaded from descriptions from the "rulesets.properties" resource for each Language with Rule support.

Returns:

An Iterator of RuleSet objects.

Throws:

RuleSetNotFoundException - if the ruleset file could not be found

createRuleSets

public RuleSets createRuleSets(String referenceString)
                        throws RuleSetNotFoundException

Create a RuleSets from a comma separated list of RuleSet reference IDs. This is a convenience method which calls RuleSetReferenceId.parse(String), and then calls createRuleSets(List). The currently configured ClassLoader is used.

Parameters:

referenceString - A comma separated list of RuleSet reference IDs.

Returns:

The new RuleSets.

Throws:

RuleSetNotFoundException - if unable to find a resource.

createRuleSets

public RuleSets createRuleSets(List<RuleSetReferenceId> ruleSetReferenceIds)
                        throws RuleSetNotFoundException

Create a RuleSets from a list of RuleSetReferenceIds. The currently configured ClassLoader is used.

Parameters:

ruleSetReferenceIds - The List of RuleSetReferenceId of the RuleSets to create.

Returns:

The new RuleSets.

Throws:

RuleSetNotFoundException - if unable to find a resource.

createRuleSet

public RuleSet createRuleSet(String referenceString)
                      throws RuleSetNotFoundException

Create a RuleSet from a RuleSet reference ID string. This is a convenience method which calls RuleSetReferenceId.parse(String), gets the first item in the List, and then calls createRuleSet(RuleSetReferenceId). The currently configured ClassLoader is used.

Parameters:

referenceString - A comma separated list of RuleSet reference IDs.

Returns:

A new RuleSet.

Throws:

RuleSetNotFoundException - if unable to find a resource.

createRuleSet

public RuleSet createRuleSet(RuleSetReferenceId ruleSetReferenceId)
                      throws RuleSetNotFoundException

Create a RuleSet from a RuleSetReferenceId. Priority filtering is ignored when loading a single Rule. The currently configured ClassLoader is used.

Parameters:

ruleSetReferenceId - The RuleSetReferenceId of the RuleSet to create.

Returns:

A new RuleSet.

Throws:

RuleSetNotFoundException - if unable to find a resource.

createSingleRuleRuleSet

public RuleSet createSingleRuleRuleSet(Rule rule)

Creates a new RuleSet for a single rule

Parameters:

rule - The rule being created

Returns:

The newly created RuleSet