Package javax.servlet.jsp.tagext
Class TagAttributeInfo
java.lang.Object
javax.servlet.jsp.tagext.TagAttributeInfo
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
-
Constructor Summary
ConstructorDescriptionTagAttributeInfo
(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.TagAttributeInfo
(String name, boolean required, String type, boolean reqTime, boolean fragment, String description, boolean deferredValue, boolean deferredMethod, String expectedTypeName, String methodSignature) JSP 2.1 Constructor for TagAttributeInfo. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Whether this attribute can hold a request-time value.Obtain the description for the attribute,Obtain the type name, as a string, expected by this attribute.static TagAttributeInfo
getIdAttribute
(TagAttributeInfo[] tagAttributeInfos) Convenience static method that goes through an array of TagAttributeInfo objects and looks for "id".If this is a deferred method attribute, obtain the expected method signature.getName()
The name of this attribute.The type (as a String) of this attribute.boolean
Does the attribute expect to be passed a deferred method?boolean
Does the attribute expect to be passed a deferred value?boolean
Whether this attribute is of type JspFragment.boolean
Whether this attribute is required.toString()
Returns a String representation of this TagAttributeInfo, suitable for debugging purposes.
-
Field Details
-
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.- See Also:
-
-
Constructor Details
-
TagAttributeInfo
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:
- JSP 2.0
-
TagAttributeInfo
public TagAttributeInfo(String name, boolean required, String type, boolean reqTime, boolean fragment, String description, boolean deferredValue, boolean deferredMethod, String expectedTypeName, String methodSignature) JSP 2.1 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 JspFragmentdescription
- Description of this attributedeferredValue
- Does this attribute accept value expressions (written as Strings) as attribute values the evaluation of which is deferred until calculated by the tagdeferredMethod
- Does this attribute accept method expressions (written as Strings) as attribute values the evaluation of which is deferred until calculated by the tagexpectedTypeName
- The expected type when the deferred value is evaluatedmethodSignature
- The expected method signature if a deferred method- Since:
- JSP 2.1
-
-
Method Details
-
getName
The name of this attribute.- Returns:
- the name of the attribute
-
getTypeName
The type (as a String) of this attribute.- Returns:
- the type of the attribute
-
canBeRequestTime
public boolean canBeRequestTime()Whether this attribute can hold a request-time value.- Returns:
- if the attribute can hold a request-time value.
-
isRequired
public boolean isRequired()Whether this attribute is required.- Returns:
- if the attribute is required.
-
getIdAttribute
Convenience static method that goes through an array of TagAttributeInfo objects and looks for "id".- Parameters:
tagAttributeInfos
- An array of TagAttributeInfo- Returns:
- The TagAttributeInfo reference with name "id"
-
isFragment
public boolean isFragment()Whether this attribute is of type JspFragment.- Returns:
- if the attribute is of type JspFragment
- Since:
- JSP 2.0
-
toString
Returns a String representation of this TagAttributeInfo, suitable for debugging purposes. -
isDeferredMethod
public boolean isDeferredMethod()Does the attribute expect to be passed a deferred method?- Returns:
true
if a deferred method expression is expected, otherwisefalse
-
isDeferredValue
public boolean isDeferredValue()Does the attribute expect to be passed a deferred value?- Returns:
true
if a deferred value expression is expected, otherwisefalse
-
getDescription
Obtain the description for the attribute,- Returns:
- the description
-
getExpectedTypeName
Obtain the type name, as a string, expected by this attribute.- Returns:
- the type name, as a string
-
getMethodSignature
If this is a deferred method attribute, obtain the expected method signature.- Returns:
- The expected method signature or
null
if this attribute is not a deferred method attribute
-