Package org.apache.rat.analysis.license

Class SimplePatternBasedLicense

java.lang.Object

org.apache.rat.analysis.license.BaseLicense

org.apache.rat.analysis.license.SimplePatternBasedLicense

All Implemented Interfaces:

IHeaderMatcher

Direct Known Subclasses:

ApacheSoftwareLicense20, DojoLicenseHeader, SubstringLicenseMatcher, TMF854LicenseHeader, W3CDocLicense, W3CLicense

public class SimplePatternBasedLicense
extends BaseLicense
implements IHeaderMatcher

Since:

Rat 0.8

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String[]	patterns

Constructor Summary

Constructors

Modifier	Constructor	Description
	SimplePatternBasedLicense()
protected	SimplePatternBasedLicense(MetaData.Datum pLicenseFamilyCategory, MetaData.Datum pLicenseFamilyName, java.lang.String pNotes, java.lang.String[] pPatterns)

Method Summary

Modifier and Type	Method	Description
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)
void	reset()	Resets this matches.
void	setPatterns(java.lang.String[] pPatterns)

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

Field Detail

patterns

private java.lang.String[] patterns

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)

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 - current document.

pLine - next line of text, not null

Returns:

whether the current line matched in the document.

Throws:

RatHeaderAnalysisException - in case of internal RAT errors.