com.sun.tlddoc
Class TagLibrary

java.lang.Object
  extended by com.sun.tlddoc.TagLibrary
Direct Known Subclasses:
JARTLDFileTagLibrary, TagDirImplicitTagLibrary, TLDFileTagLibrary, WARJARTLDFileTagLibrary, WARTagDirImplicitTagLibrary

public abstract class TagLibrary
extends java.lang.Object

Base class for a tag library source. Different tag libraries will locate resources, such as tag files, in different ways.

Author:
mroth

Constructor Summary
TagLibrary()
           
 
Method Summary
abstract  java.lang.String getPathDescription()
          Returns a String that the user would recognize as a location for this tag library.
abstract  java.io.InputStream getResource(java.lang.String path)
          Returns an input stream for the given resource, or null if the resource could not be found.
abstract  org.w3c.dom.Document getTLDDocument(javax.xml.parsers.DocumentBuilder documentBuilder)
          Returns a Document of the effective tag library descriptor for this tag library.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TagLibrary

public TagLibrary()
Method Detail

getPathDescription

public abstract java.lang.String getPathDescription()
Returns a String that the user would recognize as a location for this tag library.


getTLDDocument

public abstract org.w3c.dom.Document getTLDDocument(javax.xml.parsers.DocumentBuilder documentBuilder)
                                             throws java.io.IOException,
                                                    org.xml.sax.SAXException,
                                                    javax.xml.parsers.ParserConfigurationException,
                                                    javax.xml.transform.TransformerConfigurationException,
                                                    javax.xml.transform.TransformerException,
                                                    GeneratorException
Returns a Document of the effective tag library descriptor for this tag library. This might come from a file or be implicitly generated.

Throws:
java.io.IOException
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException
javax.xml.transform.TransformerConfigurationException
javax.xml.transform.TransformerException
GeneratorException

getResource

public abstract java.io.InputStream getResource(java.lang.String path)
                                         throws java.io.IOException
Returns an input stream for the given resource, or null if the resource could not be found.

Throws:
java.io.IOException