Java 2 Platform EE v1.3: Class TagVariableInfo - Java Platform, Enterprise Edition v1.3.1 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.servlet.jsp.tagext
Class TagVariableInfo

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagVariableInfo

public class TagVariableInfo
extends java.lang.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

Constructor Summary

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

Method Summary

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

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

java.lang.String getNameFromAttribute()
          The body of the <name-from-attribute> element.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TagVariableInfo

public TagVariableInfo(java.lang.String nameGiven,
                       java.lang.String nameFromAttribute,
                       java.lang.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

getNameGiven

public java.lang.String getNameGiven()

The body of the <name-given> element

Returns:: The variable name as a constant

getNameFromAttribute

public java.lang.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

getClassName

public java.lang.String getClassName()

The body of the <variable-class> element.

Returns:: The name of the class of the variable

getDeclare

public boolean getDeclare()

The body of the <declare> element

Returns:: Whether the variable is to be declared or not

getScope

public int getScope()

The body of the <scope> element

Returns:: The scope to give the variable.