Package | Description |
---|---|
org.apache.velocity.tools | |
org.apache.velocity.tools.config | |
org.apache.velocity.tools.view |
Contains tools and supporting infrastructure for using
those tools in a servlet environment as well as general
use classes to support use of Velocity as (or in) the
view layer of web applications.
|
Modifier and Type | Method and Description |
---|---|
protected FactoryConfiguration |
ToolManager.findConfig(String path) |
Modifier and Type | Method and Description |
---|---|
void |
ToolManager.configure(FactoryConfiguration config) |
void |
ToolboxFactory.configure(FactoryConfiguration config) |
Modifier and Type | Class and Description |
---|---|
class |
EasyFactoryConfiguration
FactoryConfiguration subclass that simplifies the process of
configuring a ToolboxFactory in Java without the use of an
xml or properties configuration file. |
class |
FileFactoryConfiguration
Provides support for reading a configuration file from a specified path,
This frees the user from having to obtain an InputStream themselves.
|
class |
PropertiesFactoryConfiguration
This reads in configuration info formatted as a property
file using
ExtendedProperties from Commons-Collections. |
class |
XmlFactoryConfiguration
This reads in configuration info formatted as an XML file
using Commons-
Digester . |
Modifier and Type | Method and Description |
---|---|
static FactoryConfiguration |
ConfigurationUtils.find(String path)
Searches for a configuration file at the specified path and returns
it in the form of a
FactoryConfiguration . |
static FactoryConfiguration |
ConfigurationUtils.findFromSystemProperty()
Returns a
FactoryConfiguration loaded from the path specified
in the "org.apache.velocity.tools" system property (if any). |
static FactoryConfiguration |
ConfigurationUtils.findInClasspath(String path) |
static FactoryConfiguration |
ConfigurationUtils.findInClasspath(String path,
Object caller)
Searches the classpath for a configuration file matching the
specified path.
|
static FactoryConfiguration |
ConfigurationUtils.findInFileSystem(String path)
Searches the file system for a configuration file matching the
specified path.
|
static FactoryConfiguration |
ConfigurationUtils.getAutoLoaded()
Returns a
FactoryConfiguration including all
ConfigurationUtils.getDefaultTools() as well as any tools that can be
automatically loaded from "tools.xml" or "tools.properties" found
at the root of the classpath or in the current directory. |
static FactoryConfiguration |
ConfigurationUtils.getAutoLoaded(boolean includeDefaults)
Returns a
FactoryConfiguration composed, in order of the
following configurations:
ConfigurationUtils.getDefaultTools() (only if includeDefaults is true )
All "tools.xml" configurations found in the classpath root, in the order found
All "tools.properties" configurations found in the classpath root, in the order found
The "tools.xml" file in the current directory (if any)
The "tools.properties" file in the current directory (if any)
If the includeDefaults parameter is null and no such files described above
can be found, then the configuration returned by this method will be
empty, but it should never be null . |
static FactoryConfiguration |
ConfigurationUtils.getDefaultTools()
Returns the "default"
FactoryConfiguration . |
static FactoryConfiguration |
ConfigurationUtils.getFromClass(Class factory) |
static FactoryConfiguration |
ConfigurationUtils.getFromClass(String classname) |
static FactoryConfiguration |
ConfigurationUtils.getGenericTools()
Returns a
FactoryConfiguration including all default
"GenericTools" available and no others. |
static FactoryConfiguration |
ConfigurationUtils.getVelocityStruts()
Returns a
FactoryConfiguration including all default
"VelocityStruts" tools available as well as the default "VelocityView"
tools and "GenericTools". |
static FactoryConfiguration |
ConfigurationUtils.getVelocityView()
Returns a
FactoryConfiguration including all default
"VelocityView" tools available as well as the default "GenericTools". |
static FactoryConfiguration |
ConfigurationUtils.load(String path)
Returns a
FactoryConfiguration loaded from a configuration file
at the specified path. |
static FactoryConfiguration |
ConfigurationUtils.read(URL url)
Returns a
FactoryConfiguration read from a known configuration
file type at the specified URL . |
Modifier and Type | Method and Description |
---|---|
void |
FactoryConfiguration.addConfiguration(FactoryConfiguration config) |
void |
ConfigurationCleaner.clean(FactoryConfiguration factory) |
abstract void |
OldXmlFactoryConfigurationRuleSet.BooleanConfigRule.setBoolean(FactoryConfiguration parent,
Boolean value) |
void |
OldXmlFactoryConfigurationRuleSet.CreateSessionRule.setBoolean(FactoryConfiguration factory,
Boolean b) |
void |
OldXmlFactoryConfigurationRuleSet.XhtmlRule.setBoolean(FactoryConfiguration factory,
Boolean b) |
Modifier and Type | Method and Description |
---|---|
protected FactoryConfiguration |
ViewToolManager.findConfig(String path) |
static FactoryConfiguration |
ServletUtils.getConfiguration(javax.servlet.ServletContext application) |
protected FactoryConfiguration |
VelocityView.getConfiguration(String path) |
protected FactoryConfiguration |
VelocityView.getConfiguration(String path,
boolean required) |
static FactoryConfiguration |
ServletUtils.getConfiguration(String path,
javax.servlet.ServletContext application) |
static FactoryConfiguration |
ServletUtils.getConfiguration(String path,
javax.servlet.ServletContext application,
boolean deprecationSupportMode) |
protected FactoryConfiguration |
VelocityView.getDeprecatedConfig(JeeConfig config)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
void |
ViewToolManager.configure(FactoryConfiguration config) |
Copyright © 2002–2016 Apache Software Foundation. All rights reserved.