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

java.lang.Object
  org.apache.velocity.tools.view.ViewToolInfo
      org.apache.velocity.tools.view.servlet.ServletToolInfo

All Implemented Interfaces:

ToolInfo

public class ServletToolInfo

extends ViewToolInfo

ToolInfo implementation that holds scope information for tools used in a servlet environment. The ServletToolboxManager uses this to allow tool definitions to specify the scope/lifecycle of individual view tools.

Example of toolbox.xml definitions for servlet tools:

  <tool>
    <key>link</key>
    <scope>request</scope>
    <class>org.apache.velocity.tools.struts.StrutsLinkTool</class>
  </tool>
  <tool>
    <key>math</key>
    <scope>application</scope>
    <class>org.apache.velocity.tools.generic.MathTool</class>
  </tool>
  <tool>
    <key>user</key>
    <scope>session</scope>
    <class>com.mycompany.tools.MyUserTool</class>
  </tool>
  

Version:

$Id: ServletToolInfo.java 72030 2004-03-12 20:50:38Z nbubna $

Author:

Nathan Bubna

Field Summary

private java.lang.String

scope

Fields inherited from class org.apache.velocity.tools.view.ViewToolInfo

LOG

Constructor Summary

ServletToolInfo()

Method Summary

java.lang.String	getScope()
void	setScope(java.lang.String scope)

Methods inherited from class org.apache.velocity.tools.view.ViewToolInfo

getApplicationClass, getClassname, getInstance, getKey, getParameters, setClassname, setKey, setParameter, setParameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

scope

private java.lang.String scope

Constructor Detail

ServletToolInfo

public ServletToolInfo()

Method Detail

setScope

public void setScope(java.lang.String scope)

getScope

public java.lang.String getScope()

Returns:

the scope of the tool