Package org.apache.rat.report.claim

Class LicenseAddingReport

java.lang.Object

org.apache.rat.report.claim.LicenseAddingReport

All Implemented Interfaces:

RatReport

public class LicenseAddingReport
extends Object
implements RatReport

A Report that adds licenses text to files.

Constructor Summary

Constructors

Constructor	Description
LicenseAddingReport(String copyrightMsg, boolean overwrite)	Creates a LicenseAddingReport that inserts the copyright message and may overwrite the files.

Method Summary

Modifier and Type	Method	Description
void	report(Document document)	Performs the actual reporting on the given document.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.rat.report.RatReport

endReport, startReport

Constructor Details

LicenseAddingReport

public LicenseAddingReport(String copyrightMsg,
 boolean overwrite)

Creates a LicenseAddingReport that inserts the copyright message and may overwrite the files.

Parameters:

copyrightMsg - The message to insert into the files. May be null.

overwrite - if true will overwrite the files rather than create .new files.

Method Details

report

public void report(Document document)
            throws RatException

Description copied from interface: RatReport

Performs the actual reporting on the given document. Default implementation does nothing.

Specified by:

report in interface RatReport

Parameters:

document - write any reporting results into this document upon analysis.

Throws:

RatException - on error.