Save This Page
Home » commons-chain-1.2-src » org.apache.commons » chain » config » [javadoc | source]
org.apache.commons.chain.config
public class: ConfigParser [javadoc | source]
java.lang.Object
   org.apache.commons.chain.config.ConfigParser

Class to parse the contents of an XML configuration file (using Commons Digester) that defines and configures commands and command chains to be registered in a Catalog . Advanced users can configure the detailed parsing behavior by configuring the properties of an instance of this class prior to calling the parse() method. It is legal to call the parse() method more than once, in order to parse more than one configuration document.

Method from org.apache.commons.chain.config.ConfigParser Summary:
getDigester,   getRuleSet,   getUseContextClassLoader,   parse,   parse,   setRuleSet,   setUseContextClassLoader
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.commons.chain.config.ConfigParser Detail:
 public Digester getDigester() 

    Return the Digester instance to be used for parsing, creating one if necessary.

 public RuleSet getRuleSet() 

    Return the RuleSet to be used for configuring our Digester parsing rules, creating one if necessary.

 public boolean getUseContextClassLoader() 

    Return the "use context class loader" flag. If set to true, Digester will attempt to instantiate new command and chain instances from the context class loader.

 public  void parse(URL url) throws Exception 

    Parse the XML document at the specified URL using the configured RuleSet, registering catalogs with nested chains and commands as they are encountered. Use this method only if you have included one or more factory elements in your configuration resource.

 public  void parse(Catalog catalog,
    URL url) throws Exception 
Deprecated! Use - parse(URL) on a configuration resource with "factory" element(s) embedded

    Parse the XML document at the specified URL, using the configured RuleSet, registering top level commands into the specified Catalog . Use this method only if you have NOT included any factory element in your configuration resource, and wish to supply the catalog explictly.

 public  void setRuleSet(RuleSet ruleSet) 

    Set the RuleSet to be used for configuring our Digester parsing rules.

 public  void setUseContextClassLoader(boolean useContextClassLoader) 

    Set the "use context class loader" flag.