Class ToolboxFactory

java.lang.Object
org.apache.velocity.tools.ToolboxFactory
public class ToolboxFactory extends Object

This class is the central point of action for VelocityTools. It manages the configured and scoped ToolInfo and Data and is meant to stick around for the life of the application.

It works like this:

  1. Build up your FactoryConfiguration(s)
  2. Create a ToolboxFactory instance
  3. Pass the configuration to configure(FactoryConfiguration)
  4. When appropriate for each scope, use createToolbox(String) to create the Toolbox for that scope and put that toolbox somewhere appropriate to that scope.
  5. When you want a tool, get that Toolbox and ask it for the tool you want (e.g. toolbox.get("math")).

Of course, most users will not have to do any of this as much of it is handled for them by some combination of ToolManager or org.apache.velocity.tools.view.VelocityView and a ToolContext or org.apache.velocity.tools.view.ViewToolContext.

NOTE: While you are free to pass in new configuration info at any time, that data will only affect Toolboxes created subsequently. Any previously created toolboxes will have to be re-created and replaced to reflect the changes to the configuration.

Version:
$Id: ToolboxFactory.java 511959 2007-02-26 19:24:39Z nbubna $
Author:
Nathan Bubna