javax.servlet.jsp.tagext

Class TagAttributeInfo

public class TagAttributeInfo extends Object

Information on the attributes of a Tag, available at translation time. This class is instantiated from the Tag Library Descriptor file (TLD).

Only the information needed to generate code is included here. Other information like SCHEMA for validation belongs elsewhere.

Field Summary
static StringID
"id" is wired in to be ID.
Constructor Summary
TagAttributeInfo(String name, boolean required, String type, boolean reqTime)
Constructor for TagAttributeInfo.
TagAttributeInfo(String name, boolean required, String type, boolean reqTime, boolean fragment)
JSP 2.0 Constructor for TagAttributeInfo.
Method Summary
booleancanBeRequestTime()
Whether this attribute can hold a request-time value.
static TagAttributeInfogetIdAttribute(TagAttributeInfo[] a)
Convenience static method that goes through an array of TagAttributeInfo objects and looks for "id".
StringgetName()
The name of this attribute.
StringgetTypeName()
The type (as a String) of this attribute.
booleanisFragment()
Whether this attribute is of type JspFragment.
booleanisRequired()
Whether this attribute is required.
StringtoString()
Returns a String representation of this TagAttributeInfo, suitable for debugging purposes.

Field Detail

ID

public static final String ID
"id" is wired in to be ID. There is no real benefit in having it be something else IDREFs are not handled any differently.

Constructor Detail

TagAttributeInfo

public TagAttributeInfo(String name, boolean required, String type, boolean reqTime)
Constructor for TagAttributeInfo. 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: name The name of the attribute. required If this attribute is required in tag instances. type The name of the type of the attribute. reqTime Whether this attribute holds a request-time Attribute.

TagAttributeInfo

public TagAttributeInfo(String name, boolean required, String type, boolean reqTime, boolean fragment)
JSP 2.0 Constructor for TagAttributeInfo. 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: name The name of the attribute. required If this attribute is required in tag instances. type The name of the type of the attribute. reqTime Whether this attribute holds a request-time Attribute. fragment Whether this attribute is of type JspFragment

Since: 2.0

Method Detail

canBeRequestTime

public boolean canBeRequestTime()
Whether this attribute can hold a request-time value.

Returns: if the attribute can hold a request-time value.

getIdAttribute

public static TagAttributeInfo getIdAttribute(TagAttributeInfo[] a)
Convenience static method that goes through an array of TagAttributeInfo objects and looks for "id".

Parameters: a An array of TagAttributeInfo

Returns: The TagAttributeInfo reference with name "id"

getName

public String getName()
The name of this attribute.

Returns: the name of the attribute

getTypeName

public String getTypeName()
The type (as a String) of this attribute.

Returns: the type of the attribute

isFragment

public boolean isFragment()
Whether this attribute is of type JspFragment.

Returns: if the attribute is of type JspFragment

Since: 2.0

isRequired

public boolean isRequired()
Whether this attribute is required.

Returns: if the attribute is required.

toString

public String toString()
Returns a String representation of this TagAttributeInfo, suitable for debugging purposes.

Returns: a String representation of this TagAttributeInfo

Copyright © 2004 Mortbay Consulting Pty. Ltd. All Rights Reserved.