Class ToolContext

java.lang.Object
org.apache.velocity.tools.ToolContext
All Implemented Interfaces:
org.apache.velocity.context.Context
public class ToolContext extends Object implements org.apache.velocity.context.Context
Context implementation that keeps a list of Toolboxes 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 Details

  • 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.
      Parameters:
      engine - VelocityEngine instance

    • ToolContext

      public ToolContext(Map<String,Object> toolProps)
      Creates an instance starting with the specified tool properties.
      Parameters:
      toolProps - tools properties

  • Method Details

    • 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.
      Parameters:
      overwrite - flag value

    • getUserCanOverwriteTools

      public boolean getUserCanOverwriteTools()
      Default is true.
      Returns:
      flag value
      See Also:

    • addToolbox

      public void addToolbox(Toolbox toolbox)

    • getToolbox

      public Map<String,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.
      Returns:
      aggregated toolbox of all available tools

    • getToolClassMap

      public Map<String,Class> getToolClassMap()
      Gets a map of keys to classes for all available tools. This does not include any data nor any local context values.
      Returns:
      aggregated map of all available tools classes

    • getToolboxes

      protected List<Toolbox> getToolboxes()

    • getToolProperties

      protected Map<String,Object> 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 set CATCH_EXCEPTIONS_KEY to false in the tool properties.
      Parameters:
      engine - VelocityEngine instance

    • putToolProperty

      public Object putToolProperty(String key, Object value)

    • putToolProperties

      public void putToolProperties(Map<String,Object> props)

    • put

      public Object put(String key, Object value)
      Specified by:
      put in interface org.apache.velocity.context.Context

    • get

      public Object get(String key)
      Specified by:
      get in interface org.apache.velocity.context.Context

    • internalGet

      protected Object internalGet(String key)

    • findTool

      protected Object findTool(String key)

    • keySet

      public Set<String> keySet()

    • containsKey

      public boolean containsKey(String key)
      Specified by:
      containsKey in interface org.apache.velocity.context.Context

    • getKeys

      public String[] getKeys()
      Specified by:
      getKeys in interface org.apache.velocity.context.Context

    • remove

      public Object remove(String key)
      Specified by:
      remove in interface org.apache.velocity.context.Context

    • putAll

      public void putAll(Map context)