|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.velocity.tools.ToolContext
public class ToolContext
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.
Field Summary | |
---|---|
static java.lang.String |
CATCH_EXCEPTIONS_KEY
|
static java.lang.String |
CONTEXT_KEY
|
static java.lang.String |
ENGINE_KEY
|
private java.util.Map<java.lang.String,java.lang.Object> |
localContext
|
static java.lang.String |
LOCALE_KEY
|
static java.lang.String |
LOG_KEY
|
static java.lang.String |
PATH_KEY
|
private java.util.List<Toolbox> |
toolboxes
|
private java.util.Map<java.lang.String,java.lang.Object> |
toolProps
|
private boolean |
userOverwrite
|
Constructor Summary | |
---|---|
ToolContext()
|
|
ToolContext(java.util.Map<java.lang.String,java.lang.Object> toolProps)
Creates an instance starting with the specified tool properties. |
|
ToolContext(org.apache.velocity.app.VelocityEngine engine)
Creates an instance that automatically has the specified VelocityEngine and related tool properties set. |
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()
|
boolean |
getUserCanOverwriteTools()
Default is true . |
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)
|
void |
putAll(java.util.Map context)
|
void |
putToolProperties(java.util.Map<java.lang.String,java.lang.Object> props)
|
java.lang.Object |
putToolProperty(java.lang.String key,
java.lang.Object value)
|
void |
putVelocityEngine(org.apache.velocity.app.VelocityEngine engine)
Puts the specified VelocityEngine in the tool properties, as well as the Log for that engine. |
java.lang.Object |
remove(java.lang.Object key)
|
void |
setUserCanOverwriteTools(boolean overwrite)
Set whether or not tool references can be overwritten within a template. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PATH_KEY
public static final java.lang.String CONTEXT_KEY
public static final java.lang.String ENGINE_KEY
public static final java.lang.String LOCALE_KEY
public static final java.lang.String LOG_KEY
public static final java.lang.String CATCH_EXCEPTIONS_KEY
private java.util.List<Toolbox> toolboxes
private java.util.Map<java.lang.String,java.lang.Object> toolProps
private java.util.Map<java.lang.String,java.lang.Object> localContext
private boolean userOverwrite
Constructor Detail |
---|
public ToolContext()
public ToolContext(org.apache.velocity.app.VelocityEngine engine)
public ToolContext(java.util.Map<java.lang.String,java.lang.Object> toolProps)
Method Detail |
---|
public void setUserCanOverwriteTools(boolean overwrite)
true
. Set this to false if you want to
ensure that your tool references are never replaced within the course
of a template.
public boolean getUserCanOverwriteTools()
true
.
setUserCanOverwriteTools(boolean)
public void addToolbox(Toolbox toolbox)
public java.util.Map<java.lang.String,java.lang.Object> getToolbox()
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.
public java.util.Map<java.lang.String,java.lang.Class> getToolClassMap()
protected java.util.List<Toolbox> getToolboxes()
protected java.util.Map<java.lang.String,java.lang.Object> getToolProperties()
public void putVelocityEngine(org.apache.velocity.app.VelocityEngine engine)
CATCH_EXCEPTIONS_KEY
to false in the tool properties.
public java.lang.Object putToolProperty(java.lang.String key, java.lang.Object value)
public void putToolProperties(java.util.Map<java.lang.String,java.lang.Object> props)
public java.lang.Object put(java.lang.String key, java.lang.Object value)
put
in interface org.apache.velocity.context.Context
public java.lang.Object get(java.lang.String key)
get
in interface org.apache.velocity.context.Context
protected java.lang.Object internalGet(java.lang.String key)
protected java.lang.Object findTool(java.lang.String key)
public java.util.Set<java.lang.String> keySet()
public boolean containsKey(java.lang.Object key)
containsKey
in interface org.apache.velocity.context.Context
public java.lang.Object[] getKeys()
getKeys
in interface org.apache.velocity.context.Context
public java.lang.Object remove(java.lang.Object key)
remove
in interface org.apache.velocity.context.Context
public void putAll(java.util.Map context)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |