JXR (Maven JXR 1.0 API)

Class JXR

public class JXR extends 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 String	NOTICE Description of the Field

Field Summary

static String

NOTICE

Description of the Field

Method Summary
String	getDest() Get the path to the destination files
static boolean	isHtmlFile(String filename) Check to see if the file is a 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 everythign.
void	setDest(String dest)
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)

Method Summary

String

getDest()

Get the path to the destination files

static boolean

isHtmlFile(String filename)

Check to see if the file is a 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 everythign.

void

setDest(String dest)

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)

Method Detail

public String getDest()

Get the path to the destination files

Returns: The path to the destination files

public static boolean isHtmlFile(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

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




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


   setDest
   public  void setDest(String dest)
   


   setInputEncoding
   public  void setInputEncoding(String inputEncoding)
   


   setJavadocLinkDir
   public  void setJavadocLinkDir(String javadocLinkDir)
   


   setLocale
   public  void setLocale(Locale locale)
   


   setLog
   public  void setLog(Log log)
   


   setOutputEncoding
   public  void setOutputEncoding(String outputEncoding)
   


   setRevision
   public  void setRevision(String revision)
   


   setTransformer
   public  void setTransformer(JavaCodeTransform transformer)
   


   xref
   public  void xref(List sourceDirs, String templateDir, String windowTitle, String docTitle, String bottom)
   

   
   
    
      Overview
      Package
      Class
      Use
      Tree
      Deprecated
      Index
      Help
    
    
      
       Prev Class
       Next Class
      
      
       Frames
       NoFrames
      
      All Classes
   
   
      Summary:
       Nested
       Field
       Constr
       Method
      
      Detail:
       Field
       Constr
       Method
      
   
    
     Maven JXR 1.0 API
    
    
   
   Copyright © {inceptionYear}-2007 Apache Software Foundation. All Rights Reserved.