org.apache.rat.analysis.generation

Class JavaDocLicenseNotRequired

java.lang.Object

org.apache.rat.analysis.generation.JavaDocLicenseNotRequired

All Implemented Interfaces:

IHeaderMatcher

public class JavaDocLicenseNotRequired
extends java.lang.Object
implements IHeaderMatcher

JavaDocs are generated and so no license is required. It is useful to note these separately.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	JAVADOC_REGEX_DEFN

Constructor Summary

Constructors

Constructor and Description
JavaDocLicenseNotRequired()

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

JAVADOC_REGEX_DEFN

private static final java.lang.String JAVADOC_REGEX_DEFN

See Also:

Constant Field Values

Constructor Detail

JavaDocLicenseNotRequired

public JavaDocLicenseNotRequired()

Method Detail

match

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

line - next line of text, not null

Returns:

whether the current line matched in the document.

Throws:

RatHeaderAnalysisException - in case of internal RAT errors.

reportOnLicense

private void reportOnLicense(Document subject)

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