|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.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 String |
CATCH_EXCEPTIONS_KEY
|
static String |
CONTEXT_KEY
|
static String |
ENGINE_KEY
|
static String |
LOCALE_KEY
|
static String |
LOG_KEY
|
static String |
PATH_KEY
|
Constructor Summary | |
---|---|
ToolContext()
|
|
ToolContext(Map<String,Object> toolProps)
Creates an instance starting with the specified tool properties. |
|
ToolContext(VelocityEngine engine)
Creates an instance that automatically has the specified VelocityEngine and related tool properties set. |
Method Summary | |
---|---|
void |
addToolbox(Toolbox toolbox)
|
boolean |
containsKey(Object key)
|
protected Object |
findTool(String key)
|
Object |
get(String key)
|
Object[] |
getKeys()
|
Map<String,Object> |
getToolbox()
Returns a Map of all tools available to this
context. |
protected List<Toolbox> |
getToolboxes()
|
Map<String,Class> |
getToolClassMap()
Gets a map of keys to classes for all available tools. |
protected Map<String,Object> |
getToolProperties()
|
boolean |
getUserCanOverwriteTools()
Default is true . |
protected Object |
internalGet(String key)
|
Set<String> |
keySet()
|
Object |
put(String key,
Object value)
|
void |
putAll(Map context)
|
void |
putToolProperties(Map<String,Object> props)
|
Object |
putToolProperty(String key,
Object value)
|
void |
putVelocityEngine(VelocityEngine engine)
Puts the specified VelocityEngine in the tool properties, as well as the Log for that engine. |
Object |
remove(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 String PATH_KEY
public static final String CONTEXT_KEY
public static final String ENGINE_KEY
public static final String LOCALE_KEY
public static final String LOG_KEY
public static final String CATCH_EXCEPTIONS_KEY
Constructor Detail |
---|
public ToolContext()
public ToolContext(VelocityEngine engine)
public ToolContext(Map<String,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 Map<String,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 Map<String,Class> getToolClassMap()
protected List<Toolbox> getToolboxes()
protected Map<String,Object> getToolProperties()
public void putVelocityEngine(VelocityEngine engine)
CATCH_EXCEPTIONS_KEY
to false in the tool properties.
public Object putToolProperty(String key, Object value)
public void putToolProperties(Map<String,Object> props)
public Object put(String key, Object value)
put
in interface Context
public Object get(String key)
get
in interface Context
protected Object internalGet(String key)
protected Object findTool(String key)
public Set<String> keySet()
public boolean containsKey(Object key)
containsKey
in interface Context
public Object[] getKeys()
getKeys
in interface Context
public Object remove(Object key)
remove
in interface Context
public void putAll(Map context)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |