org.apache.rat.analysis.generation
Class JavaDocLicenseNotRequired

java.lang.Object
  extended by 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 not these separately.


Constructor Summary
JavaDocLicenseNotRequired()
           
 
Method Summary
 boolean match(Document subject, java.lang.String line)
          Matches the text accumulated to licenses.
 void reset()
          Resets this matches.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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

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


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