org.apache.maven.jxr

Class DirectoryIndexer

public class DirectoryIndexer extends Object

This class creates the navigational pages for jxr's cross-referenced source files. The navigation is inspired by javadoc, so it should have a familiar feel. Creates the following files:

Version: $Id: DirectoryIndexer.java 360490 2006-01-01 15:07:52Z fgiust $

Author: Fabrice Bellingard Brian Leonard

Constructor Summary
DirectoryIndexer(PackageManager packageManager, String root)
Constructor for the DirectoryIndexer object
Method Summary
StringgetBottom()
see setBottom(String)
StringgetDocTitle()
see setDocTitle(String)
StringgetOutputEncoding()
see setOutputEncoding(String)
StringgetTemplateDir()
see setTemplateDir(String)
StringgetWindowTitle()
see setWindowTitle(String)
voidprocess(Log log)
Does the actual indexing.
voidsetBottom(String bottom)
Bottom is a footer for the navigation pages, usually a copyright see the javadoc documentation for the property of the same name
voidsetDocTitle(String docTitle)
DocTitle is used as a page heading for the summary files see the javadoc documentation for the property of the same name
voidsetOutputEncoding(String outputEncoding)
OutputEncoding is the encoding of output files.
voidsetTemplateDir(String templateDir)
TemplateDir is the location of the jelly template files used to generate the navigation pages.
voidsetWindowTitle(String windowTitle)
WindowTitle is used in the output's <title> tags see the javadoc documentation for the property of the same name

Constructor Detail

DirectoryIndexer

public DirectoryIndexer(PackageManager packageManager, String root)
Constructor for the DirectoryIndexer object

Parameters: packageManager PackageManager for this project root Path of the root output directory

Method Detail

getBottom

public String getBottom()
see setBottom(String)

See Also: setBottom

getDocTitle

public String getDocTitle()
see setDocTitle(String)

See Also: setDocTitle

getOutputEncoding

public String getOutputEncoding()
see setOutputEncoding(String)

getTemplateDir

public String getTemplateDir()
see setTemplateDir(String)

getWindowTitle

public String getWindowTitle()
see setWindowTitle(String)

See Also: setWindowTitle

process

public void process(Log log)
Does the actual indexing.

Throws: JxrException If something went wrong

setBottom

public void setBottom(String bottom)
Bottom is a footer for the navigation pages, usually a copyright see the javadoc documentation for the property of the same name

Parameters: bottom page footer

setDocTitle

public void setDocTitle(String docTitle)
DocTitle is used as a page heading for the summary files see the javadoc documentation for the property of the same name

Parameters: docTitle major page heading

setOutputEncoding

public void setOutputEncoding(String outputEncoding)
OutputEncoding is the encoding of output files.

Parameters: outputEncoding output Encoding

setTemplateDir

public void setTemplateDir(String templateDir)
TemplateDir is the location of the jelly template files used to generate the navigation pages.

Parameters: templateDir location of the template directory

setWindowTitle

public void setWindowTitle(String windowTitle)
WindowTitle is used in the output's <title> tags see the javadoc documentation for the property of the same name

Parameters: windowTitle the <title> attribute

Copyright © {inceptionYear}-2007 Apache Software Foundation. All Rights Reserved.