javax.servlet.jsp.tagext
Class TagLibraryInfo

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

public abstract class TagLibraryInfo
extends java.lang.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  java.lang.String info
          Information (documentation) for this TLD.
protected  java.lang.String jspversion
          The version of the JSP specification this tag library is written to
protected  java.lang.String prefix
          The prefix assigned to this taglib from the taglib directive
protected  java.lang.String shortname
          The preferred short name (prefix) as indicated in the TLD.
protected  java.lang.String tagdir
          The value of the tagdir attribute from the <%@ taglib directive for this tag library.
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  java.lang.String tlibversion
          The version of the tag library
protected  java.lang.String uri
          The value of the uri attribute from the taglib directive for this library.
protected  java.lang.String urn
          The "reliable" URN indicated in the TLD.
 
Constructor Summary
protected TagLibraryInfo(java.lang.String prefix, java.lang.String uri)
          Constructor.
protected TagLibraryInfo(java.lang.String prefix, java.lang.String uri, java.lang.String tagdir)
          JSP 2.0 Constructor.
 
Method Summary
 FunctionInfo getFunction(java.lang.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.
 java.lang.String getInfoString()
          Information (documentation) for this TLD.
 java.lang.String getPrefixString()
          The prefix assigned to this taglib from the taglib directive
 java.lang.String getReliableURN()
          The "reliable" URN indicated in the TLD (the uri element).
 java.lang.String getRequiredVersion()
          A string describing the required version of the JSP container.
 java.lang.String getShortName()
          The preferred short name (prefix) as indicated in the TLD.
 TagInfo getTag(java.lang.String shortname)
          Get the TagInfo for a given tag name, looking through all the tags in this tag library.
 java.lang.String getTagdir()
          The value of the tagdir attribute from the <%@ taglib directive for this tag library.
 TagFileInfo getTagFile(java.lang.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.
 java.lang.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 java.lang.String prefix
The prefix assigned to this taglib from the taglib directive


uri

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


tagdir

protected java.lang.String tagdir
The value of the tagdir attribute from the <%@ taglib directive for this tag library.

Since:
JSP2.0

tags

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


tagFiles

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

Since:
JSP2.0

functions

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

Since:
JSP2.0

tlibversion

protected java.lang.String tlibversion
The version of the tag library


jspversion

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


shortname

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


urn

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


info

protected java.lang.String info
Information (documentation) for this TLD.

Constructor Detail

TagLibraryInfo

protected TagLibraryInfo(java.lang.String prefix,
                         java.lang.String uri)
Constructor. This will invoke the constructors for TagInfo, and TagAttributeInfo after parsing the TLD file. Sets tagdir to null.

Parameters:
prefix - the prefix actually used by the taglib directive
uri - the URI actually used by the taglib directive

TagLibraryInfo

protected TagLibraryInfo(java.lang.String prefix,
                         java.lang.String uri,
                         java.lang.String tagdir)
JSP 2.0 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. Either uri or tagdir must be null.
tagdir - the directory of tag files, starting with /WEB-INF/tags/ if this directive is specifying the directory of an implicit tag library composed of tag files. Either uri or tagdir must be null.
Since:
JSP2.0
Method Detail

getURI

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

Returns:
the value of the uri attribute

getTagdir

public java.lang.String getTagdir()
The value of the tagdir attribute from the <%@ taglib directive for this tag library.

Returns:
the value of the tagdir attribute
Since:
JSP2.0

getPrefixString

public java.lang.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 java.lang.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 java.lang.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 java.lang.String getInfoString()
Information (documentation) for this TLD.

Returns:
the info string for this tag lib

getRequiredVersion

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

Returns:
the (minimal) required version of the JSP container.
See Also:
JspEngineInfo

getTags

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

Returns:
the tags defined in this tag lib

getTagFiles

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

Returns:
the tag files defined in this tag lib
Since:
JSP2.0

getTag

public TagInfo getTag(java.lang.String shortname)
Get the TagInfo for a given tag name, looking through all the tags in this tag library. Returns null if no tag is found.

Parameters:
shortname - The short name (no prefix) of the tag
Returns:
the TagInfo for that tag.

getTagFile

public TagFileInfo getTagFile(java.lang.String shortname)
Get the TagFileInfo for a given tag name, looking through all the tag files in this tag library. Returns null if no tag file is found.

Parameters:
shortname - The short name (no prefix) of the tag
Returns:
the TagFileInfo for that tag file.
Since:
JSP2.0

getFunctions

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

Returns:
the functions defined in this tag lib
Since:
JSP2.0

getFunction

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

Parameters:
name - The name (no prefix) of the function
Returns:
the FunctionInfo for that function.
Since:
JSP2.0


Copyright © 1999-2002 The Apache Software Foundation. All Rights Reserved.