Package jakarta.servlet.jsp.tagext
Class TagAttributeInfo
java.lang.Object
jakarta.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 SummaryFields
- 
Constructor SummaryConstructorsConstructorDescriptionTagAttributeInfo(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 SummaryModifier and TypeMethodDescriptionbooleanWhether 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 TagAttributeInfogetIdAttribute(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.booleanDoes the attribute expect to be passed a deferred method?booleanDoes the attribute expect to be passed a deferred value?booleanWhether this attribute is of type JspFragment.booleanWhether 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- 
TagAttributeInfoConstructor 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.
 
- 
TagAttributeInfopublic 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
 
- 
TagAttributeInfopublic 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 JspFragment
- description- Description of this attribute
- deferredValue- Does this attribute accept value expressions (written as Strings) as attribute values the evaluation of which is deferred until calculated by the tag
- deferredMethod- Does this attribute accept method expressions (written as Strings) as attribute values the evaluation of which is deferred until calculated by the tag
- expectedTypeName- The expected type when the deferred value is evaluated
- methodSignature- The expected method signature if a deferred method
- Since:
- JSP 2.1
 
 
- 
- 
Method Details- 
getNameThe name of this attribute.- Returns:
- the name of the attribute
 
- 
getTypeNameThe type (as a String) of this attribute.- Returns:
- the type of the attribute
 
- 
canBeRequestTimepublic boolean canBeRequestTime()Whether this attribute can hold a request-time value.- Returns:
- if the attribute can hold a request-time value.
 
- 
isRequiredpublic boolean isRequired()Whether this attribute is required.- Returns:
- if the attribute is required.
 
- 
getIdAttributeConvenience 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"
 
- 
isFragmentpublic boolean isFragment()Whether this attribute is of type JspFragment.- Returns:
- if the attribute is of type JspFragment
- Since:
- JSP 2.0
 
- 
toStringReturns a String representation of this TagAttributeInfo, suitable for debugging purposes.
- 
isDeferredMethodpublic boolean isDeferredMethod()Does the attribute expect to be passed a deferred method?- Returns:
- trueif a deferred method expression is expected, otherwise- false
 
- 
isDeferredValuepublic boolean isDeferredValue()Does the attribute expect to be passed a deferred value?- Returns:
- trueif a deferred value expression is expected, otherwise- false
 
- 
getDescriptionObtain the description for the attribute,- Returns:
- the description
 
- 
getExpectedTypeNameObtain the type name, as a string, expected by this attribute.- Returns:
- the type name, as a string
 
- 
getMethodSignatureIf this is a deferred method attribute, obtain the expected method signature.- Returns:
- The expected method signature or nullif this attribute is not a deferred method attribute
 
 
-