public class RuleSetFactory extends Object
RulePriority.LOW
priority, with Rule deprecation
warnings off. By default, the ruleset compatibility filter is active, too.
See RuleSetFactoryCompatibility
.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.
|
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.
|
public RuleSetFactory()
public RuleSetFactory(ClassLoader classLoader, RulePriority minimumPriority, boolean warnDeprecated, boolean enableCompatibility)
public RuleSetFactory(RuleSetFactory factory, boolean warnDeprecated)
factory
- The factory whose configuration to copy.warnDeprecated
- Whether deprecation warnings are to be produced by this
factory.public Iterator<RuleSet> getRegisteredRuleSets() throws RuleSetNotFoundException
RuleSetNotFoundException
- if the ruleset file could not be foundpublic 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.Copyright © 2002–2017 PMD. All rights reserved.