org.apache.rat.analysis.license
Class SimplePatternBasedLicense

java.lang.Object
  extended by org.apache.rat.analysis.license.SimplePatternBasedLicense
All Implemented Interfaces:
IHeaderMatcher
Direct Known Subclasses:
ApacheSoftwareLicense20, DojoLicenseHeader, TMF854LicenseHeader, W3CDocLicense, W3CLicense

public class SimplePatternBasedLicense
extends java.lang.Object
implements IHeaderMatcher

Since:
RAT 0.8

Constructor Summary
  SimplePatternBasedLicense()
           
protected SimplePatternBasedLicense(MetaData.Datum pLicenseFamilyCategory, MetaData.Datum pLicenseFamilyName, java.lang.String pNotes, java.lang.String[] pPatterns)
           
 
Method Summary
 java.lang.String getLicenseFamilyCategory()
           
 java.lang.String getLicenseFamilyName()
           
 java.lang.String getNotes()
           
 java.lang.String[] getPatterns()
           
 boolean match(Document pSubject, java.lang.String pLine)
          Matches the text accumulated to licenses.
protected  boolean matches(java.lang.String pLine)
           
protected  void reportOnLicense(Document subject)
           
 void reset()
          Resets this matches.
 void setLicenseFamilyCategory(java.lang.String pDocumentCategory)
           
 void setLicenseFamilyName(java.lang.String pLicenseFamilyCategory)
           
 void setNotes(java.lang.String pNotes)
           
 void setPatterns(java.lang.String[] pPatterns)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SimplePatternBasedLicense

public SimplePatternBasedLicense()

SimplePatternBasedLicense

protected SimplePatternBasedLicense(MetaData.Datum pLicenseFamilyCategory,
                                    MetaData.Datum pLicenseFamilyName,
                                    java.lang.String pNotes,
                                    java.lang.String[] pPatterns)
Method Detail

getPatterns

public java.lang.String[] getPatterns()

setPatterns

public void setPatterns(java.lang.String[] pPatterns)

getLicenseFamilyCategory

public java.lang.String getLicenseFamilyCategory()

setLicenseFamilyCategory

public void setLicenseFamilyCategory(java.lang.String pDocumentCategory)

getLicenseFamilyName

public java.lang.String getLicenseFamilyName()

setLicenseFamilyName

public void setLicenseFamilyName(java.lang.String pLicenseFamilyCategory)

getNotes

public java.lang.String getNotes()

setNotes

public void setNotes(java.lang.String pNotes)

reportOnLicense

protected void reportOnLicense(Document subject)
                        throws RatHeaderAnalysisException
Throws:
RatHeaderAnalysisException

matches

protected boolean matches(java.lang.String pLine)

reset

public void reset()
Description copied from interface: IHeaderMatcher
Resets this matches. Subsequent calls to IHeaderMatcher.match(org.apache.rat.api.Document, java.lang.String) will accumulate new text.

Specified by:
reset in interface IHeaderMatcher

match

public boolean match(Document pSubject,
                     java.lang.String pLine)
              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
Parameters:
pSubject - TODO
pLine - next line of text, not null
Returns:
TODO
Throws:
RatHeaderAnalysisException


Copyright © 2006-2011 The Apache Software Foundation. All Rights Reserved.