org.apache.rat.analysis
Interface IHeaderMatcher

All Known Implementing Classes:
ApacheSoftwareLicense20, DojoLicenseHeader, GeneratedLicenseNotRequired, HeaderMatcherMultiplexer, JavaDocLicenseNotRequired, OASISLicense, TMF854LicenseHeader, W3CDocLicense, W3CLicense

public interface IHeaderMatcher

Matches text headers to known licenses.


Method Summary
 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 to match(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 - TODO
line - next line of text, not null
Returns:
TODO
Throws:
RatHeaderAnalysisException


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