Package org.apache.velocity.tools.config
Class XmlFactoryConfiguration
- java.lang.Object
-
- org.apache.velocity.tools.config.Configuration
-
- org.apache.velocity.tools.config.CompoundConfiguration<ToolboxConfiguration>
-
- org.apache.velocity.tools.config.FactoryConfiguration
-
- org.apache.velocity.tools.config.FileFactoryConfiguration
-
- org.apache.velocity.tools.config.XmlFactoryConfiguration
-
- All Implemented Interfaces:
java.lang.Comparable<Configuration>
public class XmlFactoryConfiguration extends FileFactoryConfiguration
This reads in configuration info formatted as an XML file using Commons-
Digester
. This usesXmlFactoryConfigurationRuleSet
as the default set of rules for processing the XML. However, you may always change this by passing a newRuleSet
to thesetRuleSet(RuleSet)
method. See the configuration documentation on the main web site for instructions on the XML format supported by the default rules.Example usage:
FactoryConfiguration cfg = new XmlFactoryConfiguration("Dev Tools"); cfg.read("devtools.xml"); ToolboxFactory factory = cfg.createFactory();
- Version:
- $Id: XmlFactoryConfiguration.java 511959 2007-02-26 19:24:39Z nbubna $
- Author:
- Nathan Bubna
-
-
Field Summary
Fields Modifier and Type Field Description private RuleSet
ruleSet
private boolean
supportOldXml
-
Constructor Summary
Constructors Constructor Description XmlFactoryConfiguration()
XmlFactoryConfiguration(boolean supportOldConfig)
XmlFactoryConfiguration(boolean supportOldConfig, java.lang.String id)
Creates an instance using the specified string as an identifier to distinguish this instance when debugging and using the specified setting for supporting the old toolbox.xml format from VelocityTools 1.x.XmlFactoryConfiguration(java.lang.String id)
Creates an instance using the specified string as an identifier to distinguish this instance when debugging.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RuleSet
getRuleSet()
Retrieves the rule set Digester should use to parse and load the toolbox for this manager.void
read(java.io.InputStream input)
Reads an XML document from anInputStream
and uses it to configure thisFactoryConfiguration
.void
setRuleSet(RuleSet rules)
Sets theRuleSet
this loader will use to digest the xml toolbox.-
Methods inherited from class org.apache.velocity.tools.config.FileFactoryConfiguration
findURL, read, read, read, read, read, read, read
-
Methods inherited from class org.apache.velocity.tools.config.FactoryConfiguration
addConfiguration, addData, addSource, addToolbox, createFactory, equals, getData, getData, getData, getSource, getSources, getToolbox, getToolboxes, hasData, hashCode, removeData, removeToolbox, setData, setSource, setToolboxes, toString, toString, validate
-
Methods inherited from class org.apache.velocity.tools.config.CompoundConfiguration
addChild, addConfiguration, appendChildren, getChild, getChildren, hasChildren, removeChild, setChildren
-
Methods inherited from class org.apache.velocity.tools.config.Configuration
addConfiguration, addProperty, appendProperties, compareTo, getProperties, getProperty, getPropertyMap, hasProperties, removeProperty, removeProperty, setProperties, setProperty, setPropertyMap
-
-
-
-
Constructor Detail
-
XmlFactoryConfiguration
public XmlFactoryConfiguration()
-
XmlFactoryConfiguration
public XmlFactoryConfiguration(boolean supportOldConfig)
-
XmlFactoryConfiguration
public XmlFactoryConfiguration(java.lang.String id)
Creates an instance using the specified string as an identifier to distinguish this instance when debugging.- Parameters:
id
- the name of the "source" of this instance- See Also:
FactoryConfiguration.setSource(String)
-
XmlFactoryConfiguration
public XmlFactoryConfiguration(boolean supportOldConfig, java.lang.String id)
Creates an instance using the specified string as an identifier to distinguish this instance when debugging and using the specified setting for supporting the old toolbox.xml format from VelocityTools 1.x.- Parameters:
supportOldConfig
- whether the old toolbox.xml format should be supportedid
- the name of the "source" of this instance- See Also:
FactoryConfiguration.setSource(String)
-
-
Method Detail
-
setRuleSet
public void setRuleSet(RuleSet rules)
Sets theRuleSet
this loader will use to digest the xml toolbox.
-
getRuleSet
public RuleSet getRuleSet()
Retrieves the rule set Digester should use to parse and load the toolbox for this manager.
-
read
public void read(java.io.InputStream input) throws java.io.IOException
Reads an XML document from an
InputStream
and uses it to configure thisFactoryConfiguration
.- Specified by:
read
in classFileFactoryConfiguration
- Parameters:
input
- the InputStream to read from- Throws:
java.io.IOException
-
-