org.apache.rat

Class Report

java.lang.Object

org.apache.rat.Report

public class Report
extends Object

Method Summary

Modifier and Type	Method and Description
FilenameFilter	getInputFileFilter() Gets the current filter used to select files.
static void	main(String[] args)
static ClaimStatistic	report(IReportable container, Writer out, ReportConfiguration pConfiguration)
ClaimStatistic	report(PrintStream out) Deprecated. use the two-arg version instead
static void	report(PrintStream out, IReportable base, InputStream style, ReportConfiguration pConfiguration) Output a report that is styled using a defined stylesheet.
ClaimStatistic	report(PrintStream out, ReportConfiguration configuration)
static ClaimStatistic	report(Writer out, IReportable base, InputStream style, ReportConfiguration pConfiguration) Output a report that is styled using a defined stylesheet.
void	setInputFileFilter(FilenameFilter inputFileFilter) Sets the current filter used to select files.
void	styleReport(PrintStream out) Deprecated. use the two-arg version instead
void	styleReport(PrintStream out, ReportConfiguration configuration) Output a report in the default style and default licence header matcher.

Methods inherited from class java.lang.Object

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

Method Detail

main

public static final void main(String[] args)
                       throws Exception

Throws:

Exception

getInputFileFilter

public FilenameFilter getInputFileFilter()

Gets the current filter used to select files.

Returns:

current file filter, or null when no filter has been set

setInputFileFilter

public void setInputFileFilter(FilenameFilter inputFileFilter)

Sets the current filter used to select files.

Parameters:

inputFileFilter - filter, or null when no filter has been set

report

public ClaimStatistic report(PrintStream out)
                      throws Exception

Deprecated. use the two-arg version instead

Throws:

Exception

report

public ClaimStatistic report(PrintStream out,
                             ReportConfiguration configuration)
                      throws Exception

Throws:

Exception

Since:

RAT 0.8

styleReport

public void styleReport(PrintStream out)
                 throws Exception

Deprecated. use the two-arg version instead

Output a report in the default style and default licence header matcher.

Parameters:

out - - the output stream to recieve the styled report

Throws:

Exception

styleReport

public void styleReport(PrintStream out,
                        ReportConfiguration configuration)
                 throws Exception

Output a report in the default style and default licence header matcher.

Parameters:

out - - the output stream to recieve the styled report

configuration - the configuration to use

Throws:

Exception

Since:

RAT 0.8

report

public static void report(PrintStream out,
                          IReportable base,
                          InputStream style,
                          ReportConfiguration pConfiguration)
                   throws IOException,
                          TransformerConfigurationException,
                          InterruptedException,
                          RatException

Output a report that is styled using a defined stylesheet.

Parameters:

out - the stream to write the report to

base - the files or directories to report on

style - an input stream representing the stylesheet to use for styling the report

matcher - the header matcher for matching licence headers

approvedLicenseNames - a list of licence families that are approved for use in the project

Throws:

IOException

TransformerConfigurationException

InterruptedException

RatException

report

public static ClaimStatistic report(Writer out,
                                    IReportable base,
                                    InputStream style,
                                    ReportConfiguration pConfiguration)
                             throws IOException,
                                    TransformerConfigurationException,
                                    FileNotFoundException,
                                    InterruptedException,
                                    RatException

Output a report that is styled using a defined stylesheet.

Parameters:

out - the writer to write the report to

base - the files or directories to report on

style - an input stream representing the stylesheet to use for styling the report

matcher - the header matcher for matching licence headers

approvedLicenseNames - a list of licence families that are approved for use in the project

Throws:

IOException

TransformerConfigurationException

FileNotFoundException

InterruptedException

RatException

report

public static ClaimStatistic report(IReportable container,
                                    Writer out,
                                    ReportConfiguration pConfiguration)
                             throws IOException,
                                    RatException

Parameters:

container - the files or directories to report on

out - the writer to write the report to

matcher - the header matcher for matching licence headers

approvedLicenseNames - a list of licence families that are approved for use in the project

Throws:

IOException

RatException