Class Reporter

java.lang.Object

org.apache.rat.Reporter

public class Reporter
extends Object

Class that executes the report as defined in a ReportConfiguration and stores the result for later handling.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Reporter.Output	The output from a report run.

Constructor Summary

Constructors

Constructor	Description
Reporter(ReportConfiguration configuration)	Create the reporter.

Method Summary

Modifier and Type	Method	Description
Reporter.Output	execute()	Executes the report and builds the output.
Reporter.Output	getOutput()	Gets the output from the last execute() call or null if execute() has not been called.

Methods inherited from class Object

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

Constructor Details

Reporter

public Reporter(ReportConfiguration configuration)

Create the reporter.

Parameters:

configuration - the configuration to use.

Method Details

execute

public Reporter.Output execute()
                        throws RatException

Executes the report and builds the output.

Returns:

the Output object.

Throws:

RatException - on error.

getOutput

public Reporter.Output getOutput()

Gets the output from the last execute() call or null if execute() has not been called.

Returns:

the output