org.apache.velocity.tools.view.servlet
Class ServletToolboxRuleSet

java.lang.Object
  extended by org.apache.commons.digester.RuleSetBase
      extended by org.apache.velocity.tools.view.ToolboxRuleSet
          extended by org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet
All Implemented Interfaces:
org.apache.commons.digester.RuleSet

public class ServletToolboxRuleSet
extends ToolboxRuleSet

The set of Digester rules required to parse a toolbox configuration file (toolbox.xml) for the ServletToolboxManager class.

Since:
VelocityTools 1.1
Version:
$Id: ServletToolboxRuleSet.java 479724 2006-11-27 18:49:37Z nbubna $
Author:
Nathan Bubna

Nested Class Summary
protected  class ServletToolboxRuleSet.BooleanConfigRule
          Abstract rule for configuring boolean options on the parent object/element of the matching element.
protected  class ServletToolboxRuleSet.CreateSessionRule
          Rule that sets setCreateSession() for the top object on the stack, which must be a org.apache.velocity.tools.ServletToolboxManager.
protected  class ServletToolboxRuleSet.XhtmlRule
          Rule that sets setXhtml() for the top object on the stack, which must be a org.apache.velocity.tools.ServletToolboxManager.
 
Nested classes/interfaces inherited from class org.apache.velocity.tools.view.ToolboxRuleSet
ToolboxRuleSet.ParameterRule
 
Field Summary
 
Fields inherited from class org.apache.commons.digester.RuleSetBase
namespaceURI
 
Constructor Summary
ServletToolboxRuleSet()
           
 
Method Summary
 void addRuleInstances(org.apache.commons.digester.Digester digester)
          Overrides ToolboxRuleSet to add create-session rule.
protected  void addToolRules(org.apache.commons.digester.Digester digester)
          Overrides ToolboxRuleSet to add rule for scope element.
protected  java.lang.Class getToolInfoClass()
          Overrides ToolboxRuleSet to use ServletToolInfo class.
 
Methods inherited from class org.apache.velocity.tools.view.ToolboxRuleSet
addDataRules, getDataInfoClass
 
Methods inherited from class org.apache.commons.digester.RuleSetBase
getNamespaceURI
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ServletToolboxRuleSet

public ServletToolboxRuleSet()
Method Detail

addRuleInstances

public void addRuleInstances(org.apache.commons.digester.Digester digester)
Overrides ToolboxRuleSet to add create-session rule.

These rules assume that an instance of org.apache.velocity.tools.view.ServletToolboxManager is pushed onto the evaluation stack before parsing begins.

Specified by:
addRuleInstances in interface org.apache.commons.digester.RuleSet
Overrides:
addRuleInstances in class ToolboxRuleSet
Parameters:
digester - Digester instance to which the new Rule instances should be added.

addToolRules

protected void addToolRules(org.apache.commons.digester.Digester digester)
Overrides ToolboxRuleSet to add rule for scope element.

Overrides:
addToolRules in class ToolboxRuleSet

getToolInfoClass

protected java.lang.Class getToolInfoClass()
Overrides ToolboxRuleSet to use ServletToolInfo class.

Overrides:
getToolInfoClass in class ToolboxRuleSet


Copyright (c) 2003-2007 Apache Software Foundation