|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.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
public class XmlFactoryConfiguration
This reads in configuration info formatted as an XML file
using Commons-Digester
. This uses
XmlFactoryConfigurationRuleSet
as the default set of rules
for processing the XML. However, you may always change this by
passing a new RuleSet
to the setRuleSet(org.apache.commons.digester.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();
Field Summary | |
---|---|
private org.apache.commons.digester.RuleSet |
ruleSet
|
private boolean |
supportOldXml
|
Constructor Summary | |
---|---|
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 | |
---|---|
org.apache.commons.digester.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 an InputStream
and uses it to configure this FactoryConfiguration . |
void |
setRuleSet(org.apache.commons.digester.RuleSet rules)
Sets the RuleSet 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 |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private org.apache.commons.digester.RuleSet ruleSet
private boolean supportOldXml
Constructor Detail |
---|
public XmlFactoryConfiguration()
public XmlFactoryConfiguration(boolean supportOldConfig)
public XmlFactoryConfiguration(java.lang.String id)
id
- the name of the "source" of this instanceFactoryConfiguration.setSource(String)
public XmlFactoryConfiguration(boolean supportOldConfig, java.lang.String id)
supportOldConfig
- whether the old toolbox.xml format should be supportedid
- the name of the "source" of this instanceFactoryConfiguration.setSource(String)
Method Detail |
---|
public void setRuleSet(org.apache.commons.digester.RuleSet rules)
RuleSet
this loader will use to
digest the xml toolbox.
public org.apache.commons.digester.RuleSet getRuleSet()
Retrieves the rule set Digester should use to parse and load the toolbox for this manager.
public void read(java.io.InputStream input) throws java.io.IOException
Reads an XML document from an InputStream
and uses it to configure this FactoryConfiguration
.
read
in class FileFactoryConfiguration
input
- the InputStream to read from
java.io.IOException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |