org.apache.maven.jxr

Class JXR

java.lang.Object

org.apache.maven.jxr.JXR

public class JXR
extends Object

Main entry point into Maven used to kick off the XReference code building.

Author:

Kevin A. Burton

Constructor Summary

Constructors

Constructor and Description
JXR(PackageManager pkgmgr, JavaCodeTransform transformer)

Method Summary

Modifier and Type	Method and Description
static boolean	isHtmlFile(String filename) Checks to see if the file is an HTML file.
static boolean	isJavaFile(String filename) Check to see if the file is a Java source file.
void	processPath(PackageManager packageManager, Path sourceDir, String bottom) Now that we have instantiated everything.
void	setDest(Path dest) Sets the destination.
void	setExcludes(String[] excludes)
void	setIncludes(String[] includes)
void	setInputEncoding(String inputEncoding) Sets the input encoding.
void	setJavadocLinkDir(Path javadocLinkDir) Sets the relative path to javadocs.
void	setLocale(Locale locale) Sets the locale.
void	setOutputEncoding(String outputEncoding) Sets the output encoding.
void	setRevision(String revision) Sets the revision.
void	xref(List<String> sourceDirs, String templateDir, String windowTitle, String docTitle, String bottom) Performs the cross-referencing.

Methods inherited from class java.lang.Object

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

Constructor Detail

JXR

public JXR(PackageManager pkgmgr,
           JavaCodeTransform transformer)

Method Detail

processPath

public void processPath(PackageManager packageManager,
                        Path sourceDir,
                        String bottom)
                 throws IOException

Now that we have instantiated everything. Process this JXR task.

Parameters:

packageManager - package manager

sourceDir - source directory.

bottom - bottom text

Throws:

IOException - on transformation error

isJavaFile

public static boolean isJavaFile(String filename)

Check to see if the file is a Java source file.

Parameters:

filename - The name of the file to check

Returns:

true if the file is a Java file

isHtmlFile

public static boolean isHtmlFile(String filename)

Checks to see if the file is an HTML file.

Parameters:

filename - The name of the file to check

Returns:

true if the file is an HTML file

setDest

public void setDest(Path dest)

Sets the destination.

Parameters:

dest - destination

setLocale

public void setLocale(Locale locale)

Sets the locale.

Parameters:

locale - locale

setInputEncoding

public void setInputEncoding(String inputEncoding)

Sets the input encoding.

Parameters:

inputEncoding - input encoding

setOutputEncoding

public void setOutputEncoding(String outputEncoding)

Sets the output encoding.

Parameters:

outputEncoding - output encoding

setJavadocLinkDir

public void setJavadocLinkDir(Path javadocLinkDir)

Sets the relative path to javadocs.

Parameters:

javadocLinkDir - path to javadocs

setRevision

public void setRevision(String revision)

Sets the revision.

Parameters:

revision - revision

xref

public void xref(List<String> sourceDirs,
                 String templateDir,
                 String windowTitle,
                 String docTitle,
                 String bottom)
          throws IOException,
                 JxrException

Performs the cross-referencing.

Parameters:

sourceDirs - source directories

templateDir - template directory

windowTitle - window title

docTitle - document title

bottom - bottom text

Throws:

IOException - on I/O error

JxrException - on Velocity error

setExcludes

public void setExcludes(String[] excludes)

setIncludes

public void setIncludes(String[] includes)