Package 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
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
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionToolContext
(Map<String, 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
Modifier and TypeMethodDescriptionvoid
addToolbox
(Toolbox toolbox) boolean
containsKey
(Object key) protected Object
Object[]
getKeys()
Returns aMap
of all tools available to this context.Gets a map of keys to classes for all available tools.boolean
Default istrue
.protected Object
internalGet
(String key) keySet()
void
void
putToolProperties
(Map<String, Object> props) putToolProperty
(String key, 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.void
setUserCanOverwriteTools
(boolean overwrite) Set whether or not tool references can be overwritten within a template.
-
Field Details
-
PATH_KEY
- See Also:
-
CONTEXT_KEY
- See Also:
-
ENGINE_KEY
- See Also:
-
LOCALE_KEY
- See Also:
-
LOG_KEY
- See Also:
-
CATCH_EXCEPTIONS_KEY
- See Also:
-
toolboxes
-
toolProps
-
localContext
-
userOverwrite
private boolean userOverwrite
-
-
Constructor Details
-
ToolContext
public ToolContext() -
ToolContext
public ToolContext(org.apache.velocity.app.VelocityEngine engine) Creates an instance that automatically has the specified VelocityEngine and related tool properties set. -
ToolContext
Creates an instance starting with the specified tool properties.
-
-
Method Details
-
setUserCanOverwriteTools
public void setUserCanOverwriteTools(boolean overwrite) Set whether or not tool references can be overwritten within a template. The default value istrue
. Set this to false if you want to ensure that your tool references are never replaced within the course of a template. -
getUserCanOverwriteTools
public boolean getUserCanOverwriteTools()Default istrue
.- See Also:
-
addToolbox
-
getToolbox
Returns aMap
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
Gets a map of keys to classes for all available tools. This does not include any data nor any local context values. -
getToolboxes
-
getToolProperties
-
putVelocityEngine
public void putVelocityEngine(org.apache.velocity.app.VelocityEngine engine) Puts the specified VelocityEngine in the tool properties, as well as the Log for that engine. Last, if the specified engine has a MethodExceptionEventHandler configured, then this will automatically setCATCH_EXCEPTIONS_KEY
to false in the tool properties. -
putToolProperty
-
putToolProperties
-
put
- Specified by:
put
in interfaceorg.apache.velocity.context.Context
-
get
- Specified by:
get
in interfaceorg.apache.velocity.context.Context
-
internalGet
-
findTool
-
keySet
-
containsKey
- Specified by:
containsKey
in interfaceorg.apache.velocity.context.Context
-
getKeys
- Specified by:
getKeys
in interfaceorg.apache.velocity.context.Context
-
remove
- Specified by:
remove
in interfaceorg.apache.velocity.context.Context
-
putAll
-