projassist.readme
Class ReadmePlugin

java.lang.Object
  projassist.readme.ReadmePlugin

public final class ReadmePlugin

extends java.lang.Object

This is the Bean that is used in the Readme plugin.

Version:

$Revision: 1.3 $, $Date: 2004/07/22 05:14:35 $

Author:

$Author: mkurjano $

Constructor Summary

ReadmePlugin()
Default constructor, sets all values to their defaults.

ReadmePlugin(java.lang.String theRootPath, java.lang.String theSeekFileName, java.lang.String theOutputDirectory, java.lang.String theOutputReportFileName, java.lang.String theBaseDir)
Constructor that sets all fields to given values.

Method Summary

void	generateReport() Execute this plugin.
java.lang.String	getBaseDir() Get this project's base directory.
java.lang.String	getOutputDirectory() Get the base output directory.
java.lang.String	getOutputReportFileName() Get the output report file name.
int	getProcessedCount() Get the number of files that were processed in this report.
java.lang.String	getRootPath() Get the root search path.
java.lang.String	getSeekFileName() Get the filename to look for.
static void	main(java.lang.String[] args)
void	setBaseDir(java.lang.String theBaseDir) Set the base dir of the project we're working in.
void	setOutputDirectory(java.lang.String theOutputDirectory) Set the base output directory.
void	setOutputReportFileName(java.lang.String theOutputReportFileName) Set the output report file name.
void	setRootPath(java.lang.String theRootPath) Set the root search path.
void	setSeekFileName(java.lang.String theSeekFileName) Set the filename to look for.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReadmePlugin

public ReadmePlugin()

Default constructor, sets all values to their defaults.

See Also:

ReadmePlugin(String, String, String, String, String)

ReadmePlugin

public ReadmePlugin(java.lang.String theRootPath,
                    java.lang.String theSeekFileName,
                    java.lang.String theOutputDirectory,
                    java.lang.String theOutputReportFileName,
                    java.lang.String theBaseDir)

Constructor that sets all fields to given values.

Parameters:

theRootPath - The root directory that we will begin searching in.

theSeekFileName - The name of the file that we are looking for.

theOutputDirectory - The name of the directory that we will write all output to.

theOutputReportFileName - The name of the file that we will write the overview page of our findings.

theBaseDir - The base directory of the project we're working on.

See Also:

setRootPath(String), setSeekFileName(String), setOutputDirectory(String), setOutputReportFileName(String), setBaseDir(String)

Method Detail

getRootPath

public java.lang.String getRootPath()

Get the root search path.

Returns:

The root search path.

setRootPath

public void setRootPath(java.lang.String theRootPath)

Set the root search path. If theRootPath is null, then this value is set to ..

Parameters:

theRootPath - The root search path.

To Do:

See if we can try to get the default from a system property.

getSeekFileName

public java.lang.String getSeekFileName()

Get the filename to look for.

Returns:

The filename to look for.

setSeekFileName

public void setSeekFileName(java.lang.String theSeekFileName)

Set the filename to look for. If theSeekFileName is null, then this value is set to readme.xml.

Parameters:

theSeekFileName - The file name to look for.

To Do:

See if we can get the default from a system property.

getOutputDirectory

public java.lang.String getOutputDirectory()

Get the base output directory.

Returns:

The base output directory.

setOutputDirectory

public void setOutputDirectory(java.lang.String theOutputDirectory)

Set the base output directory. If theOutputDirectory is null, then this value is set to /tmp.

Parameters:

theOutputDirectory - The base output directory.

To Do:

See if we can get the default from a system property.

getOutputReportFileName

public java.lang.String getOutputReportFileName()

Get the output report file name.

Returns:

The output report file name.

setOutputReportFileName

public void setOutputReportFileName(java.lang.String theOutputReportFileName)

Set the output report file name. If theOutputReportFileName is null, the this value is set to readme-report.xml.

Parameters:

theOutputReportFileName - The output report file name.

To Do:

See if we can get the default from a system property.

getBaseDir

public java.lang.String getBaseDir()

Get this project's base directory.

Returns:

This project's base directory.

setBaseDir

public void setBaseDir(java.lang.String theBaseDir)

Set the base dir of the project we're working in. If theBaseDir is null then this value is set to /tmp.

Parameters:

theBaseDir - The base directory of the project we're working on.

To Do:

See if wew can get the default from a system property.

getProcessedCount

public int getProcessedCount()

Get the number of files that were processed in this report.

Returns:

The number of files that were processed in this report.

generateReport

public void generateReport()
                    throws java.lang.Exception

Execute this plugin.

Throws:

java.lang.Exception - If something went wrong.

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception