Validate Javadoc as part of the checks. (#396)

metafacture-biblio/src/main/java/org/metafacture/biblio/iso2709/RecordBuilder.java:398: warning - Tag @see: reference not found: AppendState#ID_FIELD
metafacture-io/src/main/java/org/metafacture/io/ObjectWriter.java:56: warning - #STDOUT (referenced by @value tag) is an unknown reference.
metafacture-monitoring/src/main/java/org/metafacture/monitoring/ObjectBatchLogger.java:68: warning - #DEFAULT_FORMAT (referenced by @value tag) is an unknown reference.
metafacture-xml/src/main/java/org/metafacture/xml/GenericXmlHandler.java:62: warning - #RECORD_TAG_PROPERTY (referenced by @value tag) is an unknown reference.
metafacture-xml/src/main/java/org/metafacture/xml/GenericXmlHandler.java:93: warning - DEFAULT_RECORD_TAG (referenced by @value tag) is an unknown reference.
metamorph/src/main/java/org/metafacture/metamorph/functions/ISBN.java:101: warning - #ISBN10 (referenced by @value tag) is an unknown reference.
metamorph/src/main/java/org/metafacture/metamorph/functions/ISBN.java:101: warning - #ISBN13 (referenced by @value tag) is an unknown reference.
metamorph/src/main/java/org/metafacture/metamorph/functions/Unique.java:80: warning - #NAME (referenced by @value tag) is an unknown reference.
metamorph/src/main/java/org/metafacture/metamorph/functions/Unique.java:80: warning - #VALUE (referenced by @value tag) is an unknown reference.

Author: blackwinter

build.gradle

@@ -58,6 +58,7 @@ subprojects {
   apply plugin: 'checkstyle'
 
   check.dependsOn(editorconfigCheck)
+  check.dependsOn(javadoc)
 
   sourceCompatibility = 1.8
   targetCompatibility = 1.8
@@ -81,6 +82,12 @@ subprojects {
     group 'build'
   }
 
+  javadoc {
+    options {
+      addBooleanOption 'Xwerror', true
+    }
+  }
+
   artifacts {
     archives sourceJar
     archives javadocJar

metafacture-biblio/src/main/java/org/metafacture/biblio/iso2709/RecordBuilder.java

@@ -392,8 +392,6 @@ private void require7BitAscii(final char charCode) {
     /**
      * Resets the label, directory and the fields. Sets the "append state" to "id
      * field".
-     *
-     * @see AppendState#ID_FIELD
      */
     public void reset() {
         label.reset();

metafacture-io/src/main/java/org/metafacture/io/ObjectWriter.java

@@ -40,7 +40,8 @@
 @FluxCommand("write")
 public final class ObjectWriter<T> implements ConfigurableObjectWriter<T> {
 
-    private static final String STDOUT = "stdout";
+    public static final String STDOUT = "stdout";
+
     private static final List<String> ARGUMENTS = Collections.unmodifiableList(Arrays.asList(STDOUT, "PATH"));
 
     private final ConfigurableObjectWriter<T> objectWriter;

metafacture-monitoring/src/main/java/org/metafacture/monitoring/ObjectBatchLogger.java

@@ -50,9 +50,9 @@ public final class ObjectBatchLogger<T> extends DefaultObjectPipe<T, ObjectRecei
     public static final long DEFAULT_BATCH_SIZE = 1000;
     public static final String BATCH_COUNT_VAR = "batches";
     public static final String BATCH_SIZE_VAR = "batchSize";
+    public static final String DEFAULT_FORMAT = "records processed: ${totalRecords}";
 
     private static final Logger LOG = LoggerFactory.getLogger(ObjectBatchLogger.class);
-    private static final String DEFAULT_FORMAT = "records processed: ${totalRecords}";
 
     private final Map<String, String> vars = new HashMap<String, String>();
     private final String format;
@@ -67,7 +67,6 @@ public final class ObjectBatchLogger<T> extends DefaultObjectPipe<T, ObjectRecei
      */
     public ObjectBatchLogger() {
         this.format = DEFAULT_FORMAT;
-
     }
 
     public ObjectBatchLogger(final String format) {

metafacture-xml/src/main/java/org/metafacture/xml/GenericXmlHandler.java

@@ -40,12 +40,12 @@
 @FluxCommand("handle-generic-xml")
 public final class GenericXmlHandler extends DefaultXmlPipe<StreamReceiver> {
 
+    public static final String RECORD_TAG_PROPERTY = "org.culturegraph.metamorph.xml.recordtag";
+
     public static final boolean EMIT_NAMESPACE = false;
 
     private static final Pattern TABS = Pattern.compile("\t+");
 
-    private static final String RECORD_TAG_PROPERTY = "org.culturegraph.metamorph.xml.recordtag";
-
     private String attributeMarker = DEFAULT_ATTRIBUTE_MARKER;
     private String recordTagName = DEFAULT_RECORD_TAG;
     private String valueTagName = DEFAULT_VALUE_TAG;
@@ -86,7 +86,7 @@ public GenericXmlHandler(final String recordTagName) {
      * This value may only be changed between records. If it is changed
      * while processing a record the behaviour of this module is undefined.
      * <p>
-     * <strong>Default value: {@value DEFAULT_RECORD_TAG}</strong>
+     * <strong>Default value: {@value org.metafacture.framework.helpers.DefaultXmlPipe#DEFAULT_RECORD_TAG}</strong>
      *
      * @param recordTagName the tag name which marks the start of a record.
      */

metamorph/src/main/java/org/metafacture/metamorph/functions/ISBN.java

@@ -28,10 +28,11 @@
  */
 public final class ISBN extends AbstractSimpleStatelessFunction {
 
+    public static final String ISBN10 = "isbn10";
+    public static final String ISBN13 = "isbn13";
+
     private static final String CHECK = "0123456789X0";
 
-    private static final String ISBN10 = "isbn10";
-    private static final String ISBN13 = "isbn13";
     private static final Pattern ISBN_PATTERN = Pattern.compile("[\\dX]+");
     private static final Pattern DIRT_PATTERN = Pattern.compile("[\\.\\-]");
     private static final int ISBN10_SIZE = 10;

metamorph/src/main/java/org/metafacture/metamorph/functions/Unique.java

@@ -29,9 +29,9 @@
  */
 public final class Unique extends AbstractStatefulFunction {
 
-    private static final String ENTITY = "entity";
-    private static final String NAME = "name";
-    private static final String VALUE = "value";
+    public static final String ENTITY = "entity";
+    public static final String NAME = "name";
+    public static final String VALUE = "value";
 
     private final Set<String> set = new HashSet<String>();