javax.servlet.jsp.tagext
Class TagInfo

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagInfo

public class TagInfo
extends Object

Tag information for a tag in a Tag Library; this class is instantiated from the Tag Library Descriptor file (TLD).


Field Summary
static String BODY_CONTENT_EMPTY
          static constant for getBodyContent() when it is empty
static String BODY_CONTENT_JSP
          static constant for getBodyContent() when it is JSP
static String BODY_CONTENT_TAG_DEPENDENT
          static constant for getBodyContent() when it is Tag dependent
 
Constructor Summary
TagInfo(String tagName, String tagClassName, String bodycontent, String infoString, TagLibraryInfo taglib, TagExtraInfo tagExtraInfo, TagAttributeInfo[] attributeInfo)
          Constructor for TagInfo.
 
Method Summary
 TagAttributeInfo[] getAttributes()
          A null return means no information on attributes
 String getBodyContent()
           
 String getInfoString()
           
 String getTagClassName()
          Name of the class that provides the (run-time handler for this tag
 TagExtraInfo getTagExtraInfo()
          The instance (if any) for extra tag information
 TagLibraryInfo getTagLibrary()
           
 String getTagName()
          Tag name
 VariableInfo[] getVariableInfo(TagData data)
          Information on the object created by this tag at runtime.
 boolean isValid(TagData data)
          Translation-time validation of the attributes.
 String toString()
          Stringify for debug purposes...
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

BODY_CONTENT_JSP

public static final String BODY_CONTENT_JSP
static constant for getBodyContent() when it is JSP

BODY_CONTENT_TAG_DEPENDENT

public static final String BODY_CONTENT_TAG_DEPENDENT
static constant for getBodyContent() when it is Tag dependent

BODY_CONTENT_EMPTY

public static final String BODY_CONTENT_EMPTY
static constant for getBodyContent() when it is empty
Constructor Detail

TagInfo

public TagInfo(String tagName,
               String tagClassName,
               String bodycontent,
               String infoString,
               TagLibraryInfo taglib,
               TagExtraInfo tagExtraInfo,
               TagAttributeInfo[] attributeInfo)
Constructor for TagInfo. No public constructor; this class is to be instantiated only from the TagLibrary code under request from some JSP code that is parsing a TLD (Tag Library Descriptor).
Parameters:
tagName - The name of this tag
tagClassName - The name of the tag handler class
bodycontent - Information on the body content of these tags
infoString - The (optional) string information for this tag
taglib - The instance of the tag library that contains us.
tagExtraInfo - The instance providing extra Tag info. May be null
attributeInfo - An array of AttributeInfo data from descriptor. May be null;
Method Detail

getTagName

public String getTagName()
Tag name

getAttributes

public TagAttributeInfo[] getAttributes()
A null return means no information on attributes

getVariableInfo

public VariableInfo[] getVariableInfo(TagData data)
Information on the object created by this tag at runtime. Null means no such object created. Default is null if the tag has no "id" attribute, otherwise, {"id", Object}

isValid

public boolean isValid(TagData data)
Translation-time validation of the attributes. The argument is a translation-time, so request-time attributes are indicated as such.
Parameters:
data - The translation-time TagData instance.

getTagExtraInfo

public TagExtraInfo getTagExtraInfo()
The instance (if any) for extra tag information

getTagClassName

public String getTagClassName()
Name of the class that provides the (run-time handler for this tag

getBodyContent

public String getBodyContent()
Returns:
the body content (hint) string

getInfoString

public String getInfoString()
Returns:
the info string

getTagLibrary

public TagLibraryInfo getTagLibrary()
Returns:
the tab library instance we belong to

toString

public String toString()
Stringify for debug purposes...
Overrides:
toString in class Object