Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.aendvari.tethys.tag.data
Class TagData  view TagData download TagData.java

java.lang.Object
  extended bycom.aendvari.tethys.tag.data.TagData

public abstract class TagData
extends java.lang.Object

Provides access to tag data. This is an abstract class to provide basic functionality for more specific tag data.

The get/set methods are intentionally named get/setTagData to allow the subclass to wrap them with the name get/setData.


Field Summary
protected static java.lang.String TagDataBase
          Constants for servlet locations of tag data objects.
 
Constructor Summary
TagData()
          Constructs an empty TagData.
 
Method Summary
protected abstract  TagData createObject()
          Returns a new instance of this tag data.
protected abstract  java.lang.String getDataKey()
          Returns the servlet attribute key for this tag data.
protected  TagData getTagData(javax.servlet.http.HttpServletRequest request)
          Returns the tag data that is stored in the request or session.
protected  TagData getTagData(javax.servlet.http.HttpSession session)
          Returns the tag data that is stored in the session.
protected  TagData getTagData(javax.servlet.jsp.PageContext context)
          Returns the tag data that is stored in the page context.
protected  TagData getTagData(javax.servlet.jsp.PageContext context, java.lang.String scope)
          Returns the tag data that is stored in the specified scope.
protected  TagData getTagData(javax.servlet.ServletContext context)
          Returns the tag data that is stored in the servlet context.
protected  void setTagData(javax.servlet.http.HttpServletRequest request, TagData data)
          Sets the tag data in the request.
protected  void setTagData(javax.servlet.http.HttpSession session, TagData data)
          Sets the tag data in the session.
protected  void setTagData(javax.servlet.jsp.PageContext context, java.lang.String scope, TagData data)
          Sets the tag data into the specified scope.
protected  void setTagData(javax.servlet.ServletContext context, TagData data)
          Sets the tag data in the servlet context.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TagDataBase

protected static final java.lang.String TagDataBase
Constants for servlet locations of tag data objects.

See Also:
Constant Field Values
Constructor Detail

TagData

public TagData()
Constructs an empty TagData.

Method Detail

getDataKey

protected abstract java.lang.String getDataKey()
Returns the servlet attribute key for this tag data. This method is to be implemented by subclasses.


createObject

protected abstract TagData createObject()
Returns a new instance of this tag data. This method is to be implemented by subclasses.


getTagData

protected TagData getTagData(javax.servlet.http.HttpServletRequest request)
Returns the tag data that is stored in the request or session. If one does not exist, a new instance is created and stored.


getTagData

protected TagData getTagData(javax.servlet.http.HttpSession session)
Returns the tag data that is stored in the session. If one does not exist, a new instance is created and stored.


getTagData

protected TagData getTagData(javax.servlet.ServletContext context)
Returns the tag data that is stored in the servlet context. If one does not exist, a new instance is created and stored.


getTagData

protected TagData getTagData(javax.servlet.jsp.PageContext context)
Returns the tag data that is stored in the page context. If one does not exist, a new instance is created and stored.


getTagData

protected TagData getTagData(javax.servlet.jsp.PageContext context,
                             java.lang.String scope)
Returns the tag data that is stored in the specified scope. If one does not exist, a new instance is created and stored.


setTagData

protected void setTagData(javax.servlet.http.HttpServletRequest request,
                          TagData data)
Sets the tag data in the request.


setTagData

protected void setTagData(javax.servlet.http.HttpSession session,
                          TagData data)
Sets the tag data in the session.


setTagData

protected void setTagData(javax.servlet.ServletContext context,
                          TagData data)
Sets the tag data in the servlet context.


setTagData

protected void setTagData(javax.servlet.jsp.PageContext context,
                          java.lang.String scope,
                          TagData data)
Sets the tag data into the specified scope.