|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.rat.Report
public class Report
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 |
---|
public static final void main(java.lang.String[] args) throws java.lang.Exception
java.lang.Exception
public java.io.FilenameFilter getInputFileFilter()
public void setInputFileFilter(java.io.FilenameFilter inputFileFilter)
inputFileFilter
- filter, or null when no filter has been setpublic ClaimStatistic report(java.io.PrintStream out) throws java.lang.Exception
java.lang.Exception
public void styleReport(java.io.PrintStream out) throws java.lang.Exception
out
- - the output stream to recieve the styled report
java.lang.Exception
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
out
- the stream to write the report tobase
- the files or directories to report onstyle
- an input stream representing the stylesheet to use for styling the reportmatcher
- the header matcher for matching licence headersapprovedLicenseNames
- a list of licence families that are approved for use in the project
java.io.IOException
javax.xml.transform.TransformerConfigurationException
java.lang.InterruptedException
RatException
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
out
- the writer to write the report tobase
- the files or directories to report onstyle
- an input stream representing the stylesheet to use for styling the reportmatcher
- the header matcher for matching licence headersapprovedLicenseNames
- a list of licence families that are approved for use in the project
java.io.IOException
javax.xml.transform.TransformerConfigurationException
java.io.FileNotFoundException
java.lang.InterruptedException
RatException
public static ClaimStatistic report(IReportable container, java.io.Writer out, ReportConfiguration pConfiguration) throws java.io.IOException, RatException
container
- the files or directories to report onout
- the writer to write the report tomatcher
- the header matcher for matching licence headersapprovedLicenseNames
- a list of licence families that are approved for use in the project
java.io.IOException
RatException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |