FileDocCategorySizeDatePackage
TagAttributeInfo.javaAPI DocApache Tomcat 6.0.146966Fri Jul 20 04:20:32 BST 2007javax.servlet.jsp.tagext

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.

Fields Summary
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.
private String
name
private String
type
private boolean
reqTime
private boolean
required
private boolean
fragment
private String
description
private boolean
deferredValue
private boolean
deferredMethod
private String
expectedTypeName
private String
methodSignature
Constructors Summary
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).

param
name The name of the attribute.
param
required If this attribute is required in tag instances.
param
type The name of the type of the attribute.
param
reqTime Whether this attribute holds a request-time Attribute.


                                                                                                                      

          
              
        this.name = name;
        this.required = required;
        this.type = type;
        this.reqTime = reqTime;
    
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).

param
name The name of the attribute.
param
required If this attribute is required in tag instances.
param
type The name of the type of the attribute.
param
reqTime Whether this attribute holds a request-time Attribute.
param
fragment Whether this attribute is of type JspFragment
since
2.0

        this(name, required, type, reqTime);
        this.fragment = fragment;
    
public TagAttributeInfo(String name, boolean required, String type, boolean reqTime, boolean fragment, String description, boolean deferredValue, boolean deferredMethod, String expectedTypeName, String methodSignature)

since
JSP 2.1

        this(name, required, type, reqTime, fragment);
        this.description = description;
        this.deferredValue = deferredValue;
        this.deferredMethod = deferredMethod;
        this.expectedTypeName = expectedTypeName;
        this.methodSignature = methodSignature;
    
Methods Summary
public booleancanBeRequestTime()
Whether this attribute can hold a request-time value.

return
if the attribute can hold a request-time value.

        return reqTime;
    
public java.lang.StringgetDescription()

        return description;
    
public java.lang.StringgetExpectedTypeName()

        return expectedTypeName;
    
public static javax.servlet.jsp.tagext.TagAttributeInfogetIdAttribute(javax.servlet.jsp.tagext.TagAttributeInfo[] a)
Convenience static method that goes through an array of TagAttributeInfo objects and looks for "id".

param
a An array of TagAttributeInfo
return
The TagAttributeInfo reference with name "id"

        for (int i = 0; i < a.length; i++) {
            if (a[i].getName().equals(ID)) {
                return a[i];
            }
        }
        return null; // no such attribute
    
public java.lang.StringgetMethodSignature()

        return methodSignature;
    
public java.lang.StringgetName()
The name of this attribute.

return
the name of the attribute

        return name;
    
public java.lang.StringgetTypeName()
The type (as a String) of this attribute.

return
the type of the attribute

        return type;
    
public booleanisDeferredMethod()

        return deferredMethod;
    
public booleanisDeferredValue()

        return deferredValue;
    
public booleanisFragment()
Whether this attribute is of type JspFragment.

return
if the attribute is of type JspFragment
since
2.0

        return fragment;
    
public booleanisRequired()
Whether this attribute is required.

return
if the attribute is required.

        return required;
    
public java.lang.StringtoString()
Returns a String representation of this TagAttributeInfo, suitable for debugging purposes.

return
a String representation of this TagAttributeInfo

        StringBuffer b = new StringBuffer(64);
        b.append("name = " + name + " ");
        b.append("type = " + type + " ");
        b.append("reqTime = " + reqTime + " ");
        b.append("required = " + required + " ");
        b.append("fragment = " + fragment + " ");
        b.append("deferredValue = " + deferredValue + " ");
        b.append("expectedTypeName = " + expectedTypeName + " ");
        b.append("deferredMethod = " + deferredMethod + " ");
        b.append("methodSignature = " + methodSignature);
        return b.toString();