Package org.apache.velocity.tools.config
Class FileFactoryConfiguration
- 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
-
- All Implemented Interfaces:
java.lang.Comparable<Configuration>
- Direct Known Subclasses:
PropertiesFactoryConfiguration
,XmlFactoryConfiguration
public abstract class FileFactoryConfiguration extends FactoryConfiguration
Provides support for reading a configuration file from a specified path, This frees the user from having to obtain an InputStream themselves.- Version:
- $Id: XmlFactoryConfiguration.java 511959 2007-02-26 19:24:39Z nbubna $
- Author:
- Nathan Bubna
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
FileFactoryConfiguration(java.lang.Class clazz, java.lang.String id)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected java.net.URL
findURL(java.lang.String path)
abstract void
read(java.io.InputStream input)
Reads an configuration from anInputStream
.protected void
read(java.lang.Object source, java.io.InputStream inputStream, boolean required, org.apache.velocity.runtime.log.Log log)
void
read(java.lang.String path)
Reads a configuration file from the specified file path and sets up the configuration from that.void
read(java.lang.String path, boolean required)
void
read(java.lang.String path, boolean required, org.apache.velocity.runtime.log.Log log)
void
read(java.net.URL url)
void
read(java.net.URL url, boolean required)
protected void
read(java.net.URL url, boolean required, org.apache.velocity.runtime.log.Log log)
-
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
-
-
-
-
Method Detail
-
read
public abstract void read(java.io.InputStream input) throws java.io.IOException
Reads an configuration from an
InputStream
.- Parameters:
input
- the InputStream to read from- Throws:
java.io.IOException
-
read
public void read(java.lang.String path)
Reads a configuration file from the specified file path and sets up the configuration from that. If the file does not exist, a
ResourceNotFoundException
will be thrown.- Parameters:
path
- the path to the file to be read from
-
read
public void read(java.net.URL url)
-
read
public void read(java.lang.String path, boolean required)
-
read
public void read(java.net.URL url, boolean required)
-
read
public void read(java.lang.String path, boolean required, org.apache.velocity.runtime.log.Log log)
-
findURL
protected java.net.URL findURL(java.lang.String path)
-
read
protected void read(java.net.URL url, boolean required, org.apache.velocity.runtime.log.Log log)
-
read
protected void read(java.lang.Object source, java.io.InputStream inputStream, boolean required, org.apache.velocity.runtime.log.Log log)
-
-