FileDocCategorySizeDatePackage
TagVariableInfo.javaAPI DocApache Tomcat 6.0.143633Fri Jul 20 04:20:34 BST 2007javax.servlet.jsp.tagext

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.

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

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

	this.nameGiven         = nameGiven;
	this.nameFromAttribute = nameFromAttribute;
	this.className         = className;
	this.declare           = declare;
	this.scope             = scope;
    
Methods Summary
public java.lang.StringgetClassName()
The body of the <variable-class> element.

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

	return className;
    
public booleangetDeclare()
The body of the <declare> element.

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

	return declare;
    
public java.lang.StringgetNameFromAttribute()
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.

return
The attribute whose value defines the variable name

	return nameFromAttribute;
    
public java.lang.StringgetNameGiven()
The body of the <name-given> element.

return
The variable name as a constant

	return nameGiven;
    
public intgetScope()
The body of the <scope> element.

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

	return scope;