org.apache.maven.jxr
Class JxrBean

java.lang.Object
  org.apache.maven.jxr.JxrBean

public class JxrBean
extends Object

Creates an html-based, cross referenced version of Java source code for a project.

Version:

$Id: JxrBean.java 379214 2006-02-20 19:52:34Z ltheussl $

Author:

Josh Lucas, Jason van Zyl, Brian Leonard

Constructor Summary

JxrBean()
Default constructor

Method Summary

void	addSourceDir(String sourceDir) Adds a directory to the list of those to be cross-referenced.
String	getBottom() see DirectoryIndexer
String	getDestDir() see setDestDir(String)
String	getDocTitle() see DirectoryIndexer
String	getInputEncoding() see setInputEncoding(String)
String	getJavadocDir() see setJavadocDir(String)
Locale	getLocale() Returns the locale.
String	getOutputEncoding() see setOutputEncoding(String)
String	getTemplateDir() see setTemplateDir(String)
String	getWindowTitle() see DirectoryIndexer
void	setBottom(String newBottom) see DirectoryIndexer
void	setDestDir(String newDestDir) DestDir is the directory in which jxr will write its output
void	setDocTitle(String newDocTitle) see DirectoryIndexer
void	setInputEncoding(String newInputEncoding) InputEncoding is the encoding of source files.
void	setJavadocDir(String newJavadocDir) JavadocDir is used to cross-reference the source code with the appropriate javadoc pages.
void	setLocale(Locale newLocale) Sets the locale.
void	setOutputEncoding(String newOutputEncoding) OutputEncoding is the encoding of output files.
void	setSourceDir(String sourceDir) Sets a single source directory to be cross-referenced.
void	setSourceDirs(List newSourceDirs) Sets a list of source directories to be cross-referenced.
void	setTemplateDir(String newTemplateDir) TemplateDir is where the navigation templates are located
void	setWindowTitle(String newWindowTitle) see DirectoryIndexer
void	xref() Starts the cross-referencing and indexing.

Methods inherited from class java.lang.Object

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

Constructor Detail

JxrBean

public JxrBean()

Default constructor

Method Detail

xref

public void xref()
          throws org.apache.maven.jxr.JxrException

Starts the cross-referencing and indexing.

Throws:

JxrException - JxrException

setSourceDirs

public void setSourceDirs(List newSourceDirs)

Sets a list of source directories to be cross-referenced.

Parameters:

newSourceDirs - The list of source directories.

setSourceDir

public void setSourceDir(String sourceDir)

Sets a single source directory to be cross-referenced.

Parameters:

sourceDir - The source directory to be cross-referenced.

addSourceDir

public void addSourceDir(String sourceDir)

Adds a directory to the list of those to be cross-referenced.

Parameters:

sourceDir - The source directory to be cross-referenced.

setDestDir

public void setDestDir(String newDestDir)

DestDir is the directory in which jxr will write its output

Parameters:

newDestDir - the destination directory for jxr output

getDestDir

public String getDestDir()

see setDestDir(String)

Returns:

destDir

getLocale

public Locale getLocale()

Returns the locale.

Returns:

the locale.

setLocale

public void setLocale(Locale newLocale)

Sets the locale.

Parameters:

newLocale - the locale.

setInputEncoding

public void setInputEncoding(String newInputEncoding)

InputEncoding is the encoding of source files.

Parameters:

newInputEncoding - encoding of source files

getInputEncoding

public String getInputEncoding()

see setInputEncoding(String)

Returns:

inputEncoding

setOutputEncoding

public void setOutputEncoding(String newOutputEncoding)

OutputEncoding is the encoding of output files.

Parameters:

newOutputEncoding - encoding of output files

getOutputEncoding

public String getOutputEncoding()

see setOutputEncoding(String)

Returns:

outputEncoding

setJavadocDir

public void setJavadocDir(String newJavadocDir)

JavadocDir is used to cross-reference the source code with the appropriate javadoc pages. If null, no javadoc link will be added.

Parameters:

newJavadocDir - The root directory containing javadocs

getJavadocDir

public String getJavadocDir()

see setJavadocDir(String)

Returns:

javadocDir

setWindowTitle

public void setWindowTitle(String newWindowTitle)

see DirectoryIndexer

Parameters:

newWindowTitle - used by DirectoryIndexer

See Also:

setWindowTitle(String)

getWindowTitle

public String getWindowTitle()

see DirectoryIndexer

Returns:

windowTitle

See Also:

setWindowTitle(String)

setDocTitle

public void setDocTitle(String newDocTitle)

see DirectoryIndexer

Parameters:

newDocTitle - used by DirectoryIndexer

See Also:

setDocTitle(String)

getDocTitle

public String getDocTitle()

see DirectoryIndexer

Returns:

docTitle

See Also:

setDocTitle(String)

setBottom

public void setBottom(String newBottom)

see DirectoryIndexer

Parameters:

newBottom - used by DirectoryIndexer

See Also:

setBottom(String)

getBottom

public String getBottom()

see DirectoryIndexer

Returns:

bottom

See Also:

setBottom(String)

setTemplateDir

public void setTemplateDir(String newTemplateDir)

TemplateDir is where the navigation templates are located

Parameters:

newTemplateDir - the template directory

getTemplateDir

public String getTemplateDir()

see setTemplateDir(String)

Returns:

templateDir