TagLibraryInfo (Java 2 Platform Ent. Ed. v1.4) - Java Platform, Enterprise Edition v1.4 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java^TM 2 Platform
Ent. Ed. v1.4

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.servlet.jsp.tagext
Class TagLibraryInfo

java.lang.Object
  javax.servlet.jsp.tagext.TagLibraryInfo

public abstract class TagLibraryInfo
extends Object

Translation-time information associated with a taglib directive, and its underlying TLD file. Most of the information is directly from the TLD, except for the prefix and the uri values used in the taglib directive

Field Summary

protected FunctionInfo[] functions
          An array describing the functions that are defined in this tag library.

protected String info
          Information (documentation) for this TLD.

protected String jspversion
          The version of the JSP specification this tag library is written to.

protected String prefix
          The prefix assigned to this taglib from the taglib directive.

protected String shortname
          The preferred short name (prefix) as indicated in the TLD.

protected TagFileInfo[] tagFiles
          An array describing the tag files that are defined in this tag library.

protected TagInfo[] tags
          An array describing the tags that are defined in this tag library.

protected String tlibversion
          The version of the tag library.

protected String uri
          The value of the uri attribute from the taglib directive for this library.

protected String urn
          The "reliable" URN indicated in the TLD.

Constructor Summary

protected TagLibraryInfo(String prefix, String uri)
          Constructor.

Method Summary

FunctionInfo getFunction(String name)
          Get the FunctionInfo for a given function name, looking through all the functions in this tag library.

FunctionInfo[] getFunctions()
          An array describing the functions that are defined in this tag library.

String getInfoString()
          Information (documentation) for this TLD.

String getPrefixString()
          The prefix assigned to this taglib from the taglib directive

String getReliableURN()
          The "reliable" URN indicated in the TLD (the uri element).

String getRequiredVersion()
          A string describing the required version of the JSP container.

String getShortName()
          The preferred short name (prefix) as indicated in the TLD.

TagInfo getTag(String shortname)
          Get the TagInfo for a given tag name, looking through all the tags in this tag library.

TagFileInfo getTagFile(String shortname)
          Get the TagFileInfo for a given tag name, looking through all the tag files in this tag library.

TagFileInfo[] getTagFiles()
          An array describing the tag files that are defined in this tag library.

TagInfo[] getTags()
          An array describing the tags that are defined in this tag library.

String getURI()
          The value of the uri attribute from the taglib directive for this library.

Methods inherited from class java.lang.Object

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

Field Detail

prefix

protected String prefix

The prefix assigned to this taglib from the taglib directive.

uri

protected String uri

The value of the uri attribute from the taglib directive for this library.

tagFiles

protected TagFileInfo[] tagFiles

An array describing the tag files that are defined in this tag library.

Since:: 2.0

functions

protected FunctionInfo[] functions

An array describing the functions that are defined in this tag library.

Since:: 2.0

tlibversion

protected String tlibversion

The version of the tag library.

jspversion

protected String jspversion

The version of the JSP specification this tag library is written to.

shortname

protected String shortname

The preferred short name (prefix) as indicated in the TLD.

urn

protected String urn

The "reliable" URN indicated in the TLD.

info

protected String info

Information (documentation) for this TLD.

Constructor Detail

TagLibraryInfo

protected TagLibraryInfo(String prefix,
                         String uri)

Constructor. This will invoke the constructors for TagInfo, and TagAttributeInfo after parsing the TLD file.
Parameters:: prefix - the prefix actually used by the taglib directive; uri - the URI actually used by the taglib directive

Method Detail

getURI

public String getURI()

The value of the uri attribute from the taglib directive for this library.

Returns:: the value of the uri attribute

getPrefixString

public String getPrefixString()

The prefix assigned to this taglib from the taglib directive

Returns:: the prefix assigned to this taglib from the taglib directive

getShortName

public String getShortName()

The preferred short name (prefix) as indicated in the TLD. This may be used by authoring tools as the preferred prefix to use when creating an taglib directive for this library.

Returns:: the preferred short name for the library

getReliableURN

public String getReliableURN()

The "reliable" URN indicated in the TLD (the uri element). This may be used by authoring tools as a global identifier to use when creating a taglib directive for this library.

Returns:: a reliable URN to a TLD like this

getInfoString

public String getInfoString()