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) Check 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)
void	setExcludes(String[] excludes)
void	setIncludes(String[] includes)
void	setInputEncoding(String inputEncoding)
void	setJavadocLinkDir(Path javadocLinkDir)
void	setLocale(Locale locale)
void	setOutputEncoding(String outputEncoding)
void	setRevision(String revision)
void	xref(List<String> sourceDirs, String templateDir, String windowTitle, String docTitle, String bottom)

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 -

sourceDir -

bottom -

Throws:

IOException

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)

Check 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)

Parameters:

dest -

setLocale

public void setLocale(Locale locale)

Parameters:

locale -

setInputEncoding

public void setInputEncoding(String inputEncoding)

Parameters:

inputEncoding -

setOutputEncoding

public void setOutputEncoding(String outputEncoding)

Parameters:

outputEncoding -

setJavadocLinkDir

public void setJavadocLinkDir(Path javadocLinkDir)

Parameters:

javadocLinkDir -

setRevision

public void setRevision(String revision)

Parameters:

revision -

xref

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

Parameters:

sourceDirs -

templateDir -

windowTitle -

docTitle -

bottom -

Throws:

IOException

JxrException

setExcludes

public void setExcludes(String[] excludes)

setIncludes

public void setIncludes(String[] includes)