org.apache.maven.jxr
Class JXR

java.lang.Object
  extended byorg.apache.maven.jxr.JXR

public class JXR
extends java.lang.Object

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

Version:
$Id: JXR.java 360490 2006-01-01 15:07:52Z fgiust $
Author:
Kevin A. Burton

Field Summary
static java.lang.String NOTICE
          Description of the Field
 
Constructor Summary
JXR()
           
 
Method Summary
 java.lang.String getDest()
          Get the path to the destination files
static boolean isHtmlFile(java.lang.String filename)
          Check to see if the file is a HTML file
static boolean isJavaFile(java.lang.String filename)
          Check to see if the file is a Java source file
 void processPath(PackageManager packageManager, java.lang.String source)
          Now that we have instantiated everythign.
 void setDest(java.lang.String dest)
           
 void setInputEncoding(java.lang.String inputEncoding)
           
 void setJavadocLinkDir(java.lang.String javadocLinkDir)
           
 void setLocale(java.util.Locale locale)
           
 void setLog(Log log)
           
 void setOutputEncoding(java.lang.String outputEncoding)
           
 void setRevision(java.lang.String revision)
           
 void setTransformer(JavaCodeTransform transformer)
           
 void xref(java.util.List sourceDirs, java.lang.String templateDir, java.lang.String windowTitle, java.lang.String docTitle, java.lang.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 java.lang.String NOTICE
Description of the Field

See Also:
Constant Field Values
Constructor Detail

JXR

public JXR()
Method Detail

processPath

public void processPath(PackageManager packageManager,
                        java.lang.String source)
                 throws java.io.IOException
Now that we have instantiated everythign. Process this JXR task.

Throws:
java.io.IOException

isJavaFile

public static boolean isJavaFile(java.lang.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(java.lang.String filename)
Check to see if the file is a HTML file

Parameters:
filename - The name of the file to check
Returns:
true if the file is a HTML file

getDest

public java.lang.String getDest()
Get the path to the destination files

Returns:
The path to the destination files

setDest

public void setDest(java.lang.String dest)

setLocale

public void setLocale(java.util.Locale locale)

setInputEncoding

public void setInputEncoding(java.lang.String inputEncoding)

setOutputEncoding

public void setOutputEncoding(java.lang.String outputEncoding)

setJavadocLinkDir

public void setJavadocLinkDir(java.lang.String javadocLinkDir)

setTransformer

public void setTransformer(JavaCodeTransform transformer)

setRevision

public void setRevision(java.lang.String revision)

setLog

public void setLog(Log log)

xref

public void xref(java.util.List sourceDirs,
                 java.lang.String templateDir,
                 java.lang.String windowTitle,
                 java.lang.String docTitle,
                 java.lang.String bottom)
          throws java.io.IOException,
                 JxrException
Throws:
java.io.IOException
JxrException


Copyright © {inceptionYear}-2007 Apache Software Foundation. All Rights Reserved.