org.apache.rat.anttasks

Class FullTextLicenseMatcher

java.lang.Object

org.apache.rat.analysis.license.BaseLicense

org.apache.rat.analysis.license.FullTextMatchingLicense

org.apache.rat.anttasks.FullTextLicenseMatcher

All Implemented Interfaces:

IHeaderMatcher

public class FullTextLicenseMatcher
extends FullTextMatchingLicense

Adapts FullTextMatchingLicense to Ant's method naming conventions so it becomes easy to write text matching based license matchers inside an Ant build file.

Since:

Rat Antlib 0.9

Constructor Summary

Constructors

Constructor and Description
FullTextLicenseMatcher()

Method Summary

Modifier and Type	Method and Description
void	addText(String text)
boolean	match(Document subject, String line) Matches the text accumulated to licenses.
void	setProject(org.apache.tools.ant.Project project)

Methods inherited from class org.apache.rat.analysis.license.FullTextMatchingLicense

hasFullText, reset, setFullText

Methods inherited from class org.apache.rat.analysis.license.BaseLicense

getLicenseFamilyCategory, getLicenseFamilyName, getNotes, prune, reportOnLicense, setLicenseFamilyCategory, setLicenseFamilyName, setNotes

Methods inherited from class java.lang.Object

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

Constructor Detail

FullTextLicenseMatcher

public FullTextLicenseMatcher()

Method Detail

setProject

public void setProject(org.apache.tools.ant.Project project)

addText

public void addText(String text)

match

public boolean match(Document subject,
                     String line)
              throws RatHeaderAnalysisException

Description copied from interface: IHeaderMatcher

Matches the text accumulated to licenses. TODO probably a poor design choice - hope to fix later

Specified by:

match in interface IHeaderMatcher

Overrides:

match in class FullTextMatchingLicense

Parameters:

subject - current document.

line - next line of text, not null

Returns:

whether the current line matched in the document.

Throws:

RatHeaderAnalysisException - in case of internal RAT errors.