Fix javadoc for module "biblio" (#396)

Result of 0630ffa.

Author: dr0i

metafacture-biblio/src/main/java/org/metafacture/biblio/AlephMabXmlHandler.java

@@ -50,6 +50,9 @@ public final class AlephMabXmlHandler extends DefaultXmlPipe<StreamReceiver> {
     private String currentTag = "";
     private StringBuilder builder = new StringBuilder();
 
+    /**
+     * Creates instance of {@link AlephMabXmlHandler}.
+     */
     public AlephMabXmlHandler() {
     }
 

metafacture-biblio/src/main/java/org/metafacture/biblio/AseqDecoder.java

@@ -42,6 +42,9 @@ public final class AseqDecoder extends DefaultObjectPipe<String, StreamReceiver>
     private static final int RECORD_IDENTIFIER_BEGIN = 0;
     private static final int RECORD_IDENTIFIER_END = 9;
 
+    /**
+     * Creates an instance of {@link AseqDecoder}.
+     */
     public AseqDecoder() {
     }
 

metafacture-biblio/src/main/java/org/metafacture/biblio/ComarcXmlHandler.java

@@ -63,6 +63,9 @@ public class ComarcXmlHandler extends DefaultXmlPipe<StreamReceiver> {
     private String currentTag = "";
     private StringBuilder builder = new StringBuilder();
 
+    /**
+     * Creates an instance of {@link ComarcXmlHandler}.
+     */
     public ComarcXmlHandler() {
     }
 

metafacture-biblio/src/main/java/org/metafacture/biblio/MabDecoder.java

@@ -57,6 +57,9 @@ public final class MabDecoder extends DefaultObjectPipe<String, StreamReceiver>
     private static final String ID_TAG = "001 ";
     private static final int TAG_LENGTH = 4;
 
+    /**
+     * Creates an instance of {@link MabDecoder}.
+     */
     public MabDecoder() {
     }
 

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

@@ -24,14 +24,42 @@
  */
 public interface FieldHandler {
 
+    /**
+     * Reference a field.
+     *
+     * @param tag             the tag
+     * @param implDefinedPart the impl defined part
+     * @param value           the value
+     */
     void referenceField(char[] tag, char[] implDefinedPart, String value);
 
+    /**
+     * Starts a data field.
+     *
+     * @param tag             the tag
+     * @param implDefinedPart the impl defined part
+     * @param indicators      the indicators
+     */
     void startDataField(char[] tag, char[] implDefinedPart, char[] indicators);
 
+    /**
+     * Ends the data field.
+     */
     void endDataField();
 
+    /**
+     * Sets the impl defined part.
+     *
+     * @param implDefinedPart he impl defined part
+     */
     void additionalImplDefinedPart(char[] implDefinedPart);
 
+    /**
+     * Sets the identifier to a value.
+     *
+     * @param identifier the identifier
+     * @param value      the value
+     */
     void data(char[] identifier, String value);
 
 }

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

@@ -91,22 +91,47 @@ private int findRecordIdFieldStart() {
         return RECORD_ID_MISSING;
     }
 
+    /**
+     * Gets the record format of the Label.
+     *
+     * @return the record format of the Label
+     */
     public RecordFormat getRecordFormat() {
         return label.getRecordFormat();
     }
 
+    /**
+     * Gets the record status of the Label.
+     *
+     * @return the record status of the Label
+     */
     public char getRecordStatus() {
         return label.getRecordStatus();
     }
 
+    /**
+     * Gets the impl codes.
+     *
+     * @return the impl codes
+     */
     public char[] getImplCodes() {
         return label.getImplCodes();
     }
 
+    /**
+     * Gets the systems chars of the Label.
+     *
+     * @return the system chars
+     */
     public char[] getSystemChars() {
         return label.getSystemChars();
     }
 
+    /**
+     * Gets the reserved char of the Label.
+     *
+     * @return the reserved char
+     */
     public char getReservedChar() {
         return label.getReservedChar();
     }

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

@@ -99,6 +99,11 @@ public void setCharset(final Charset charset) {
         fields.setCharset(Require.notNull(charset));
     }
 
+    /**
+     * Gets the Charset of the FieldsBuilder.
+     *
+     * @return the Charset
+     */
     public Charset getCharset() {
         return fields.getCharset();
     }
@@ -208,6 +213,13 @@ public void appendIdentifierField(final char[] currentImplDefinedPart, final Str
         appendReferenceField(ID_FIELD_TAG, currentImplDefinedPart, value);
     }
 
+    /**
+     * Appends a reference field in dependency of the current tag and of the default
+     * impl defined part.
+     *
+     * @param currentTag char array of the current tag
+     * @param value      String that is appended as a reference field
+     */
     public void appendReferenceField(final char[] currentTag, final String value) {
         appendReferenceField(currentTag, defaultImplDefinedPart, value);
     }
@@ -249,10 +261,22 @@ private void checkValidReferenceFieldTag(final char[] currentTag) {
         }
     }
 
+    /**
+     * Starts a data field in dependency of the current tag and default indicators.
+     *
+     * @param currentTag char array of the current tag
+     */
     public void startDataField(final char[] currentTag) {
         startDataField(currentTag, defaultIndicators);
     }
 
+    /**
+     * Starts a data field in dependency of the current tag, indicators and of the
+     * default impl defined part.
+     *
+     * @param currentTag char array of the current tag
+     * @param indicators char array of the current indicators
+     */
     public void startDataField(final char[] currentTag, final char[] indicators) {
         startDataField(currentTag, indicators, defaultImplDefinedPart);
     }

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

@@ -109,22 +109,47 @@ public static Builder createFrom(final RecordFormat source) {
                 .withImplDefinedPartLength(source.implDefinedPartLength);
     }
 
+    /**
+     * Gets the length of the indicator.
+     *
+     * @return the length of the indicator
+     */
     public int getIndicatorLength() {
         return indicatorLength;
     }
 
+    /**
+     * Gets the length of the identifier.
+     *
+     * @return the length of the identifier
+     */
     public int getIdentifierLength() {
         return identifierLength;
     }
 
+    /**
+     * Gets the length of the field length.
+     *
+     * @return the length of the field length
+     */
     public int getFieldLengthLength() {
         return fieldLengthLength;
     }
 
+    /**
+     * Gets the length of the field start.
+     *
+     * @return length of the field start
+     */
     public int getFieldStartLength() {
         return fieldStartLength;
     }
 
+    /**
+     * Gets the the length of the defined part.
+     *
+     * @return the length of the defined part
+     */
     public int getImplDefinedPartLength() {
         return implDefinedPartLength;
     }

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

@@ -139,33 +139,45 @@
 @FluxCommand("decode-marc21")
 public final class Marc21Decoder extends DefaultObjectPipe<String, StreamReceiver> {
 
+    public static final boolean EMIT_LEADER_AS_WHOLE = false;
+    public static final boolean IGNORE_MISSING_ID = false;
+
     private final FieldHandler fieldHandler = new Marc21Handler();
 
-    private boolean ignoreMissingId;
-    private boolean emitLeaderAsWhole;
+    private boolean ignoreMissingId = IGNORE_MISSING_ID;
+    private boolean emitLeaderAsWhole = EMIT_LEADER_AS_WHOLE;
 
+    /**
+     * Creates an instance of {@link Marc21Decoder}.
+     */
     public Marc21Decoder() {
     }
 
     /**
-     * Controls whether the decoder aborts processing if a record has no
-     * identifier. A {@link MissingIdException} is thrown in these cases.
-     * If this parameter is set to true then the identifier emitted with the
-     * <i>start-record</i> event of records without field &quot;001&quot; will
-     * be an empty string.
+     * Controls whether the decoder aborts processing if a record has no identifier.
+     * A {@link MissingIdException} is thrown in these cases. If this parameter is
+     * set to true then the identifier emitted with the <i>start-record</i> event of
+     * records without field &quot;001&quot; will be an empty string.
      * <p>
-     * The default value of {@code ignoreMissingId} is false.
+     * <strong>Default value: {@value #IGNORE_MISSING_ID}</strong>
      * <p>
      * This parameter can be changed anytime during processing. The new value
      * becomes effective with the next record being processed.
      *
-     * @param ignoreMissingId
-     *            true if missing identifiers should be silently ignored.
+     * @param ignoreMissingId true if missing identifiers should be silently
+     *                        ignored.
      */
     public void setIgnoreMissingId(final boolean ignoreMissingId) {
         this.ignoreMissingId = ignoreMissingId;
     }
 
+    /**
+     * Gets the flag to decide whether to abort the processing of a record if it has
+     * no identifier.
+     *
+     * @return true if a missing identifier shouldn't abort processing, otherwise
+     *         false
+     */
     public boolean getIgnoreMissingId() {
         return ignoreMissingId;
     }
@@ -174,16 +186,22 @@ public boolean getIgnoreMissingId() {
      * Controls whether the Record Leader should be emitted as a whole instead of
      * extracting the bibliographic information in the record leader.
      *
-     * @see <a href="http://www.loc.gov/marc/bibliographic/bdleader.html">MARC 21
-     * Standard: Record Leader</a>
+     * <strong>Default value: {@value #EMIT_LEADER_AS_WHOLE}</strong>
      *
-     * @param emitLeaderAsWhole
-     *             true if the leader should be emitted as a whole.
+     * @see <a href="http://www.loc.gov/marc/bibliographic/bdleader.html">MARC 21
+     *      Standard: Record Leader</a>
+     * @param emitLeaderAsWhole true if the leader should be emitted as a whole.
      */
     public void setEmitLeaderAsWhole(final boolean emitLeaderAsWhole) {
         this.emitLeaderAsWhole = emitLeaderAsWhole;
     }
 
+    /**
+     * Gets the flag to decide whether the Record Leader is emitted as whole instead
+     * of extracting the bibliographic information in the record leader.
+     *
+     * @return true if the Record Leader is emitted as whole, otherwise false
+     */
     public boolean getEmitLeaderAsWhole() {
         return emitLeaderAsWhole;
     }

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

@@ -106,6 +106,11 @@ public void setGenerateIdField(final boolean generateIdField) {
         this.generateIdField = generateIdField;
     }
 
+    /**
+     * Gets the flag to decide whether the ID field is generated.
+     *
+     * @return true if the record ID is generated, otherwise false
+     */
     public boolean getGenerateIdField() {
         return generateIdField;
     }