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:
java.lang.Comparable<Configuration>
public class ToolboxConfiguration extends CompoundConfiguration<ToolConfiguration>
This class handles configuration info for the Toolbox instances that will eventually be produced by
ToolboxFactory
. It containsToolConfiguration
s for tools which will be managed by those toolboxes, as well the toolboxes' scope and any otherProperty
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 Modifier and Type Field Description private java.lang.String
scope
-
Constructor Summary
Constructors Constructor Description ToolboxConfiguration()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addTool(ToolConfiguration tool)
int
compareTo(Configuration conf)
boolean
equals(java.lang.Object obj)
java.lang.String
getScope()
ToolConfiguration
getTool(java.lang.String key)
java.util.Collection<ToolConfiguration>
getTools()
int
hashCode()
void
removeTool(ToolConfiguration tool)
void
setScope(java.lang.String scope)
void
setTools(java.util.Collection<ToolConfiguration> tools)
java.lang.String
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
-
-
-
-
Method Detail
-
setScope
public void setScope(java.lang.String scope)
-
getScope
public java.lang.String getScope()
-
addTool
public void addTool(ToolConfiguration tool)
-
removeTool
public void removeTool(ToolConfiguration tool)
-
getTool
public ToolConfiguration getTool(java.lang.String key)
-
getTools
public java.util.Collection<ToolConfiguration> getTools()
-
setTools
public void setTools(java.util.Collection<ToolConfiguration> tools)
-
validate
public void validate()
- Overrides:
validate
in classCompoundConfiguration<ToolConfiguration>
-
compareTo
public int compareTo(Configuration conf)
- Specified by:
compareTo
in interfacejava.lang.Comparable<Configuration>
- Overrides:
compareTo
in classConfiguration
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classCompoundConfiguration<ToolConfiguration>
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classCompoundConfiguration<ToolConfiguration>
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-