Fix Javadoc references. (#396)

metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/Marc21Decoder.java:138: warning - Marc21EventNames#BIBLIOGRAPHIC_LEVEL_LITERAL (referenced by @value tag) is an unknown reference.
metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/Marc21Decoder.java:138: warning - Marc21EventNames#BIBLIOGRAPHIC_LEVEL_LITERAL (referenced by @value tag) is an unknown reference.
metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/Marc21Decoder.java:138: warning - Marc21EventNames#CATALOGING_FORM_LITERAL (referenced by @value tag) is an unknown reference.
metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/Marc21Decoder.java:138: warning - Marc21EventNames#CATALOGING_FORM_LITERAL (referenced by @value tag) is an unknown reference.
metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/Marc21Decoder.java:138: warning - Marc21EventNames#CHARACTER_CODING_LITERAL (referenced by @value tag) is an unknown reference.
metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/Marc21Decoder.java:138: warning - Marc21EventNames#CHARACTER_CODING_LITERAL (referenced by @value tag) is an unknown reference.
metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/Marc21Decoder.java:138: warning - Marc21EventNames#CHARACTER_CODING_LITERAL (referenced by @value tag) is an unknown reference.
metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/Marc21Decoder.java:138: warning - Marc21EventNames#ENCODING_LEVEL_LITERAL (referenced by @value tag) is an unknown reference.
metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/Marc21Decoder.java:138: warning - Marc21EventNames#ENCODING_LEVEL_LITERAL (referenced by @value tag) is an unknown reference.
metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/Marc21Decoder.java:138: warning - Marc21EventNames#LEADER_ENTITY (referenced by @value tag) is an unknown reference.
metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/Marc21Decoder.java:138: warning - Marc21EventNames#LEADER_ENTITY (referenced by @value tag) is an unknown reference.
metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/Marc21Decoder.java:138: warning - Marc21EventNames#MULTIPART_LEVEL_LITERAL (referenced by @value tag) is an unknown reference.
metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/Marc21Decoder.java:138: warning - Marc21EventNames#MULTIPART_LEVEL_LITERAL (referenced by @value tag) is an unknown reference.
metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/Marc21Decoder.java:138: warning - Marc21EventNames#RECORD_STATUS_LITERAL (referenced by @value tag) is an unknown reference.
metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/Marc21Decoder.java:138: warning - Marc21EventNames#RECORD_STATUS_LITERAL (referenced by @value tag) is an unknown reference.
metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/Marc21Decoder.java:138: warning - Marc21EventNames#RECORD_TYPE_LITERAL (referenced by @value tag) is an unknown reference.
metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/Marc21Decoder.java:138: warning - Marc21EventNames#RECORD_TYPE_LITERAL (referenced by @value tag) is an unknown reference.
metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/Marc21Decoder.java:138: warning - Marc21EventNames#TYPE_OF_CONTROL_LITERAL (referenced by @value tag) is an unknown reference.
metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/Marc21Decoder.java:138: warning - Marc21EventNames#TYPE_OF_CONTROL_LITERAL (referenced by @value tag) is an unknown reference.
metafacture-javaintegration/src/main/java/org/metafacture/javaintegration/MapToStream.java:81: warning - StandardEventNames#ID (referenced by @value tag) is an unknown reference.
metafacture-mangling/src/main/java/org/metafacture/mangling/RecordIdChanger.java:101: warning - StandardEventNames#ID (referenced by @value tag) is an unknown reference.

Author: blackwinter

metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/Marc21Decoder.java

@@ -41,8 +41,9 @@
  *   <li>data fields.
  * </ul>
  * This decoder only supports MARC 21 records with UTF-8 encoding. Other
- * character coding schemes are not supported. A {@link FormatException} is
- * thrown if a record with an unsupported coding scheme is encountered.
+ * character coding schemes are not supported. A
+ * {@link org.metafacture.framework.FormatException} is thrown if a record
+ * with an unsupported coding scheme is encountered.
  * <p>
  * The bibliographic information in the record leader is
  * <ul>
@@ -56,28 +57,28 @@
  *   <li>multipart resource record level.
  * </ul>
  * This information is emitted as an entity named
- * &quot;{@value Marc21EventNames#LEADER_ENTITY}&quot;. It is emitted directly
- * after the <i>start-record</i> event. The entity contains the following
- * literals:
+ * {@value org.metafacture.biblio.marc21.Marc21EventNames#LEADER_ENTITY}. It is
+ * emitted directly after the <i>start-record</i> event. The entity contains
+ * the following literals:
  * <ol>
- *   <li>{@value Marc21EventNames#RECORD_STATUS_LITERAL}
- *   <li>{@value Marc21EventNames#RECORD_TYPE_LITERAL}
- *   <li>{@value Marc21EventNames#BIBLIOGRAPHIC_LEVEL_LITERAL}
- *   <li>{@value Marc21EventNames#TYPE_OF_CONTROL_LITERAL}
- *   <li>{@value Marc21EventNames#CHARACTER_CODING_LITERAL}
- *   <li>{@value Marc21EventNames#ENCODING_LEVEL_LITERAL}
- *   <li>{@value Marc21EventNames#CATALOGING_FORM_LITERAL}
- *   <li>{@value Marc21EventNames#MULTIPART_LEVEL_LITERAL}
+ *   <li>{@value org.metafacture.biblio.marc21.Marc21EventNames#RECORD_STATUS_LITERAL}
+ *   <li>{@value org.metafacture.biblio.marc21.Marc21EventNames#RECORD_TYPE_LITERAL}
+ *   <li>{@value org.metafacture.biblio.marc21.Marc21EventNames#BIBLIOGRAPHIC_LEVEL_LITERAL}
+ *   <li>{@value org.metafacture.biblio.marc21.Marc21EventNames#TYPE_OF_CONTROL_LITERAL}
+ *   <li>{@value org.metafacture.biblio.marc21.Marc21EventNames#CHARACTER_CODING_LITERAL}
+ *   <li>{@value org.metafacture.biblio.marc21.Marc21EventNames#ENCODING_LEVEL_LITERAL}
+ *   <li>{@value org.metafacture.biblio.marc21.Marc21EventNames#CATALOGING_FORM_LITERAL}
+ *   <li>{@value org.metafacture.biblio.marc21.Marc21EventNames#MULTIPART_LEVEL_LITERAL}
  * </ol>
  * The literals are emitted in the order in which they are listed here. The
  * values of these literals are the characters at the corresponding
  * positions in the record leader (see
  * <a href="http://www.loc.gov/marc/bibliographic/bdleader.html">MARC 21
  * Standard: Record Leader</a> for a description of the allowed values). The
  * literal values are always only single characters. As this decoder only
- * supports MARC 21 records with UTF-8 encoding, the value of the <i>literal
- * &quot;{@value Marc21EventNames#CHARACTER_CODING_LITERAL}&quot;</i> will
- * always be &quot;a&quot;.
+ * supports MARC 21 records with UTF-8 encoding, the value of the literal
+ * {@value org.metafacture.biblio.marc21.Marc21EventNames#CHARACTER_CODING_LITERAL}
+ * will always be &quot;a&quot;.
  * <p>
  * For example, given a record with the leader
  * <pre>
@@ -86,15 +87,15 @@
  * the following event stream will be emitted:
  * <pre>
  * start-record &quot;1&quot;
- * start-entity &quot;{@value Marc21EventNames#LEADER_ENTITY}&quot;
- * literal &quot;{@value Marc21EventNames#RECORD_STATUS_LITERAL}&quot;: n
- * literal &quot;{@value Marc21EventNames#RECORD_TYPE_LITERAL}&quot;: o
- * literal &quot;{@value Marc21EventNames#BIBLIOGRAPHIC_LEVEL_LITERAL}&quot;: a
- * literal &quot;{@value Marc21EventNames#TYPE_OF_CONTROL_LITERAL}&quot;: " "
- * literal &quot;{@value Marc21EventNames#CHARACTER_CODING_LITERAL}&quot;: a
- * literal &quot;{@value Marc21EventNames#ENCODING_LEVEL_LITERAL}&quot;: z
- * literal &quot;{@value Marc21EventNames#CATALOGING_FORM_LITERAL}&quot;: u
- * literal &quot;{@value Marc21EventNames#MULTIPART_LEVEL_LITERAL}&quot;: " "
+ * start-entity {@value org.metafacture.biblio.marc21.Marc21EventNames#LEADER_ENTITY}
+ * literal {@value org.metafacture.biblio.marc21.Marc21EventNames#RECORD_STATUS_LITERAL}: n
+ * literal {@value org.metafacture.biblio.marc21.Marc21EventNames#RECORD_TYPE_LITERAL}: o
+ * literal {@value org.metafacture.biblio.marc21.Marc21EventNames#BIBLIOGRAPHIC_LEVEL_LITERAL}: a
+ * literal {@value org.metafacture.biblio.marc21.Marc21EventNames#TYPE_OF_CONTROL_LITERAL}: " "
+ * literal {@value org.metafacture.biblio.marc21.Marc21EventNames#CHARACTER_CODING_LITERAL}: a
+ * literal {@value org.metafacture.biblio.marc21.Marc21EventNames#ENCODING_LEVEL_LITERAL}: z
+ * literal {@value org.metafacture.biblio.marc21.Marc21EventNames#CATALOGING_FORM_LITERAL}: u
+ * literal {@value org.metafacture.biblio.marc21.Marc21EventNames#MULTIPART_LEVEL_LITERAL}: " "
  * end-entity
  * &hellip;
  * </pre>
@@ -124,7 +125,8 @@
  * If the decoder receives an empty input string it is ignored and no stream
  * events are emitted.
  * <p>
- * If an error occurs during decoding, a {@link FormatException} is thrown.
+ * If an error occurs during decoding, a
+ * {@link org.metafacture.framework.FormatException} is thrown.
  *
  * @author Christoph Böhme
  * @see "ISO 2709:2008 Standard"

metafacture-javaintegration/src/main/java/org/metafacture/javaintegration/MapToStream.java

@@ -31,7 +31,7 @@
  * event is emitted.
  * <p>
  * If the map contains an entry whose key value matches the one set as
- * {@link #setIdKey(Object)}, this entry's value is used as the record id.
+ * {@link #setIdKey(Object)}, this entry's value is used as the record ID.
  * <p>
  * The keys and values in the map can be of any type. They will be converted to
  * strings using their {@link Object#toString()} method. Neither key nor value
@@ -68,14 +68,15 @@ public MapToStream() {
     }
 
     /**
-     * Sets the key of the map entry that is used for the record id.
+     * Sets the key of the map entry that is used for the record ID.
      * <p>
-     * The default id key is &quot;{@value StandardEventNames#ID}&quot;.
+     * The default ID key is
+     * {@value org.metafacture.framework.StandardEventNames#ID}.
      * <p>
      * This parameter can be changed anytime during processing. The new value
      * becomes effective with the next record being processed.
      *
-     * @param idKey the id key. The object passed here is used in a call to
+     * @param idKey the ID key. The object passed here is used in a call to
      * {@link Map#get(Object)} to get the identifier value.
      */
     public void setIdKey(final Object idKey) {

metafacture-mangling/src/main/java/org/metafacture/mangling/RecordIdChanger.java

@@ -26,13 +26,13 @@
 import org.metafacture.framework.helpers.DefaultStreamPipe;
 
 /**
- * Replaces the record id with the value of a literal from the record. The name
+ * Replaces the record ID with the value of a literal from the record. The name
  * of the literal can be configured using {@link #setIdLiteral(String)}.
  * <p>
  * If a record contains multiple matching literals, the value of the last
- * literal is used as id.
+ * literal is used as ID.
  * <p>
- * This module can optionally remove records which do not have an id literal
+ * This module can optionally remove records which do not have an ID literal
  * from the stream. This is configured through the
  * {@link #setKeepRecordsWithoutIdLiteral(boolean)} parameter.
  * <p>
@@ -57,14 +57,14 @@
  * end-record
  * }</pre>
  *
- * By default, the id literals are removed from the record. This can be changed
+ * By default, the ID literals are removed from the record. This can be changed
  * through {@link #setKeepIdLiteral(boolean)}.
  *
  * @author Markus Michael Geipel
  * @author Christoph Böhme
  *
  */
-@Description("By default changes the record id to the value of the '_id' literal (if present). Use the contructor to choose another literal as id source.")
+@Description("By default changes the record ID to the value of the '_id' literal (if present). Use the contructor to choose another literal as ID source.")
 @In(StreamReceiver.class)
 @Out(StreamReceiver.class)
 @FluxCommand("change-id")
@@ -83,15 +83,16 @@ public RecordIdChanger() {
     }
 
     /**
-     * Sets the name of the literal that contains the new record id. This must be
+     * Sets the name of the literal that contains the new record ID. This must be
      * a qualified literal name including the entities in which the literal is
      * contained.
      * <p>
-     * For instance, the id literal &ldquo;metadata.id&rdquo; matches only
+     * For instance, the ID literal &ldquo;metadata.id&rdquo; matches only
      * literals named &ldquo;id&rdquo; which are part of an entity named
      * &ldquo;metadata&rdquo;.
      * <p>
-     * The default value is &ldquo;{@value StandardEventNames#ID}&rdquo;.
+     * The default value is
+     * {@value org.metafacture.framework.StandardEventNames#ID}.
      * <p>
      * This parameter must only be changed between records otherwise the
      * behaviour of the module is undefined.
@@ -107,15 +108,15 @@ public String getIdLiteral() {
     }
 
     /**
-     * Controls whether records without an id literal are kept in the stream or
+     * Controls whether records without an ID literal are kept in the stream or
      * removed from the stream.
      * <p>
-     * By default records without an id literal are kept in the stream.
+     * By default records without an ID literal are kept in the stream.
      * <p>
      * This parameter may be changed at any time it becomes effective with the
      * next <i>end-record</i> event.
      *
-     * @param keepRecordsWithoutIdLiteral true to keep records without id
+     * @param keepRecordsWithoutIdLiteral true to keep records without ID
      * literal, false to remove them
      */
     public void setKeepRecordsWithoutIdLiteral(
@@ -128,16 +129,16 @@ public boolean getKeepRecordsWithoutIdLiteral() {
     }
 
     /**
-     * Controls whether the id literal is kept in the record after changing the
-     * record id. If a record contains multiple id literals, all of them are
+     * Controls whether the ID literal is kept in the record after changing the
+     * record ID. If a record contains multiple ID literals, all of them are
      * removed.
      * <p>
-     * By default the id literal is removed from the stream.
+     * By default the ID literal is removed from the stream.
      * <p>
      * This parameter must only be changed between records otherwise the
      * behaviour of the module is undefined.
      *
-     * @param keepIdLiteral true to keep id literals in records, false to
+     * @param keepIdLiteral true to keep ID literals in records, false to
      * remove them
      */
     public void setKeepIdLiteral(final boolean keepIdLiteral) {