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 report(PrintStream, ReportConfiguration) 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 styleReport(PrintStream, ReportConfiguration) instead
void	styleReport(PrintStream out, ReportConfiguration configuration) Output a report in the default style and default license 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

@Deprecated
public ClaimStatistic report(PrintStream out)
                                  throws Exception

Deprecated. use report(PrintStream, ReportConfiguration) instead

Parameters:

out - - the output stream to receive the styled report

Returns:

the currently collected numerical statistics.

Throws:

Exception - in case of errors.

report

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

Parameters:

out - - the output stream to receive the styled report

configuration - - current configuration options.

Returns:

the currently collected numerical statistics.

Throws:

Exception - in case of errors.

Since:

Rat 0.8

styleReport

@Deprecated
public void styleReport(PrintStream out)
                             throws Exception

Deprecated. use styleReport(PrintStream, ReportConfiguration) instead

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

Parameters:

out - - the output stream to receive the styled report

Throws:

Exception - in case of errors.

styleReport

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

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

Parameters:

out - - the output stream to receive the styled report

configuration - the configuration to use

Throws:

Exception - in case of errors.

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

pConfiguration - current report configuration.

Throws:

IOException - in case of I/O errors.

TransformerConfigurationException - in case of XML errors.

InterruptedException - in case of threading errors.

RatException - in case of internal errors.

report

public static ClaimStatistic report(Writer 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 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

pConfiguration - current report configuration.

Returns:

the currently collected numerical statistics.

Throws:

IOException - in case of I/O errors.

TransformerConfigurationException - in case of XML errors.

InterruptedException - in case of threading errors.

RatException - in case of internal errors.

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

pConfiguration - current report configuration.

Returns:

the currently collected numerical statistics.

Throws:

IOException - in case of I/O errors.

RatException - in case of internal errors.