Author: rdonkin
Date: Mon Dec 9 05:52:18 2013
New Revision: 1549429
URL: http://svn.apache.org/r1549429
Log:
Add Java Doc.
Modified:
creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/analysis/generation/GeneratedLicenseNotRequired.java
Modified:
creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/analysis/generation/GeneratedLicenseNotRequired.java
URL:
http://svn.apache.org/viewvc/creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/analysis/generation/GeneratedLicenseNotRequired.java?rev=1549429&r1=1549428&r2=1549429&view=diff
==============================================================================
---
creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/analysis/generation/GeneratedLicenseNotRequired.java
(original)
+++
creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/analysis/generation/GeneratedLicenseNotRequired.java
Mon Dec 9 05:52:18 2013
@@ -30,10 +30,13 @@ import org.apache.rat.api.MetaData;
*/
public class GeneratedLicenseNotRequired implements IHeaderMatcher {
+ /** The Constant EMPTY_STRING_ARRAY. */
private static final String[] EMPTY_STRING_ARRAY = new String[0];
+ /** The Constant EMPTY_PATTERN_ARRAY. */
private static final Pattern[] EMPTY_PATTERN_ARRAY = new Pattern[0];
+ /** The Constant DEFAULT_PHRASES. */
private static final String[] DEFAULT_PHRASES = { "generated by
Cayenne",
"Generated By:JJTree", "Generated By:JavaCC",
"THIS FILE IS AUTOMATICALLY GENERATED",
@@ -55,19 +58,24 @@ public class GeneratedLicenseNotRequired
"This class was generated by" };
// Uses either patterns or strings currently (not both)
+ /** The line patterns. */
private final Pattern[] linePatterns;
+
+ /** The phrases. */
private final String[] phrases;
/**
- *
+ * Instantiates a new generated license not required.
*/
public GeneratedLicenseNotRequired() {
this(DEFAULT_PHRASES);
}
/**
+ * Instantiates a new generated license not required.
*
* @param linePatterns
+ * the line patterns
*/
public GeneratedLicenseNotRequired(final Pattern... linePatterns) {
this.linePatterns = linePatterns;
@@ -75,19 +83,23 @@ public class GeneratedLicenseNotRequired
}
/**
+ * Instantiates a new generated license not required.
*
* @param lines
+ * the lines
*/
public GeneratedLicenseNotRequired(final String... lines) {
this.linePatterns = EMPTY_PATTERN_ARRAY;
this.phrases = lines;
}
- /**
+
+ /*
+ * (non-Javadoc)
*
- * @param subject
- * @param line
- * @return
+ * @see
+ *
org.apache.rat.analysis.IHeaderMatcher#match(org.apache.rat.api.Document,
+ * java.lang.String)
*/
public boolean match(final Document subject, final String line) {
boolean result = false;
@@ -109,16 +121,21 @@ public class GeneratedLicenseNotRequired
}
/**
+ * Report on license.
*
* @param subject
+ * the subject
*/
private void reportOnLicense(final Document subject) {
subject.getMetaData().set(
MetaData.RAT_LICENSE_FAMILY_CATEGORY_DATUM_GEN);
}
- /**
+
+ /*
+ * (non-Javadoc)
*
+ * @see org.apache.rat.analysis.IHeaderMatcher#reset()
*/
public void reset() {
// stateless
