javax.servlet.jsp.tagext

Class TagVariableInfo

public class TagVariableInfo extends Object

Variable information for a tag in a Tag Library; This class is instantiated from the Tag Library Descriptor file (TLD) and is available only at translation time. This object should be immutable. This information is only available in JSP 1.2 format TLDs or above.
Constructor Summary
TagVariableInfo(String nameGiven, String nameFromAttribute, String className, boolean declare, int scope)
Constructor for TagVariableInfo.
Method Summary
StringgetClassName()
The body of the <variable-class> element.
booleangetDeclare()
The body of the <declare> element.
StringgetNameFromAttribute()
The body of the <name-from-attribute> element.
StringgetNameGiven()
The body of the <name-given> element.
intgetScope()
The body of the <scope> element.

Constructor Detail

TagVariableInfo

public TagVariableInfo(String nameGiven, String nameFromAttribute, String className, boolean declare, int scope)
Constructor for TagVariableInfo.

Parameters: nameGiven value of <name-given> nameFromAttribute value of <name-from-attribute> className value of <variable-class> declare value of <declare> scope value of <scope>

Method Detail

getClassName

public String getClassName()
The body of the <variable-class> element.

Returns: The name of the class of the variable or 'java.lang.String' if not defined in the TLD.

getDeclare

public boolean getDeclare()
The body of the <declare> element.

Returns: Whether the variable is to be declared or not. If not defined in the TLD, 'true' will be returned.

getNameFromAttribute

public String getNameFromAttribute()
The body of the <name-from-attribute> element. This is the name of an attribute whose (translation-time) value will give the name of the variable. One of <name-given> or <name-from-attribute> is required.

Returns: The attribute whose value defines the variable name

getNameGiven

public String getNameGiven()
The body of the <name-given> element.

Returns: The variable name as a constant

getScope

public int getScope()
The body of the <scope> element.

Returns: The scope to give the variable. NESTED scope will be returned if not defined in the TLD.

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