diff --git a/pom.xml b/pom.xml index c85fe9837..0f998e9ae 100644 --- a/pom.xml +++ b/pom.xml @@ -258,7 +258,6 @@ public true - -Xdoclint:none diff --git a/src/main/java/org/culturegraph/mf/biblio/marc21/Marc21Decoder.java b/src/main/java/org/culturegraph/mf/biblio/marc21/Marc21Decoder.java index a5e7f9246..2961b8dc8 100644 --- a/src/main/java/org/culturegraph/mf/biblio/marc21/Marc21Decoder.java +++ b/src/main/java/org/culturegraph/mf/biblio/marc21/Marc21Decoder.java @@ -55,7 +55,7 @@ *
  • multipart resource record level. * * This information is emitted as an entity named - * "{@value Marc21EventNames#LEADER_ENTITY}". It is emitted directly + * "{@value Marc21EventNames#LEADER_ENTITY}". It is emitted directly * after the start-record event. The entity contains the following * literals: *
      diff --git a/src/main/java/org/culturegraph/mf/commons/Require.java b/src/main/java/org/culturegraph/mf/commons/Require.java index 35a071493..fa7321155 100644 --- a/src/main/java/org/culturegraph/mf/commons/Require.java +++ b/src/main/java/org/culturegraph/mf/commons/Require.java @@ -31,7 +31,9 @@ private Require() { * Throws an {@link IllegalArgumentException} if {@code object} is * {@literal null}. * - * @return {@code object} + * @param type of the object passed as parameter + * @param object reference to be checked + * @return the {@code object} */ public static T notNull(final T object) { return notNull(object, "parameter must not be null"); @@ -41,9 +43,10 @@ public static T notNull(final T object) { * Throws an {@link IllegalArgumentException} if {@code object} is * {@literal null}. * - * @param message - * exception message - * @return {@code object} + * @param type of the object passed as parameter + * @param object reference to be checked + * @param message exception message + * @return the {@code object} */ public static T notNull(final T object, final String message) { if (object == null) { @@ -55,7 +58,8 @@ public static T notNull(final T object, final String message) { /** * Throws an {@link IllegalArgumentException} if {@code value} is negative. * - * @return {@code value} + * @param value the value to be checked + * @return the {@code value} */ public static int notNegative(final int value) { return notNegative(value, "parameter must not be negative"); @@ -64,9 +68,9 @@ public static int notNegative(final int value) { /** * Throws an {@link IllegalArgumentException} if {@code value} is negative. * - * @param message - * exception message - * @return {@code value} + * @param value the value to be checked + * @param message exception message + * @return the {@code value} */ public static int notNegative(final int value, final String message) { if (value < 0) { @@ -77,6 +81,8 @@ public static int notNegative(final int value, final String message) { /** * Throws an {@link IllegalArgumentException} if {@code condition} is false. + * + * @param condition the condition to be checked */ public static void that(final boolean condition) { that(condition, "parameter is not valid"); @@ -85,8 +91,8 @@ public static void that(final boolean condition) { /** * Throws an {@link IllegalArgumentException} if {@code condition} is false. * - * @param message - * exception message + * @param condition the condition to be checked + * @param message exception message */ public static void that(final boolean condition, final String message) { if (!condition) { @@ -98,7 +104,9 @@ public static void that(final boolean condition, final String message) { * Throws an {@link IndexOutOfBoundsException} if {@code index} is negative * or equal to or greater than {@code arrayLength}. * - * @return {@code index} + * @param index the index value to be checked + * @param arrayLength the upper bound against which {@code index} is checked + * @return the {@code index} */ public static int validArrayIndex(final int index, final int arrayLength) { return validArrayIndex(index, arrayLength, "array index out of range"); @@ -108,9 +116,10 @@ public static int validArrayIndex(final int index, final int arrayLength) { * Throws an {@link IndexOutOfBoundsException} if {@code index} is negative * or equal to or greater than {@code arrayLength}. * - * @param message - * exception message - * @return {@code index} + * @param index the index value to be checked + * @param arrayLength the upper bound against which {@code index} is checked + * @param message exception message + * @return the {@code index} */ public static int validArrayIndex(final int index, final int arrayLength, final String message) { @@ -125,6 +134,10 @@ public static int validArrayIndex(final int index, final int arrayLength, * {@code sliceLength} is negative or the sum of both is greater than * {@code arrayLength}. Note that this means that a slice of length zero * starting at array length is a valid slice. + * + * @param sliceFrom the start index of the slice to be checked + * @param sliceLength the length of the slice to be checked + * @param arrayLength the upper bound against which the slice is checked */ public static void validArraySlice(final int sliceFrom, final int sliceLength, final int arrayLength) { @@ -139,8 +152,10 @@ public static void validArraySlice(final int sliceFrom, * starting at array length is a valid slice. * * - * @param message - * exception message + * @param sliceFrom the start index of the slice to be checked + * @param sliceLength the length of the slice to be checked + * @param arrayLength the upper bound against which the slice is checked + * @param message exception message */ public static void validArraySlice(final int sliceFrom, final int sliceLength, final int arrayLength, final String message) { diff --git a/src/main/java/org/culturegraph/mf/commons/StringUtil.java b/src/main/java/org/culturegraph/mf/commons/StringUtil.java index 4e13c498e..072fcbb29 100644 --- a/src/main/java/org/culturegraph/mf/commons/StringUtil.java +++ b/src/main/java/org/culturegraph/mf/commons/StringUtil.java @@ -101,7 +101,7 @@ public static String format(final String format, final String varStartIndicator, * Copies the contents of {@code str} into the {@code currentBuffer}. If the size of * the buffer is not sufficient to store the string then a new buffer is allocated. * {@code copyToBuffer} is intended to be used as shown in the example: - * 
      +	 * 
      {@code
 	 *   final int INITIAL_SIZE = 10;
 	 *   char[] myBuffer = new char[INITIAL_SIZE];
 	 *
@@ -112,7 +112,7 @@ public static String format(final String format, final String varStartIndicator,
 	 *     // Process data in myBuffer in the range from 0 to dataLen
 	 *   }
 	 *   myBuffer = null;
-	 * 
      
+	 * }
      * * This allows the buffer to be reused but at the same time frees the user from * having to manage the size of the buffer. diff --git a/src/main/java/org/culturegraph/mf/commons/XmlUtil.java b/src/main/java/org/culturegraph/mf/commons/XmlUtil.java index a69d80dd2..40ed342c3 100644 --- a/src/main/java/org/culturegraph/mf/commons/XmlUtil.java +++ b/src/main/java/org/culturegraph/mf/commons/XmlUtil.java @@ -31,8 +31,9 @@ /** - * @author Christoph Böhme + * Utility functions for working with XML data as strings. * + * @author Christoph Böhme */ public final class XmlUtil { diff --git a/src/main/java/org/culturegraph/mf/commons/tries/ACNode.java b/src/main/java/org/culturegraph/mf/commons/tries/ACNode.java index 29b0cbffb..c86755084 100644 --- a/src/main/java/org/culturegraph/mf/commons/tries/ACNode.java +++ b/src/main/java/org/culturegraph/mf/commons/tries/ACNode.java @@ -21,9 +21,10 @@ /** - * @author Markus Michael Geipel + * Node representing a character in a trie. * - * @param

      + * @param

      type of the value associated with this node in the trie. + * @author Markus Michael Geipel */ final class ACNode

      { diff --git a/src/main/java/org/culturegraph/mf/commons/tries/CharMap.java b/src/main/java/org/culturegraph/mf/commons/tries/CharMap.java index f9fae8f57..d21fc8b64 100644 --- a/src/main/java/org/culturegraph/mf/commons/tries/CharMap.java +++ b/src/main/java/org/culturegraph/mf/commons/tries/CharMap.java @@ -21,12 +21,13 @@ import java.util.Set; /** - * A {@link Map} with char as key. Used for set matching, tries etc.
      - * Important: It is optimized for size in memory. No extra information for fast entry/keySet/values iteration etc. is held. + * A {@link Map} with char as key. Used for set matching, tries etc. * - * @author Markus Michael Geipel + * Important: It is optimized for size in memory. No extra + * information for fast entry/keySet/values iteration etc. is held. * - * @param + * @param type of the values in the map + * @author Markus Michael Geipel */ final class CharMap implements Map { @@ -88,11 +89,6 @@ public V put(final Character key, final V value) { return null; } - /** - * @param key - * @param value - * @return the parameter value - */ public void put(final char key, final V value) { if (size > LOAD_FACTOR * table.length) { expand(); @@ -190,8 +186,9 @@ public Set> entrySet() { } /** + * Entry in the map. * - * @param + * @param type of the value of the entry. */ private static final class Entry implements Map.Entry { private final char key; @@ -236,5 +233,7 @@ public V setValue(final V value) { public String toString() { return key + "=" + value; } + } + } diff --git a/src/main/java/org/culturegraph/mf/commons/tries/SetMatcher.java b/src/main/java/org/culturegraph/mf/commons/tries/SetMatcher.java index 24d198909..92c48523d 100644 --- a/src/main/java/org/culturegraph/mf/commons/tries/SetMatcher.java +++ b/src/main/java/org/culturegraph/mf/commons/tries/SetMatcher.java @@ -23,15 +23,13 @@ import java.util.Queue; /** - * Implementation of the Aho-Corasick algorithm + * Implementation of the Aho-Corasick algorithm. * + * @param type of stored value * @author Markus Michael Geipel - * - * @param - * type of value stored */ public final class SetMatcher { - private final ACNode root = new ACNode(null, 0); + private final ACNode root = new ACNode<>(null, 0); private boolean isPrepared; public void put(final String key, final T value) { @@ -129,9 +127,10 @@ private void prepare() { } /** - * prints dot description of the automaton to out for visualization in GraphViz. Used for debugging and education. + * Prints dot description of the automaton to out for visualization in + * GraphViz. Used for debugging and education. * - * @param out + * @param out the stream t which the description is written */ public void printAutomaton(final PrintStream out) { out.println("digraph ahocorasick {"); @@ -156,8 +155,9 @@ private void printDebug(final PrintStream out, final ACNode node) { } /** + * Describes a match. * - * @param + * @param type of the stored value */ public static final class Match { private final T value; @@ -187,5 +187,7 @@ public int getLength() { public String toString() { return value + " " + start + "+" + length; } + } + } diff --git a/src/main/java/org/culturegraph/mf/commons/tries/SimpleRegexTrie.java b/src/main/java/org/culturegraph/mf/commons/tries/SimpleRegexTrie.java index 20b6da36b..02844ca03 100644 --- a/src/main/java/org/culturegraph/mf/commons/tries/SimpleRegexTrie.java +++ b/src/main/java/org/culturegraph/mf/commons/tries/SimpleRegexTrie.java @@ -39,8 +39,8 @@ public SimpleRegexTrie() { * Enables the use of simple character classes like 'a[agt][ac]'. Calls the * method of {@link WildcardTrie} for further treatment. * - * @param keys - * @param value + * @param keys pattern of keys + * @param value value to associate with the key pattern */ public void put(final String keys, final P value) { if (keys.matches(".*" + SIMPLE_CHARACTER_CLASS + ".*")) { diff --git a/src/main/java/org/culturegraph/mf/commons/tries/SimpleTrie.java b/src/main/java/org/culturegraph/mf/commons/tries/SimpleTrie.java index 74d816d4a..d11726557 100644 --- a/src/main/java/org/culturegraph/mf/commons/tries/SimpleTrie.java +++ b/src/main/java/org/culturegraph/mf/commons/tries/SimpleTrie.java @@ -16,14 +16,13 @@ package org.culturegraph.mf.commons.tries; /** - * A simple Trie, nothing fancy at all + * A simple Trie, nothing fancy at all. * - * @author Markus Michael Geipel - * @param

      type of value stored + * @author Markus Michael Geipel */ public final class SimpleTrie

      { - private final Node

      root = new Node

      (null); + private final Node

      root = new Node<>(null); public void put(final String key, final P value){ @@ -58,8 +57,9 @@ public P get(final String key){ } /** + * Node in the trie. * - * @param

      + * @param

      type of the value associated with this node. */ private static final class Node

      { private final P value; diff --git a/src/main/java/org/culturegraph/mf/commons/tries/WildcardTrie.java b/src/main/java/org/culturegraph/mf/commons/tries/WildcardTrie.java index 75f6263cb..60a9b8f90 100644 --- a/src/main/java/org/culturegraph/mf/commons/tries/WildcardTrie.java +++ b/src/main/java/org/culturegraph/mf/commons/tries/WildcardTrie.java @@ -26,11 +26,9 @@ /** * A simple Trie, which accepts a trailing wildcard * + * @param

      type of value stored * @author Markus Michael Geipel * @author Pascal Christoph - * - * @param

      - * type of value stored */ public final class WildcardTrie

      { public static final char STAR_WILDCARD = '*'; @@ -44,11 +42,11 @@ public final class WildcardTrie

      { private Set> nextNodes = new HashSet>(); /** - * inserts keys into the try. Use '|' to concatenate. Use '*' (0,inf) and + * Inserts keys into the try. Use '|' to concatenate. Use '*' (0,inf) and * '?' (1,1) to express wildcards. * - * @param keys - * @param value + * @param keys pattern of keys to register + * @param value value to associate with the key pattern. */ public void put(final String keys, final P value) { if (keys.contains(OR_STRING)) { @@ -126,8 +124,9 @@ public List

      get(final String key) { } /** + * Node in the trie. * - * @param + * @param type of the value associated with this node. */ private final class Node { diff --git a/src/main/java/org/culturegraph/mf/commons/types/ScopedHashMap.java b/src/main/java/org/culturegraph/mf/commons/types/ScopedHashMap.java index 7d43e7c53..0de6091fc 100644 --- a/src/main/java/org/culturegraph/mf/commons/types/ScopedHashMap.java +++ b/src/main/java/org/culturegraph/mf/commons/types/ScopedHashMap.java @@ -16,12 +16,15 @@ package org.culturegraph.mf.commons.types; import java.util.HashMap; +import java.util.Map; /** - * @author "Markus Michael Geipel" + * Implementation of {@link Map} that delegates to another map if it does not + * contain a value for key. * - * @param - * @param + * @param type of the keys + * @param type of the values + * @author Markus Michael Geipel */ public final class ScopedHashMap extends HashMap { diff --git a/src/main/java/org/culturegraph/mf/flowcontrol/ObjectPipeDecoupler.java b/src/main/java/org/culturegraph/mf/flowcontrol/ObjectPipeDecoupler.java index 3c2d3d98a..5249df78e 100644 --- a/src/main/java/org/culturegraph/mf/flowcontrol/ObjectPipeDecoupler.java +++ b/src/main/java/org/culturegraph/mf/flowcontrol/ObjectPipeDecoupler.java @@ -28,10 +28,9 @@ import org.slf4j.LoggerFactory; /** - * creates a new thread in which subsequent flow elements run. + * Creates a new thread in which subsequent flow elements run. * - * @param - * Object type + * @param Object type * * @author Markus Micheal Geipel */ @@ -114,7 +113,8 @@ public void closeStream() { /** * Pushes the content in the {@link BlockingQueue} to the receiver. - * @param + * + * @param the type of objects the {@link ObjectPipeDecoupler} works on */ static final class Feeder implements Runnable { public static final Object RED_PILL = new Object(); diff --git a/src/main/java/org/culturegraph/mf/flux/FluxCompiler.java b/src/main/java/org/culturegraph/mf/flux/FluxCompiler.java index a529c0a0c..cd74e9b44 100644 --- a/src/main/java/org/culturegraph/mf/flux/FluxCompiler.java +++ b/src/main/java/org/culturegraph/mf/flux/FluxCompiler.java @@ -29,10 +29,9 @@ import org.culturegraph.mf.flux.parser.FluxProgramm; /** - * Creates a {@link Flow} based on a flux script - * - * @author markus geipel + * Creates a flow based on a flux script. * + * @author Markus Michael Geipel */ public final class FluxCompiler { private FluxCompiler() { diff --git a/src/main/java/org/culturegraph/mf/framework/FluxCommand.java b/src/main/java/org/culturegraph/mf/framework/FluxCommand.java index 45e5f90ea..348851ebf 100644 --- a/src/main/java/org/culturegraph/mf/framework/FluxCommand.java +++ b/src/main/java/org/culturegraph/mf/framework/FluxCommand.java @@ -36,7 +36,9 @@ public @interface FluxCommand { /** - * Returns the flux command name. + * Returns the Flux command name. + * + * @return Flux command name */ String value(); diff --git a/src/main/java/org/culturegraph/mf/framework/Sender.java b/src/main/java/org/culturegraph/mf/framework/Sender.java index 8d48c554e..6c0b607a8 100644 --- a/src/main/java/org/culturegraph/mf/framework/Sender.java +++ b/src/main/java/org/culturegraph/mf/framework/Sender.java @@ -32,7 +32,8 @@ public interface Sender extends LifeCycle { /** * Connect to a downstream module. * - * @param reference to the downstream module + * @param type of the receiver of the downstream module + * @param receiver the downstream module to which the sender should connect * @return reference to the downstream receiver to enable method chaining */ R setReceiver(R receiver); diff --git a/src/main/java/org/culturegraph/mf/framework/Tee.java b/src/main/java/org/culturegraph/mf/framework/Tee.java index a5a056749..e3a3a736e 100644 --- a/src/main/java/org/culturegraph/mf/framework/Tee.java +++ b/src/main/java/org/culturegraph/mf/framework/Tee.java @@ -34,8 +34,9 @@ public interface Tee extends Sender { /** * Replaces all receivers attached to the module with {@code receiver}. * - * @param receiver - * @return the parameter 'receiver' + * @param type of the receiver of the downstream module + * @param receiver the downstream module to which the tee should connect + * @return reference to the downstream receiver for method chaining */ @Override R setReceiver(R receiver); @@ -44,32 +45,35 @@ public interface Tee extends Sender { * Sets two receivers and returns the first. All other * receivers attached to the module are removed. * - * @param receiver - * @param lateralReceiver - * @return the parameter 'receiver' + * @param type of the receiver of the downstream module + * @param receiver the main downstream module to which the tee should connect + * @param lateralReceiver the second downstream module to which the tee should + * connect + * @return reference to the main downstream receiver for method chaining */ R setReceivers(R receiver, T lateralReceiver); /** * Adds receiver even if receiver is already added. * - * @param receiver - * @return this + * @param receiver a downstream module to which the tee should connect + * @return reference to the tee for method chaining */ Tee addReceiver(T receiver); /** * Removes a receiver from the list of receivers. * - * @param receiver - * @return this + * @param receiver the downstream receiver to remove from the list of + * connected receivers. + * @return reference to the tee for method chaining */ Tee removeReceiver(T receiver); /** * Clears the list of receivers. * - * @return this + * @return reference to the tee for method chaining */ Tee clearReceivers(); diff --git a/src/main/java/org/culturegraph/mf/framework/XmlReceiver.java b/src/main/java/org/culturegraph/mf/framework/XmlReceiver.java index ce60e0b62..a92502df7 100644 --- a/src/main/java/org/culturegraph/mf/framework/XmlReceiver.java +++ b/src/main/java/org/culturegraph/mf/framework/XmlReceiver.java @@ -15,6 +15,7 @@ */ package org.culturegraph.mf.framework; +import org.culturegraph.mf.framework.helpers.DefaultXMLReceiver; import org.xml.sax.ContentHandler; import org.xml.sax.DTDHandler; import org.xml.sax.EntityResolver; @@ -26,7 +27,7 @@ * This is just a combination of the SAX handler interfaces * and the metastream {@link LifeCycle} interface. * - * @see DefaultXmlReceiver + * @see DefaultXMLReceiver * @see XmlPipe * @author Christoph Böhme diff --git a/src/main/java/org/culturegraph/mf/framework/helpers/DefaultXMLReceiver.java b/src/main/java/org/culturegraph/mf/framework/helpers/DefaultXMLReceiver.java index 54a9a0103..82d2f1b8e 100644 --- a/src/main/java/org/culturegraph/mf/framework/helpers/DefaultXMLReceiver.java +++ b/src/main/java/org/culturegraph/mf/framework/helpers/DefaultXMLReceiver.java @@ -33,7 +33,7 @@ * * @see DefaultStreamPipe - * @author Christoph Böhme + * @author Christoph Böhme * */ public class DefaultXMLReceiver extends DefaultLifeCycle implements XmlReceiver { diff --git a/src/main/java/org/culturegraph/mf/io/AbstractObjectWriter.java b/src/main/java/org/culturegraph/mf/io/AbstractObjectWriter.java index 55c37ed22..8bef72d29 100644 --- a/src/main/java/org/culturegraph/mf/io/AbstractObjectWriter.java +++ b/src/main/java/org/culturegraph/mf/io/AbstractObjectWriter.java @@ -18,10 +18,8 @@ /** * Common functions for object writers. * + * @param object type * @author Christoph Böhme - * - * @param - * object type */ public abstract class AbstractObjectWriter implements ConfigurableObjectWriter { diff --git a/src/main/java/org/culturegraph/mf/io/ConfigurableObjectWriter.java b/src/main/java/org/culturegraph/mf/io/ConfigurableObjectWriter.java index 18bdb51eb..f430e6dc1 100644 --- a/src/main/java/org/culturegraph/mf/io/ConfigurableObjectWriter.java +++ b/src/main/java/org/culturegraph/mf/io/ConfigurableObjectWriter.java @@ -22,9 +22,8 @@ * a default set of configuration options. These are defined by * this interface. * - * @author Christoph Böhme - * * @param object type + * @author Christoph Böhme */ public interface ConfigurableObjectWriter extends ObjectReceiver { @@ -57,14 +56,14 @@ public interface ConfigurableObjectWriter extends ObjectReceiver { /** * Sets the compression mode. * - * @param compression + * @param compression type of compression */ void setCompression(final FileCompression compression); /** * Sets the compression mode. * - * @param compression + * @param compression type of compression */ void setCompression(final String compression); diff --git a/src/main/java/org/culturegraph/mf/io/HttpOpener.java b/src/main/java/org/culturegraph/mf/io/HttpOpener.java index d7b2a0445..bce03c0e7 100644 --- a/src/main/java/org/culturegraph/mf/io/HttpOpener.java +++ b/src/main/java/org/culturegraph/mf/io/HttpOpener.java @@ -35,7 +35,6 @@ * * @author Christoph Böhme * @author Jan Schnasse - * */ @Description("Opens a http resource. Supports the setting of Accept and Accept-Charset as http header fields.") @In(String.class) @@ -51,6 +50,8 @@ public final class HttpOpener * Sets the HTTP accept header value. This is a mime-type such as text/plain * or text/html. The default value of the accept is */* which means * any mime-type. + * + * @param accept mime-type to use for the HTTP accept header */ public void setAccept(final String accept) { this.accept = accept; @@ -61,6 +62,9 @@ public void setAccept(final String accept) { * accept-charset header. Additonally, the encoding is used for reading the * HTTP resonse if it does not specify an encoding. The default value for * the encoding is UTF-8. + * + * @param encoding name of the encoding used for the accept-charset HTTP + * header */ public void setEncoding(final String encoding) { this.encoding = encoding; diff --git a/src/main/java/org/culturegraph/mf/javaintegration/NamedValueSet.java b/src/main/java/org/culturegraph/mf/javaintegration/NamedValueSet.java index 781df58c7..3158995a3 100644 --- a/src/main/java/org/culturegraph/mf/javaintegration/NamedValueSet.java +++ b/src/main/java/org/culturegraph/mf/javaintegration/NamedValueSet.java @@ -29,7 +29,6 @@ * duplicates. * * @author Markus Michael Geipel - * */ public final class NamedValueSet extends DefaultStreamReceiver implements Set, Collector> { @@ -39,18 +38,20 @@ public final class NamedValueSet extends DefaultStreamReceiver public NamedValueSet() { super(); - set = new HashSet(); + set = new HashSet<>(); this.collection = null; } /** - * @param set - * is filled with the received results. + * Creates a {@code NamedValueSet} receiver which stores the received values + * in the passed set. + * + * @param collection is filled with the received results. */ public NamedValueSet(final Collection> collection) { super(); - set = new HashSet(); + set = new HashSet<>(); this.collection = collection; } diff --git a/src/main/java/org/culturegraph/mf/javaintegration/ValueSet.java b/src/main/java/org/culturegraph/mf/javaintegration/ValueSet.java index 78f6d1b72..a9b1cb755 100644 --- a/src/main/java/org/culturegraph/mf/javaintegration/ValueSet.java +++ b/src/main/java/org/culturegraph/mf/javaintegration/ValueSet.java @@ -37,18 +37,20 @@ public final class ValueSet extends DefaultStreamReceiver public ValueSet() { super(); - set = new HashSet(); + set = new HashSet<>(); this.collection = null; } /** - * @param set - * is filled with the received results. + * Creates a {@code ValueSet} receiver which stores the received values in the + * passed set. + * + * @param collection is filled with the received results. */ public ValueSet(final Collection> collection) { super(); - set = new HashSet(); + set = new HashSet<>(); this.collection = collection; } diff --git a/src/main/java/org/culturegraph/mf/javaintegration/pojo/MethodValueSetter.java b/src/main/java/org/culturegraph/mf/javaintegration/pojo/MethodValueSetter.java index 069f6c098..33a2f082f 100644 --- a/src/main/java/org/culturegraph/mf/javaintegration/pojo/MethodValueSetter.java +++ b/src/main/java/org/culturegraph/mf/javaintegration/pojo/MethodValueSetter.java @@ -24,7 +24,7 @@ /** * Invokes a setter method on an object. The method must be public, have exactly - * one argument and its name must begin with "set&quto;. + * one argument and its name must begin with "set". * * @author Thomas Seidel */ diff --git a/src/main/java/org/culturegraph/mf/metamorph/Registry.java b/src/main/java/org/culturegraph/mf/metamorph/Registry.java index eaa717e0e..099f44363 100644 --- a/src/main/java/org/culturegraph/mf/metamorph/Registry.java +++ b/src/main/java/org/culturegraph/mf/metamorph/Registry.java @@ -18,28 +18,28 @@ import java.util.List; /** - * used to access zero to n {@link Data} instances based on + * Used to access zero to n {@link Data} instances based on * a {@link String} path. Used in {@link Metamorph} * + * @param type of the values this registry holds. * @author Markus Michael Geipel - * - * @param */ interface Registry { /** - * add an instance of {@link Data} to a path. + * Binds a value to a path. * - * @param path - * @param data + * @param path the path to which the {@code value} is bound + * @param value the value which is bound to {@code path} */ void register(String path, T value); /** - * @param path - * @return matching {@link Data} instances. Should - * NEVER be null. If no matches - * found, an empty {@link List} is to be returned. + * Returns values registered on a path. + * + * @param path for which the registered values will be returned + * @return matching values. Should never be null. If no + * matches found, an empty {@link List} is to be returned. */ List get(String path); diff --git a/src/main/java/org/culturegraph/mf/metamorph/SimpleDataRegistry.java b/src/main/java/org/culturegraph/mf/metamorph/SimpleDataRegistry.java index e03449da5..e7499a12e 100644 --- a/src/main/java/org/culturegraph/mf/metamorph/SimpleDataRegistry.java +++ b/src/main/java/org/culturegraph/mf/metamorph/SimpleDataRegistry.java @@ -24,9 +24,8 @@ /** * Implements {@link Registry} with a {@link HashMap}. * + * @param type of the values this registry stores * @author Markus Michael Geipel - * - * @param */ final class SimpleDataRegistry implements Registry { diff --git a/src/main/java/org/culturegraph/mf/metamorph/WildcardDataRegistry.java b/src/main/java/org/culturegraph/mf/metamorph/WildcardDataRegistry.java index 92df4bdeb..400e47a74 100644 --- a/src/main/java/org/culturegraph/mf/metamorph/WildcardDataRegistry.java +++ b/src/main/java/org/culturegraph/mf/metamorph/WildcardDataRegistry.java @@ -23,8 +23,8 @@ /** * Implements {@link Registry} with a {@link WildcardTrie}. * + * @param type of the values this registry stores * @author Markus Michael Geipel - * @param */ final class WildcardRegistry implements Registry { diff --git a/src/main/java/org/culturegraph/mf/metamorph/api/helpers/AbstractReadOnlyMap.java b/src/main/java/org/culturegraph/mf/metamorph/api/helpers/AbstractReadOnlyMap.java index 66aa97e6c..cbb70bde4 100644 --- a/src/main/java/org/culturegraph/mf/metamorph/api/helpers/AbstractReadOnlyMap.java +++ b/src/main/java/org/culturegraph/mf/metamorph/api/helpers/AbstractReadOnlyMap.java @@ -23,10 +23,9 @@ * Base class for maps which are read only and do not allow access to their * full contents. * + * @param type of keys + * @param type of values * @author Markus Michael Geipel - * - * @param - * @param */ public abstract class AbstractReadOnlyMap implements Map { diff --git a/src/main/java/org/culturegraph/mf/metamorph/collectors/All.java b/src/main/java/org/culturegraph/mf/metamorph/collectors/All.java index 74c8eef34..bb9ae50a6 100644 --- a/src/main/java/org/culturegraph/mf/metamorph/collectors/All.java +++ b/src/main/java/org/culturegraph/mf/metamorph/collectors/All.java @@ -23,10 +23,9 @@ import org.culturegraph.mf.metamorph.api.helpers.AbstractFlushingCollect; /** - * Corresponds to the <all> tag. - * - * @author Christoph Böhme + * Corresponds to the {@code } tag. * + * @author Christoph Böhme */ public final class All extends AbstractFlushingCollect { diff --git a/src/main/java/org/culturegraph/mf/metamorph/collectors/Any.java b/src/main/java/org/culturegraph/mf/metamorph/collectors/Any.java index 34fb1e96f..cc9c2dfe5 100644 --- a/src/main/java/org/culturegraph/mf/metamorph/collectors/Any.java +++ b/src/main/java/org/culturegraph/mf/metamorph/collectors/Any.java @@ -20,10 +20,9 @@ import org.culturegraph.mf.metamorph.api.helpers.AbstractCollect; /** - * Corresponds to the <any> tag. - * - * @author Christoph Böhme + * Corresponds to the {@code } tag. * + * @author Christoph Böhme */ public final class Any extends AbstractCollect { diff --git a/src/main/java/org/culturegraph/mf/metamorph/collectors/Choose.java b/src/main/java/org/culturegraph/mf/metamorph/collectors/Choose.java index 34f8dcf3c..e1714bc62 100644 --- a/src/main/java/org/culturegraph/mf/metamorph/collectors/Choose.java +++ b/src/main/java/org/culturegraph/mf/metamorph/collectors/Choose.java @@ -25,10 +25,10 @@ /** - * Corresponds to the <choose> tag. - * - * @author Christoph Böhme , Markus Michael Geipel + * Corresponds to the {@code } tag. * + * @author Christoph Böhme + * @author Markus Michael Geipel */ public final class Choose extends AbstractFlushingCollect { diff --git a/src/main/java/org/culturegraph/mf/metamorph/collectors/None.java b/src/main/java/org/culturegraph/mf/metamorph/collectors/None.java index 5a89b5688..503904ea0 100644 --- a/src/main/java/org/culturegraph/mf/metamorph/collectors/None.java +++ b/src/main/java/org/culturegraph/mf/metamorph/collectors/None.java @@ -20,10 +20,9 @@ import org.culturegraph.mf.metamorph.api.helpers.AbstractCollect; /** - * Corresponds to the <none> tag. - * - * @author Christoph Böhme + * Corresponds to the {@code } tag. * + * @author Christoph Böhme */ public final class None extends AbstractCollect { diff --git a/src/main/java/org/culturegraph/mf/metamorph/functions/DateFormat.java b/src/main/java/org/culturegraph/mf/metamorph/functions/DateFormat.java index f52b09ee9..6f3c70745 100644 --- a/src/main/java/org/culturegraph/mf/metamorph/functions/DateFormat.java +++ b/src/main/java/org/culturegraph/mf/metamorph/functions/DateFormat.java @@ -29,24 +29,26 @@ /** * Format date/time strings in Metamorph. By default the input format is * dd.MM.yyyy and the output format is {@link java.text.DateFormat.Field#LONG}. - *
      + *

      * The Attribute removeLeadingZeros will remove all leading zeros from all * numbers in the output date. - *
      + *

      * The attribute era is used to specify if the date is BC or AD. Default * value is AUTO. To understand that, three short examples: - *

      • Input: 20.07.356 (era=BC)
        • - *
      • Output (German location): 20. Juli 0356 v. Chr.
        • - *
        • Input: 20.07.356 (era=AD,removeLeadingZeros=true)
          • - *
        • Output (German location): 20. Juli 356
          • - *
        • Input: 20.07.-356 (era=AUTO)
          • - *
        • Output (German location): 20. Juli 0357 v. Chr. (there is NO year 0; - * see ISO 8601, Proleptic Gregorian Calendar)
        - *

        + *

          + *
        • Input: 20.07.356 (era=BC) + *
        • Output (German location): 20. Juli 0356 v. Chr. + *
        • Input: 20.07.356 (era=AD,removeLeadingZeros=true) + *
        • Output (German location): 20. Juli 356 + *
        • Input: 20.07.-356 (era=AUTO) + *
        • Output (German location): 20. Juli 0357 v. Chr. (there is NO year 0; + * see ISO 8601, Proleptic Gregorian Calendar) + *
        * Examples of using this function in Metamorph: - *
        • Default date format: <dateformat />
          • - *
        • Read ISO-dates and generate German style dates: - * <dateformat inputformat="yyyy-MM-dd" outputformat="dd.MM.yyyy" />
          • + *
            + *
          • Default date format: {@code } + *
          • Read ISO-dates and generate German style dates: + * {@code } *
          * * @author Michael Büchner diff --git a/src/main/java/org/culturegraph/mf/metamorph/functions/NormalizeUTF8.java b/src/main/java/org/culturegraph/mf/metamorph/functions/NormalizeUTF8.java index cbec05557..af29d4ebb 100644 --- a/src/main/java/org/culturegraph/mf/metamorph/functions/NormalizeUTF8.java +++ b/src/main/java/org/culturegraph/mf/metamorph/functions/NormalizeUTF8.java @@ -23,8 +23,7 @@ /** * Performs normalization of diacritics in utf-8 encoded strings. * - * @author Christoph Böhme - * + * @author Christoph Böhme */ public final class NormalizeUTF8 extends AbstractSimpleStatelessFunction { diff --git a/src/main/java/org/culturegraph/mf/metamorph/maps/FileMap.java b/src/main/java/org/culturegraph/mf/metamorph/maps/FileMap.java index ef7b4d9e8..df2cb23c1 100644 --- a/src/main/java/org/culturegraph/mf/metamorph/maps/FileMap.java +++ b/src/main/java/org/culturegraph/mf/metamorph/maps/FileMap.java @@ -38,8 +38,7 @@ * encoded. The separator is by default \t. Important: Lines * that are not split in two parts by the separator are ignored! * - * @author "Markus Michael Geipel" - * + * @author Markus Michael Geipel */ public final class FileMap extends AbstractReadOnlyMap { diff --git a/src/main/java/org/culturegraph/mf/metamorph/maps/RestMap.java b/src/main/java/org/culturegraph/mf/metamorph/maps/RestMap.java index eba0624ec..0f0668980 100644 --- a/src/main/java/org/culturegraph/mf/metamorph/maps/RestMap.java +++ b/src/main/java/org/culturegraph/mf/metamorph/maps/RestMap.java @@ -29,8 +29,11 @@ import org.culturegraph.mf.metamorph.api.helpers.AbstractReadOnlyMap; /** - * @author "Markus Michael Geipel", "Philipp v. Böselager" + * A map which resolves its keys by doing a REST request and returning the + * response as value. * + * @author Markus Michael Geipel + * @author Philipp v. Böselager */ public final class RestMap extends AbstractReadOnlyMap { diff --git a/src/main/java/org/culturegraph/mf/plumbing/XmlTee.java b/src/main/java/org/culturegraph/mf/plumbing/XmlTee.java index 525b5fe0d..fa866e6cf 100644 --- a/src/main/java/org/culturegraph/mf/plumbing/XmlTee.java +++ b/src/main/java/org/culturegraph/mf/plumbing/XmlTee.java @@ -31,7 +31,7 @@ import org.xml.sax.SAXParseException; /** - * Sends one {@XmlReceiver} to two {@XmlReceiver}. + * Sends one {@link XmlReceiver} to two {@link XmlReceiver}s. * * @author Pascal Christoph (dr0i) * diff --git a/src/main/java/org/culturegraph/mf/statistics/AbstractCountProcessor.java b/src/main/java/org/culturegraph/mf/statistics/AbstractCountProcessor.java index 2bfc313e7..f1ca01b28 100644 --- a/src/main/java/org/culturegraph/mf/statistics/AbstractCountProcessor.java +++ b/src/main/java/org/culturegraph/mf/statistics/AbstractCountProcessor.java @@ -27,12 +27,10 @@ * Base class for operating on count data. The expected inputs are triples * containing as subject the variable name and as object the count. Marginal * counts must appear first, joint counts second. Marinal counts must be written - * as 1:VARNAME, Joint counts as 2:FIRSTVARNAME&SECONDVARNAME. - * - * @author Markus Geipel + * as 1:VARNAME, Joint counts as 2:FIRSTVARNAME&SECONDVARNAME. * + * @author Markus Michael Geipel */ - public abstract class AbstractCountProcessor extends DefaultObjectPipe> { diff --git a/src/main/java/org/culturegraph/mf/statistics/CooccurrenceMetricCalculator.java b/src/main/java/org/culturegraph/mf/statistics/CooccurrenceMetricCalculator.java index 2e9743212..208236974 100644 --- a/src/main/java/org/culturegraph/mf/statistics/CooccurrenceMetricCalculator.java +++ b/src/main/java/org/culturegraph/mf/statistics/CooccurrenceMetricCalculator.java @@ -28,10 +28,9 @@ * Calculates values for various co-occurrence metrics. The expected inputs are * triples containing as subject the var name and as object the count. Marginal * counts must appear first, joint counts second. Marginal counts must be - * written as 1:A, Joint counts as 2:A&B - * - * @author Markus Geipel + * written as 1:A, Joint counts as 2:A&B * + * @author Markus Michael Geipel */ @Description("Calculates values for various cooccurrence metrics. The expected inputs are triples containing as subject the var name and as object the count. " + "Marginal counts must appear first, joint counts second. Marinal counts must be written as 1:A, Joint counts as 2:A&B") diff --git a/src/main/java/org/culturegraph/mf/strings/StreamUnicodeNormalizer.java b/src/main/java/org/culturegraph/mf/strings/StreamUnicodeNormalizer.java index 2f4a55cb1..b62f4604d 100644 --- a/src/main/java/org/culturegraph/mf/strings/StreamUnicodeNormalizer.java +++ b/src/main/java/org/culturegraph/mf/strings/StreamUnicodeNormalizer.java @@ -16,7 +16,6 @@ package org.culturegraph.mf.strings; import java.text.Normalizer; -import java.text.Normalizer.Form; import org.culturegraph.mf.framework.FluxCommand; import org.culturegraph.mf.framework.StreamReceiver; @@ -29,7 +28,8 @@ * Normalises Unicode characters in record identifiers, entity and literal * names and literal values. Unicode normalisation converts between precomposed * characters and composed characters. There are four different forms of - * conversion which can be selected using {@link #setNormalizationForm(Form)}. + * conversion which can be selected using + * {@link #setNormalizationForm(Normalizer.Form)}.

          * In the default configuration only literal values are * converted. The {@link #setNormalizeIds(boolean)}, @@ -46,7 +46,7 @@ public final class StreamUnicodeNormalizer extends DefaultStreamPipe { /** - * The default value for {@link #setNormalizationForm(Form)}. + * The default value for {@link #setNormalizationForm(Normalizer.Form)}. */ public static final Normalizer.Form DEFAULT_NORMALIZATION_FORM = Normalizer.Form.NFC; @@ -116,7 +116,7 @@ public boolean getNormalizeValues() { * Sets the normalisation form used for normalising identifiers, names and * values. *

          - * The default value is {@value #DEFAULT_NORMALIZATION_FORM}. + * The default value is NFC. *

          * This parameter may be set at any time during processing. It becomes * immediately effective and affects all subsequently received events. diff --git a/src/main/java/org/culturegraph/mf/strings/UnicodeNormalizer.java b/src/main/java/org/culturegraph/mf/strings/UnicodeNormalizer.java index 69a5cfd41..58c9debe8 100644 --- a/src/main/java/org/culturegraph/mf/strings/UnicodeNormalizer.java +++ b/src/main/java/org/culturegraph/mf/strings/UnicodeNormalizer.java @@ -16,7 +16,6 @@ package org.culturegraph.mf.strings; import java.text.Normalizer; -import java.text.Normalizer.Form; import org.culturegraph.mf.framework.FluxCommand; import org.culturegraph.mf.framework.ObjectReceiver; @@ -29,7 +28,7 @@ * Normalises Unicode characters in strings. Unicode normalisation converts * between precomposed characters and composed characters. There are four * different forms of conversion which can be selected using - * {@link #setNormalizationForm(Form)}. + * {@link #setNormalizationForm(Normalizer.Form)}. * * @author Christoph Böhme * @@ -42,7 +41,7 @@ public final class UnicodeNormalizer extends DefaultObjectPipe> { /** - * The default value for {@link #setNormalizationForm(Form)}. + * The default value for {@link #setNormalizationForm(Normalizer.Form)}. */ public static final Normalizer.Form DEFAULT_NORMALIZATION_FORM = Normalizer.Form.NFC; @@ -52,7 +51,7 @@ public final class UnicodeNormalizer extends /** * Sets the normalisation form used for normalising strings. *

          - * The default value is {@value #DEFAULT_NORMALIZATION_FORM}. + * The default value is NFC. *

          * This parameter may be set at any time during processing. It becomes * effective with the next string that is received. diff --git a/src/main/java/org/culturegraph/mf/triples/MemoryWarningSystem.java b/src/main/java/org/culturegraph/mf/triples/MemoryWarningSystem.java index faf7afd67..5a7471724 100644 --- a/src/main/java/org/culturegraph/mf/triples/MemoryWarningSystem.java +++ b/src/main/java/org/culturegraph/mf/triples/MemoryWarningSystem.java @@ -91,6 +91,8 @@ private static void setUsageThreshold(final double threshold) { /** * Tenured Space Pool can be determined by it being of type HEAP and by it * being possible to set the usage threshold. + * + * @return MXBean for the Tenured Space Pool */ private static MemoryPoolMXBean findTenuredGenPool() { // I don't know whether this approach is better, or whether diff --git a/src/main/java/org/culturegraph/mf/xml/XmlElementSplitter.java b/src/main/java/org/culturegraph/mf/xml/XmlElementSplitter.java index a227d0ea1..6b22a3781 100644 --- a/src/main/java/org/culturegraph/mf/xml/XmlElementSplitter.java +++ b/src/main/java/org/culturegraph/mf/xml/XmlElementSplitter.java @@ -32,7 +32,6 @@ * An XML Element splitter. * * @author Pascal Christoph (dr0i) - * */ @Description("Splits elements (e.g. defining single records) residing in one XML document into multiple single XML documents.") @In(XmlReceiver.class) @@ -52,18 +51,16 @@ public final class XmlElementSplitter extends DefaultXmlPipe { private int ElementDepth = 0; /** - * default constructor + * Default constructor */ public XmlElementSplitter() { } /** - * enriched constructor setting the top level element and the Element name + * Enriched constructor setting the top level element and the Element name * - * @param aTopLevelElement - * the name of the top level XML tag - * @param aElementName - * the name of the tag defining a new Element to be split + * @param aTopLevelElement the name of the top level XML tag + * @param aElementName the name of the tag defining a new Element to be split */ public XmlElementSplitter(String aTopLevelElement, String aElementName) { setTopLevelElement(aTopLevelElement); @@ -74,8 +71,7 @@ public XmlElementSplitter(String aTopLevelElement, String aElementName) { * Sets the name of the Element. All these elements in the XML stream will * be XML documents on their own. * - * @param name - * Identifies the elements + * @param name Identifies the elements */ public void setElementName(final String name) { this.Element = name; @@ -84,9 +80,8 @@ public void setElementName(final String name) { /** * Sets the top-level XML document element. * - * @param root - * the top level element. Don't set it to omit setting top level - * element. + * @param root the top level element. Don't set it to omit setting top level + * element. */ public void setTopLevelElement(final String root) { this.root = root; @@ -97,10 +92,10 @@ public void setTopLevelElement(final String root) { /** * Sets the XML declaration. * - * @param xmlDeclaration - * the xml declaration. Default is ''. If empty value is given, the xml - * declaration is skipped. + * @param xmlDeclaration the xml declaration. Default is + * '{@code}'. + * If empty value is given, the xml declaration is + * skipped. */ public void setXmlDeclaration(final String xmlDeclaration) { this.xmlDeclaration = xmlDeclaration; @@ -197,4 +192,5 @@ public String getXmlDeclaration() { public void onResetStream() { reset(); } + } diff --git a/src/test/java/org/culturegraph/mf/metamorph/functions/NormalizeUTF8Test.java b/src/test/java/org/culturegraph/mf/metamorph/functions/NormalizeUTF8Test.java index fd1246b49..f2610bfa1 100644 --- a/src/test/java/org/culturegraph/mf/metamorph/functions/NormalizeUTF8Test.java +++ b/src/test/java/org/culturegraph/mf/metamorph/functions/NormalizeUTF8Test.java @@ -21,8 +21,9 @@ /** - * @author Christoph Böhme + * Tests for class {@link NormalizeUTF8}. * + * @author Christoph Böhme */ public final class NormalizeUTF8Test { diff --git a/src/test/java/org/culturegraph/mf/test/FrameworkTest.java b/src/test/java/org/culturegraph/mf/test/FrameworkTest.java index 2f13a55a8..0cdd48a5b 100644 --- a/src/test/java/org/culturegraph/mf/test/FrameworkTest.java +++ b/src/test/java/org/culturegraph/mf/test/FrameworkTest.java @@ -19,10 +19,10 @@ /** - * @author Christoph Böhme + * Tests binding Metamorph-Test to JUnit. * + * @author Christoph Böhme */ - @RunWith(MetamorphTestSuite.class) public final class FrameworkTest { // This class serves only as a bonding diff --git a/src/test/java/org/culturegraph/mf/triples/AbstractTripleSortTest.java b/src/test/java/org/culturegraph/mf/triples/AbstractTripleSortTest.java index 91aede98e..da17a568a 100644 --- a/src/test/java/org/culturegraph/mf/triples/AbstractTripleSortTest.java +++ b/src/test/java/org/culturegraph/mf/triples/AbstractTripleSortTest.java @@ -28,7 +28,6 @@ * Tests for class {@link AbstractTripleSort}. * * @author Christoph Böhme - * */ public final class AbstractTripleSortTest { @@ -56,7 +55,8 @@ public void shouldNotFailIfFlushingBeforeFirstRecord() { * garbage collector to run when calling {@code System.gc()}. This * is not guaranteed by the JVM. * - * @throws InterruptedException + * @throws InterruptedException thrown the the waiting period for the garbage + * collector is interrupted. */ @Test public void issue192ShouldUnregisterFromTheJVMToNotCauseMemoryLeak() throws InterruptedException {