org.apache.rat.analysis.license

Class CDDL1License

java.lang.Object

org.apache.rat.analysis.license.BaseLicense

org.apache.rat.analysis.license.CDDL1License

All Implemented Interfaces:

IHeaderMatcher

public class CDDL1License
extends BaseLicense
implements IHeaderMatcher

Base CDDL 1.0 license.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CDDL1_LICENSE_DEFN
static java.lang.String	CDDL1_LICENSE_DEFN_ILLUMOS_STYLE
private FullTextMatchingLicense	textMatcherBase
private FullTextMatchingLicense	textMatcherIllumosStyle

Constructor Summary

Constructors

Constructor and Description
CDDL1License()

Method Summary

Modifier and Type	Method and Description
boolean	match(Document subject, java.lang.String s) Matches the text accumulated to licenses.
void	reset() Resets this matches.

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

CDDL1_LICENSE_DEFN

public static final java.lang.String CDDL1_LICENSE_DEFN

See Also:

Constant Field Values

CDDL1_LICENSE_DEFN_ILLUMOS_STYLE

public static final java.lang.String CDDL1_LICENSE_DEFN_ILLUMOS_STYLE

See Also:

Constant Field Values

textMatcherBase

private final FullTextMatchingLicense textMatcherBase

textMatcherIllumosStyle

private final FullTextMatchingLicense textMatcherIllumosStyle

Constructor Detail

CDDL1License

public CDDL1License()

Method Detail

match

public boolean match(Document subject,
                     java.lang.String s)
              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:

subject - current document.

s - next line of text, not null

Returns:

whether the current line matched in the document.

Throws:

RatHeaderAnalysisException - in case of internal RAT errors.

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