javax.servlet.jsp.tagext

Class TagAttributeInfo

java.lang.Object

javax.servlet.jsp.tagext.TagAttributeInfo

public class TagAttributeInfo
extends java.lang.Object

Information about tag attributes. This information comes from the Tag Library Descriptor (TLD). Generally, a TagExtraInfo class will grab this information from the TagLibraryInfo class.

 <tag>
   <name>foo</name>
   <tagclass>com.caucho.tags.FooTag</tagclass>

   <attribute>
     <name>bar</name>
     <required>true</required>
     <rtexprvalue>false</rtexprvalue>
 </tag>
 

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ID ID is "id"

Constructor Summary

Constructors

Constructor and Description
TagAttributeInfo(java.lang.String name, boolean required, java.lang.String type, boolean reqTime) Creates a new TagAttributeInfo object.
TagAttributeInfo(java.lang.String name, boolean required, java.lang.String type, boolean reqTime, boolean fragment) Creates a new TagAttributeInfo object.
TagAttributeInfo(java.lang.String name, boolean required, java.lang.String type, boolean reqTime, boolean fragment, java.lang.String description, boolean deferredValue, boolean deferredMethod, java.lang.String expectedTypeName, java.lang.String methodSignature) Creates a new TagAttributeInfo object.

Method Summary

Modifier and Type	Method and Description
boolean	canBeRequestTime() Returns true if the attribute can be a request time attribute (<%= ...
java.lang.String	getDescription() Returns the tag's description.
java.lang.String	getExpectedTypeName() Returns the expected type of the attribute.
static TagAttributeInfo	getIdAttribute(TagAttributeInfo[] a) Convenience for finding a TagAttributeInfo in a TagAttributeInfo array.
java.lang.String	getMethodSignature() Returns the expected method signature.
java.lang.String	getName() Returns the attribute name
java.lang.String	getTypeName() Returns the type name of the attribute.
boolean	isDeferredMethod() Returns true if the attribute is deferred.
boolean	isDeferredValue() Returns true if the attribute is deferred.
boolean	isFragment() True if the attribute is of type fragment
boolean	isRequired() True if the attribute must exist in the tag.

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final java.lang.String ID

ID is "id"

See Also:

Constant Field Values

Constructor Detail

TagAttributeInfo

public TagAttributeInfo(java.lang.String name,
                        boolean required,
                        java.lang.String type,
                        boolean reqTime)

Creates a new TagAttributeInfo object. Only the JSP engine will call this. It's not intended to be a public constructor.

Parameters:

name - the name of the attribute

required - true if the attribute must be present in the tag

reqTime - true if the attribute can be a request time attribute

type - the Java type of the attribute

TagAttributeInfo

public TagAttributeInfo(java.lang.String name,
                        boolean required,
                        java.lang.String type,
                        boolean reqTime,
                        boolean fragment)

Creates a new TagAttributeInfo object. Only the JSP engine will call this. It's not intended to be a public constructor.

Parameters:

name - the name of the attribute

required - true if the attribute must be present in the tag

reqTime - true if the attribute can be a request time attribute

type - the Java type of the attribute

TagAttributeInfo

public TagAttributeInfo(java.lang.String name,
                        boolean required,
                        java.lang.String type,
                        boolean reqTime,
                        boolean fragment,
                        java.lang.String description,
                        boolean deferredValue,
                        boolean deferredMethod,
                        java.lang.String expectedTypeName,
                        java.lang.String methodSignature)

Creates a new TagAttributeInfo object. Only the JSP engine will call this. It's not intended to be a public constructor.

Parameters:

name - the name of the attribute

required - true if the attribute must be present in the tag

reqTime - true if the attribute can be a request time attribute

type - the Java type of the attribute

Method Detail

getName

public java.lang.String getName()

Returns the attribute name

getTypeName

public java.lang.String getTypeName()

Returns the type name of the attribute.

canBeRequestTime

public boolean canBeRequestTime()

Returns true if the attribute can be a request time attribute (<%= ... %>).

isRequired

public boolean isRequired()

True if the attribute must exist in the tag.

isFragment

public boolean isFragment()

True if the attribute is of type fragment

getDescription

public java.lang.String getDescription()

Returns the tag's description.

Since:

JSP 2.1

getExpectedTypeName

public java.lang.String getExpectedTypeName()

Returns the expected type of the attribute.

Since:

JSP 2.1

getMethodSignature

public java.lang.String getMethodSignature()

Returns the expected method signature.

Since:

JSP 2.1

isDeferredMethod

public boolean isDeferredMethod()

Returns true if the attribute is deferred.

Since:

JSP 2.1

isDeferredValue

public boolean isDeferredValue()

Returns true if the attribute is deferred.

Since:

JSP 2.1

getIdAttribute

public static TagAttributeInfo getIdAttribute(TagAttributeInfo[] a)

Convenience for finding a TagAttributeInfo in a TagAttributeInfo array.