Package org.apache.rat

Class Reporter

java.lang.Object

org.apache.rat.Reporter

public class Reporter
extends Object

Class that executes the report as defined in a ReportConfiguration.

Method Summary

Modifier and Type	Method	Description
static void	listLicenseFamilies(ReportConfiguration configuration, LicenseSetFactory.LicenseFilter filter)	lists the license families information on the configured output stream.
static void	listLicenses(ReportConfiguration configuration, LicenseSetFactory.LicenseFilter filter)	lists the licenses on the configured output stream.
static ClaimStatistic	report(ReportConfiguration configuration)	Execute the report.

Methods inherited from class java.lang.Object

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

Method Details

report

public static ClaimStatistic report(ReportConfiguration configuration)
                             throws Exception

Execute the report.

Parameters:

configuration - The report configuration.

Returns:

the currently collected numerical statistics.

Throws:

Exception - in case of errors.

listLicenseFamilies

public static void listLicenseFamilies(ReportConfiguration configuration,
 LicenseSetFactory.LicenseFilter filter)
                                throws IOException

lists the license families information on the configured output stream.

Parameters:

configuration - The configuration for the system

Throws:

IOException - if PrintWriter can not be retrieved from configuration.

listLicenses

public static void listLicenses(ReportConfiguration configuration,
 LicenseSetFactory.LicenseFilter filter)
                         throws IOException

lists the licenses on the configured output stream.

Parameters:

configuration - The configuration for the system

Throws:

IOException - if PrintWriter can not be retrieved from configuration.