Package org.apache.velocity.tools.config
Class ToolboxConfiguration
java.lang.Object
org.apache.velocity.tools.config.Configuration
org.apache.velocity.tools.config.CompoundConfiguration<ToolConfiguration>
org.apache.velocity.tools.config.ToolboxConfiguration
- All Implemented Interfaces:
Comparable<Configuration>
This class handles configuration info for the Toolbox instances
that will eventually be produced by ToolboxFactory
.
It contains ToolConfiguration
s for tools which will be managed
by those toolboxes, as well the toolboxes' scope and
any other Property
s which you intend to be available
to all the tools in the toolbox.
Most users will not find themselves directly using the API of this class.
NOTE: Two instances of this class are considered equal() if their scopes are equal. This is not the intuitive behavior at this level but is done to facilitate intuitive behavior in the higher APIs, which are much more likely to be used directly.
- Version:
- $Id: ToolboxConfiguration.java 511959 2007-02-26 19:24:39Z nbubna $
- Author:
- Nathan Bubna
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addTool
(ToolConfiguration tool) int
compareTo
(Configuration conf) boolean
getScope()
getTools()
int
hashCode()
void
removeTool
(ToolConfiguration tool) void
void
setTools
(Collection<ToolConfiguration> tools) toString()
void
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, getProperties, getProperty, getPropertyMap, hasProperties, removeProperty, removeProperty, setProperties, setProperty, setPropertyMap
-
Field Details
-
scope
-
-
Constructor Details
-
ToolboxConfiguration
public ToolboxConfiguration()
-
-
Method Details
-
setScope
-
getScope
-
addTool
-
removeTool
-
getTool
-
getTools
-
setTools
-
validate
public void validate()- Overrides:
validate
in classCompoundConfiguration<ToolConfiguration>
-
compareTo
- Specified by:
compareTo
in interfaceComparable<Configuration>
- Overrides:
compareTo
in classConfiguration
-
hashCode
public int hashCode()- Overrides:
hashCode
in classCompoundConfiguration<ToolConfiguration>
-
equals
- Overrides:
equals
in classCompoundConfiguration<ToolConfiguration>
-
toString
-