com.sun.tlddoc
Class TLDDocGenerator

java.lang.Object
  com.sun.tlddoc.TLDDocGenerator

public class TLDDocGenerator
extends Object

TLDDoc Generator. Takes a set of TLD files and generates a set of javadoc-style HTML pages that describe the various components of the input tag libraries.

Author:

Mark Roth

Constructor Summary

TLDDocGenerator()
Creates a new TLDDocGenerator.

Method Summary

void	addJAR(File jar) Adds all the tag libraries found in the given JAR.
void	addTagDir(File tagdir) Adds the given directory of tag files.
void	addTagLibrary(TagLibrary tagLibrary) Adds the given Tag Library to the list of Tag Libraries to generate documentation for.
void	addTLD(File tld) Adds the given individual TLD file
void	addWAR(File path) Adds all the tag libraries found in the given web application packaged as a WAR file.
void	addWebApp(File path) Adds all the tag libraries found in the given web application.
void	generate() Commences documentation generation.
void	setDocTitle(String title) Sets the title for the TLD index (first) page.
void	setOutputDirectory(File dir) Sets the output directory for generated files.
void	setQuiet(boolean quiet) Sets quiet mode (produce no stdout during generation)
void	setWindowTitle(String title) Sets the browser window title for the documentation
void	setXSLTDirectory(File dir) Sets the directory from which to obtain the XSLT stylesheets.

Methods inherited from class java.lang.Object

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

Constructor Detail

TLDDocGenerator

public TLDDocGenerator()

Creates a new TLDDocGenerator.

Method Detail

addTagLibrary

public void addTagLibrary(TagLibrary tagLibrary)

Adds the given Tag Library to the list of Tag Libraries to generate documentation for.

Parameters:

tagLibrary - The tag library to add.

addTLD

public void addTLD(File tld)

Adds the given individual TLD file

Parameters:

tld - The TLD file to add

addWebApp

public void addWebApp(File path)

Adds all the tag libraries found in the given web application.

Parameters:

path - The path to the root of the web application.

addJAR

public void addJAR(File jar)

Adds all the tag libraries found in the given JAR.

Parameters:

jar - The JAR file to add.

addWAR

public void addWAR(File path)

Adds all the tag libraries found in the given web application packaged as a WAR file.

Parameters:

war - The war containing the web application

addTagDir

public void addTagDir(File tagdir)

Adds the given directory of tag files.

Parameters:

tld - The tag directory to add

setXSLTDirectory

public void setXSLTDirectory(File dir)

Sets the directory from which to obtain the XSLT stylesheets. This allows the user to change the look and feel of the generated output. If not specified, the default stylesheets are used.

Parameters:

dir - The base directory for the stylesheets

setOutputDirectory

public void setOutputDirectory(File dir)

Sets the output directory for generated files. If not specified, defaults to "."

Parameters:

dir - The base directory for generated files.

setWindowTitle

public void setWindowTitle(String title)

Sets the browser window title for the documentation

Parameters:

title - The browser window title

setDocTitle

public void setDocTitle(String title)

Sets the title for the TLD index (first) page.

Parameters:

title - The title for the TLD index

setQuiet

public void setQuiet(boolean quiet)

Sets quiet mode (produce no stdout during generation)

Parameters:

quiet - True if no output is to be produced, false otherwise.

generate

public void generate()
              throws GeneratorException,
                     TransformerException

Commences documentation generation.

Throws:

GeneratorException

TransformerException