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.

Version:

$Id: JXR.java 692692 2008-09-06 17:34:46Z hboutemy $

Author:

Kevin A. Burton

Field Summary

Fields

Modifier and Type	Field and Description
static String	NOTICE Description of the Notice.

Constructor Summary

Constructors

Constructor and Description
JXR()

Method Summary

Modifier and Type	Method and Description
String	getDest() Get the path to the destination files.
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, String source) Now that we have instantiated everything.
void	setDest(String dest)
void	setExcludes(String[] excludes)
void	setIncludes(String[] includes)
void	setInputEncoding(String inputEncoding)
void	setJavadocLinkDir(String javadocLinkDir)
void	setLocale(Locale locale)
void	setLog(Log log)
void	setOutputEncoding(String outputEncoding)
void	setRevision(String revision)
void	setTransformer(JavaCodeTransform transformer)
void	xref(List 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

Field Detail

NOTICE

public static final String NOTICE

Description of the Notice.

See Also:

Constant Field Values

Constructor Detail

JXR

public JXR()

Method Detail

processPath

public void processPath(PackageManager packageManager,
                        String source)
                 throws IOException

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

Parameters:

packageManager -

source -

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

getDest

public String getDest()

Get the path to the destination files.

Returns:

The path to the destination files

setDest

public void setDest(String 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(String javadocLinkDir)

Parameters:

javadocLinkDir -

setTransformer

public void setTransformer(JavaCodeTransform transformer)

Parameters:

transformer -

setRevision

public void setRevision(String revision)

Parameters:

revision -

setLog

public void setLog(Log log)

Parameters:

log -

xref

public void xref(List 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)