Package org.apache.rat.analysis
Interface IHeaderMatcher
-
- All Known Implementing Classes:
ApacheSoftwareLicense20
,AppliedApacheSoftwareLicense20
,CDDL1License
,CopyrightHeader
,DojoLicenseHeader
,FullTextLicenseMatcher
,FullTextMatchingLicense
,GeneratedLicenseNotRequired
,GPL1License
,GPL2License
,GPL3License
,HeaderMatcherMultiplexer
,JavaDocLicenseNotRequired
,MITLicense
,OASISLicense
,SimplePatternBasedLicense
,SubstringLicenseMatcher
,TMF854LicenseHeader
,W3CDocLicense
,W3CLicense
public interface IHeaderMatcher
Matches text headers to known licenses.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
match(Document subject, java.lang.String line)
Matches the text accumulated to licenses.void
reset()
Resets this matches.
-
-
-
Method Detail
-
reset
void reset()
Resets this matches. Subsequent calls tomatch(org.apache.rat.api.Document, java.lang.String)
will accumulate new text.
-
match
boolean match(Document subject, java.lang.String line) throws RatHeaderAnalysisException
Matches the text accumulated to licenses. TODO probably a poor design choice - hope to fix later- 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.
-
-