org.apache.velocity.tools
public class Toolbox extends java.lang.Object implements java.io.Serializable
Instances of this class are typically created by a ToolboxFactory
on a one-per-scope basis. So, for each application, there would be one
application-scoped Toolbox from which you would retrieve tool instances,
and for each request, there would be one request-scoped Toolbox.
Of course, none of the above is enforced. There's no reason that you can't
manually create a Toolbox or have multiple Toolboxes for each scope.
When a Toolbox creates a tool instance asked of it (see get(java.lang.String)
),
it will cache that instance for future requests.
Modifier and Type | Field and Description |
---|---|
private java.util.Map<java.lang.String,java.lang.Object> |
cache |
private java.util.Map<java.lang.String,ToolInfo> |
infoMap |
static java.lang.String |
KEY
The key used to place instances in various scopes.
|
private java.util.Map<java.lang.String,java.lang.Object> |
properties |
private static long |
serialVersionUID |
Constructor and Description |
---|
Toolbox(java.util.Map<java.lang.String,ToolInfo> toolInfo) |
Toolbox(java.util.Map<java.lang.String,ToolInfo> toolInfo,
java.util.Map<java.lang.String,java.lang.Object> properties) |
Modifier and Type | Method and Description |
---|---|
protected void |
cacheData(java.util.Map<java.lang.String,java.lang.Object> data) |
Toolbox |
combine(Toolbox... toolboxes)
|
java.lang.Object |
get(java.lang.String key) |
java.lang.Object |
get(java.lang.String key,
java.util.Map<java.lang.String,java.lang.Object> context) |
java.lang.Object |
get(java.lang.String key,
java.lang.String path) |
java.lang.Object |
get(java.lang.String key,
java.lang.String path,
java.util.Map<java.lang.String,java.lang.Object> context) |
java.util.Map<java.lang.String,java.lang.Object> |
getAll(java.util.Map<java.lang.String,java.lang.Object> context) |
protected java.lang.Object |
getFromCache(java.lang.String key,
java.lang.String path) |
protected java.lang.Object |
getFromInfo(java.lang.String key,
java.lang.String path,
java.util.Map<java.lang.String,java.lang.Object> context) |
java.util.Set<java.lang.String> |
getKeys() |
java.util.Map<java.lang.String,java.lang.Object> |
getProperties() |
java.util.Map<java.lang.String,java.lang.Class> |
getToolClassMap()
Return a new
Map link tools' keys to their Class es. |
protected boolean |
hasPermission(ToolInfo info,
java.lang.String path) |
public static final java.lang.String KEY
private static final long serialVersionUID
private java.util.Map<java.lang.String,ToolInfo> infoMap
private java.util.Map<java.lang.String,java.lang.Object> properties
private java.util.Map<java.lang.String,java.lang.Object> cache
public Toolbox(java.util.Map<java.lang.String,ToolInfo> toolInfo)
public Toolbox(java.util.Map<java.lang.String,ToolInfo> toolInfo, java.util.Map<java.lang.String,java.lang.Object> properties)
protected void cacheData(java.util.Map<java.lang.String,java.lang.Object> data)
public java.util.Map<java.lang.String,java.lang.Object> getProperties()
public java.lang.Object get(java.lang.String key)
public java.lang.Object get(java.lang.String key, java.lang.String path)
public java.lang.Object get(java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> context)
public java.lang.Object get(java.lang.String key, java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> context)
protected java.lang.Object getFromCache(java.lang.String key, java.lang.String path)
protected java.lang.Object getFromInfo(java.lang.String key, java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> context)
protected boolean hasPermission(ToolInfo info, java.lang.String path)
public java.util.Set<java.lang.String> getKeys()
public java.util.Map<java.lang.String,java.lang.Class> getToolClassMap()
Map
link tools' keys to their Class
es.
This will not instantiate any tools, it is merely informational.
This will not include the keys for any cached data. Note that inclusion
in this map does NOT mean that all these tools will be available for
all requests, as this map ignores all path restrictions on the tools.public java.util.Map<java.lang.String,java.lang.Object> getAll(java.util.Map<java.lang.String,java.lang.Object> context)
Copyright (c) 2003-2007 Apache Software Foundation