org.apache.maven.javadoc
Class JavadocWarningsTextToXml

java.lang.Object
  org.apache.maven.javadoc.JavadocWarningsTextToXml

public class JavadocWarningsTextToXml
extends Object

Converts the javadoc warnings into an xml (xdoc format) file.

Version:

$Id: JavadocWarningsTextToXml.java 531612 2007-04-23 21:28:38Z ltheussl $

Author:

Steven Caswell (stevencaswell at apache.org)

Constructor Summary

JavadocWarningsTextToXml()

Method Summary

void	build() Builds the xml file from the javadoc report input.
String	getInputFileName() Returns the name of the input file.
String	getOutputEncoding() Returns the output encoding.
String	getOutputFileName() Returns the name of the output file.
boolean	isVerbose() Returns the verbose.
static void	main(String[] args) Invokes an instance of JavadocWarningsTextToXml from the command line.
void	setInputFileName(String inputFileNameValue) Sets the name of the input file.
void	setOutputEncoding(String outputEncodingValue) Sets the output encoding.
void	setOutputFileName(String outputFileNameValue) Sets the output file name.
void	setVerbose(boolean verboseValue) Sets the verbose mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavadocWarningsTextToXml

public JavadocWarningsTextToXml()

Method Detail

main

public static void main(String[] args)
                 throws IOException

Invokes an instance of JavadocWarningsTextToXml from the command line. The following command line arguments are expected in this order:

1. input file name
2. output file name
3. output encoding

Parameters:

args - the command line arguments

Throws:

IOException - if an exception occurs opening, reading, or writing files

setInputFileName

public void setInputFileName(String inputFileNameValue)

Sets the name of the input file. This file is expected to be a report generated by Javadoc.

Parameters:

inputFileNameValue - the input file name

getInputFileName

public String getInputFileName()

Returns the name of the input file.

Returns:

the inptu file name

setOutputEncoding

public void setOutputEncoding(String outputEncodingValue)

Sets the output encoding.

Parameters:

outputEncodingValue - the output encoding

getOutputEncoding

public String getOutputEncoding()

Returns the output encoding.

Returns:

the output encoding

setOutputFileName

public void setOutputFileName(String outputFileNameValue)

Sets the output file name.

Parameters:

outputFileNameValue - the output file name

getOutputFileName

public String getOutputFileName()

Returns the name of the output file.

Returns:

the output file name

setVerbose

public void setVerbose(boolean verboseValue)

Sets the verbose mode.

Parameters:

verboseValue - the verbose mode.

build

public void build()
           throws FileNotFoundException,
                  IOException,
                  UnsupportedEncodingException

Builds the xml file from the javadoc report input.

Throws:

FileNotFoundException - if the input file cannot be opened for reading or the output file cannot be opened for writing

IOException - if an error occurs reading or writing

UnsupportedEncodingException - if an unknown encoding was specified

isVerbose

public boolean isVerbose()

Returns the verbose.

Returns:

Returns the verbose.