org.apache.rat
Class Report

java.lang.Object
  extended by org.apache.rat.Report

public class Report
extends java.lang.Object


Method Summary
 java.io.FilenameFilter getInputFileFilter()
          Gets the current filter used to select files.
static void main(java.lang.String[] args)
           
static ClaimStatistic report(IReportable container, java.io.Writer out, ReportConfiguration pConfiguration)
           
 ClaimStatistic report(java.io.PrintStream out)
           
static void report(java.io.PrintStream out, IReportable base, java.io.InputStream style, ReportConfiguration pConfiguration)
          Output a report that is styled using a defined stylesheet.
static ClaimStatistic report(java.io.Writer out, IReportable base, java.io.InputStream style, ReportConfiguration pConfiguration)
          Output a report that is styled using a defined stylesheet.
 void setInputFileFilter(java.io.FilenameFilter inputFileFilter)
          Sets the current filter used to select files.
 void styleReport(java.io.PrintStream out)
          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(java.lang.String[] args)
                       throws java.lang.Exception
Throws:
java.lang.Exception

getInputFileFilter

public java.io.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(java.io.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(java.io.PrintStream out)
                      throws java.lang.Exception
Throws:
java.lang.Exception

styleReport

public void styleReport(java.io.PrintStream out)
                 throws java.lang.Exception
Output a report in the default style and default licence header matcher.

Parameters:
out - - the output stream to recieve the styled report
Throws:
java.lang.Exception

report

public static void report(java.io.PrintStream out,
                          IReportable base,
                          java.io.InputStream style,
                          ReportConfiguration pConfiguration)
                   throws java.io.IOException,
                          javax.xml.transform.TransformerConfigurationException,
                          java.lang.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:
java.io.IOException
javax.xml.transform.TransformerConfigurationException
java.lang.InterruptedException
RatException

report

public static ClaimStatistic report(java.io.Writer out,
                                    IReportable base,
                                    java.io.InputStream style,
                                    ReportConfiguration pConfiguration)
                             throws java.io.IOException,
                                    javax.xml.transform.TransformerConfigurationException,
                                    java.io.FileNotFoundException,
                                    java.lang.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:
java.io.IOException
javax.xml.transform.TransformerConfigurationException
java.io.FileNotFoundException
java.lang.InterruptedException
RatException

report

public static ClaimStatistic report(IReportable container,
                                    java.io.Writer out,
                                    ReportConfiguration pConfiguration)
                             throws java.io.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:
java.io.IOException
RatException


Copyright © 2006-2011 Apache Software Foundation. All Rights Reserved.