JXR (Maven JXR Parent 2.5 API)

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 1587311 2014-04-14 20:39:58Z hboutemy $

Author:

Kevin A. Burton

Constructor Summary

Constructors
Constructor and Description

JXR()

Constructors
Constructor and Description
`JXR()`

Method Summary

Methods
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, String bottom)` 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<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()
```

Method Detail

processPath

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

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

Parameters:: packageManager -; source -; 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








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

Class JXR

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JXR

Method Detail

processPath

isJavaFile

isHtmlFile

getDest

setDest

setLocale

setInputEncoding

setOutputEncoding

setJavadocLinkDir

setTransformer

setRevision

setLog

xref

setExcludes

setIncludes