com.sun.tlddoc

Class TagLibrary

java.lang.Object

com.sun.tlddoc.TagLibrary

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

JARTLDFileTagLibrary, TagDirImplicitTagLibrary, TLDFileTagLibrary, WARJARTLDFileTagLibrary, WARTagDirImplicitTagLibrary

public abstract class TagLibrary
extends Object
implements AutoCloseable

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

Author:

mroth

Constructor Summary

Constructors

Constructor and Description
TagLibrary()

Method Summary

Modifier and Type	Method and Description
abstract void	close()
abstract String	getPathDescription() Returns a String that the user would recognize as a location for this tag library.
abstract InputStream	getResource(String path) Returns an input stream for the given resource, or null if the resource could not be found.
abstract Document	getTLDDocument(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 String getPathDescription()

Returns a String that the user would recognize as a location for this tag library.

Returns:

a String that the user would recognize as a location for this tag library

getTLDDocument

public abstract Document getTLDDocument(DocumentBuilder documentBuilder)
                                 throws IOException,
                                        SAXException,
                                        TransformerException

Returns a Document of the effective tag library descriptor for this tag library. This might come from a file or be implicitly generated.

Parameters:

documentBuilder - DocumentBuilder to obtain DOM Document for creating an XML-document.

Returns:

created XML-Document

Throws:

IOException - if an I/O error has occurred

SAXException - If any parse errors occur

TransformerException - If an unrecoverable error occurs during the course of the transformation

getResource

public abstract InputStream getResource(String path)
                                 throws IOException

Returns an input stream for the given resource, or null if the resource could not be found.

Parameters:

path - the path to the resource

Returns:

the input stream for the given resource or null if the resource could not be found

Throws:

IOException - if an I/O error has occurred

close

public abstract void close()
                    throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException