net.sourceforge.pmd
Class RuleSetFactory

java.lang.Object
  extended bynet.sourceforge.pmd.RuleSetFactory

public class RuleSetFactory
extends java.lang.Object


Constructor Summary
RuleSetFactory()
           
 
Method Summary
 RuleSet createRuleSet(java.io.InputStream inputStream)
          Create a ruleset from an inputsteam.
 RuleSet createRuleSet(java.io.InputStream inputStream, java.lang.ClassLoader classLoader)
          Create a ruleset from an input stream with a specified class loader
 RuleSet createRuleSet(java.lang.String name)
          Creates a ruleset.
 RuleSet createRuleSet(java.lang.String name, java.lang.ClassLoader classLoader)
          Create a ruleset from a name or from a list of name
 java.lang.ClassLoader getClassLoader()
          Return the class loader used to load ruleset resources and rules
 java.util.Iterator getRegisteredRuleSets()
          Returns an Iterator of RuleSet objects loaded from descriptions from the "rulesets.properties" resource or from the "rulesets.filenames" property.
 void setClassLoader(java.lang.ClassLoader loader)
          Sets the class loader used to load ruleset resources and rules
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RuleSetFactory

public RuleSetFactory()
Method Detail

getRegisteredRuleSets

public java.util.Iterator getRegisteredRuleSets()
                                         throws RuleSetNotFoundException
Returns an Iterator of RuleSet objects loaded from descriptions from the "rulesets.properties" resource or from the "rulesets.filenames" property.

Returns:
an iterator on RuleSet objects
Throws:
RuleSetNotFoundException

createRuleSet

public RuleSet createRuleSet(java.lang.String name,
                             java.lang.ClassLoader classLoader)
                      throws RuleSetNotFoundException
Create a ruleset from a name or from a list of name

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(java.lang.String name)
                      throws RuleSetNotFoundException
Creates a ruleset. If passed a comma-delimited string (rulesets/basic.xml,rulesets/unusedcode.xml) it will parse that string and create a new ruleset for each item in the list. Same as createRuleSet(name, ruleSetFactory.getClassLoader()).

Throws:
RuleSetNotFoundException

createRuleSet

public RuleSet createRuleSet(java.io.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(java.io.InputStream inputStream,
                             java.lang.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

getClassLoader

public java.lang.ClassLoader getClassLoader()
Return the class loader used to load ruleset resources and rules

Returns:

setClassLoader

public void setClassLoader(java.lang.ClassLoader loader)
Sets the class loader used to load ruleset resources and rules

Parameters:
loader - a class loader


Copyright © 2002-2004 Project Ultra*Log @ DARPA. All Rights Reserved.