org.apache.velocity.tools
Class ToolContext
java.lang.Object
org.apache.velocity.tools.ToolContext
- All Implemented Interfaces:
- org.apache.velocity.context.Context
- Direct Known Subclasses:
- ViewToolContext
public class ToolContext
- extends java.lang.Object
- implements org.apache.velocity.context.Context
Context
implementation that keeps a list of Toolbox
es
and returns them as requested, using its internal context Map as the
dynamic properties passed to the requested tools when they are first
created.
- Version:
- $Id: ToolContext.java 511959 2007-02-26 19:24:39Z nbubna $
- Author:
- Nathan Bubna
Method Summary |
void |
addToolbox(Toolbox toolbox)
|
boolean |
containsKey(java.lang.Object key)
|
protected java.lang.Object |
findTool(java.lang.String key)
|
java.lang.Object |
get(java.lang.String key)
|
java.lang.Object[] |
getKeys()
|
java.util.Map<java.lang.String,java.lang.Object> |
getToolbox()
Returns a Map of all tools available to this
context. |
protected java.util.List<Toolbox> |
getToolboxes()
|
java.util.Map<java.lang.String,java.lang.Class> |
getToolClassMap()
Gets a map of keys to classes for all available tools. |
protected java.util.Map<java.lang.String,java.lang.Object> |
getToolProperties()
|
protected java.lang.Object |
internalGet(java.lang.String key)
|
java.util.Set<java.lang.String> |
keySet()
|
java.lang.Object |
put(java.lang.String key,
java.lang.Object value)
|
java.lang.Object |
putToolProperty(java.lang.String key,
java.lang.Object value)
|
java.lang.Object |
remove(java.lang.Object key)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PATH_KEY
public static final java.lang.String PATH_KEY
- See Also:
- Constant Field Values
CONTEXT_KEY
public static final java.lang.String CONTEXT_KEY
- See Also:
- Constant Field Values
ENGINE_KEY
public static final java.lang.String ENGINE_KEY
- See Also:
- Constant Field Values
LOCALE_KEY
public static final java.lang.String LOCALE_KEY
- See Also:
- Constant Field Values
LOG_KEY
public static final java.lang.String LOG_KEY
- See Also:
- Constant Field Values
CATCH_EXCEPTIONS_KEY
public static final java.lang.String CATCH_EXCEPTIONS_KEY
- See Also:
- Constant Field Values
toolboxes
private java.util.List<Toolbox> toolboxes
toolProps
private java.util.Map<java.lang.String,java.lang.Object> toolProps
localContext
private java.util.Map<java.lang.String,java.lang.Object> localContext
ToolContext
public ToolContext(org.apache.velocity.app.VelocityEngine engine)
ToolContext
public ToolContext(java.util.Map<java.lang.String,java.lang.Object> toolProps)
ToolContext
public ToolContext(Toolbox toolbox)
ToolContext
public ToolContext(java.util.Map<java.lang.String,java.lang.Object> toolProps,
Toolbox toolbox)
addToolbox
public void addToolbox(Toolbox toolbox)
getToolbox
public java.util.Map<java.lang.String,java.lang.Object> getToolbox()
- Returns a
Map
of all tools available to this
context. NOTE: this is not a cheap operation as it will
request and initialize an instance of every available tool.
getToolClassMap
public java.util.Map<java.lang.String,java.lang.Class> getToolClassMap()
- Gets a map of keys to classes for all available tools.
This does not include any data nor any local context values.
getToolboxes
protected java.util.List<Toolbox> getToolboxes()
getToolProperties
protected java.util.Map<java.lang.String,java.lang.Object> getToolProperties()
putToolProperty
public java.lang.Object putToolProperty(java.lang.String key,
java.lang.Object value)
put
public java.lang.Object put(java.lang.String key,
java.lang.Object value)
- Specified by:
put
in interface org.apache.velocity.context.Context
get
public java.lang.Object get(java.lang.String key)
- Specified by:
get
in interface org.apache.velocity.context.Context
internalGet
protected java.lang.Object internalGet(java.lang.String key)
findTool
protected java.lang.Object findTool(java.lang.String key)
keySet
public java.util.Set<java.lang.String> keySet()
containsKey
public boolean containsKey(java.lang.Object key)
- Specified by:
containsKey
in interface org.apache.velocity.context.Context
getKeys
public java.lang.Object[] getKeys()
- Specified by:
getKeys
in interface org.apache.velocity.context.Context
remove
public java.lang.Object remove(java.lang.Object key)
- Specified by:
remove
in interface org.apache.velocity.context.Context
Copyright (c) 2003-2007 Apache Software Foundation