Field Detail

• 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

• userOverwrite

  private boolean userOverwrite

Constructor Detail

• ToolContext

  public ToolContext()

• ToolContext

  public ToolContext(VelocityEngine engine)

  Creates an instance that automatically has the specified VelocityEngine and related tool properties set.

Method Detail

• setUserCanOverwriteTools

  public void setUserCanOverwriteTools(boolean overwrite)

  Set whether or not tool references can be overwritten within a template. The default value is true. 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 is true.

  See Also:

  setUserCanOverwriteTools(boolean)

• 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()

• putVelocityEngine

  public void putVelocityEngine(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 set CATCH_EXCEPTIONS_KEY to false in the tool properties.

• putToolProperty

  public java.lang.Object putToolProperty(java.lang.String key,
                                          java.lang.Object value)

• putToolProperties

  public void putToolProperties(java.util.Map<java.lang.String,java.lang.Object> props)

• put

  public java.lang.Object put(java.lang.String key,
                              java.lang.Object value)

• get

  public java.lang.Object get(java.lang.String key)

• 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)

• getKeys

  public java.lang.Object[] getKeys()

• remove

  public java.lang.Object remove(java.lang.Object key)

• putAll

  public void putAll(java.util.Map context)