Fix all javadoc errors (#396)

Result of 0630ffa.

Author: dr0i

metafacture-commons/src/main/java/org/metafacture/commons/ResourceUtil.java

@@ -47,12 +47,12 @@ private ResourceUtil() {
     }
 
     /**
-     * First attempts to open open {@code name} as a file. On fail attempts to
-     * open resource with name {@code name}. On fail attempts to open {@code name}
-     * as a URL.
+     * First attempts to open a file with the provided name. On fail attempts to
+     * open a resource identified by the name. On fail attempts to open a URL
+     * identified by the name.
      *
-     * @param name name of the file or resource to open
-     * @return an input stream for reading the opened file or resource
+     * @param name name of the file, resource or the URL to open
+     * @return an input stream for reading the opened file, resource or URL
      * @throws FileNotFoundException if all attempts fail
      */
     public static InputStream getStream(final String name)
@@ -83,6 +83,13 @@ public static InputStream getStream(final String name)
 
     }
 
+    /**
+     * Gets an InputStream of a File.
+     *
+     * @param file the File.
+     * @return the InputStream
+     * @throws FileNotFoundException if the File couldn't be found
+     */
     public static InputStream getStream(final File file)
             throws FileNotFoundException {
         return new FileInputStream(file);
@@ -98,20 +105,53 @@ private static void throwFileNotFoundException(final String name,
         throw e;
     }
 
+    /**
+     * Gets a Reader. First attempts to open a file. On fail attempts to open the
+     * resource with name. On fail attempts to open name as a URL.
+     *
+     * @param name the name of the resource
+     * @return the Reader
+     * @throws FileNotFoundException if the File couldn't be found
+     */
     public static Reader getReader(final String name)
             throws FileNotFoundException {
         return new InputStreamReader(getStream(name));
     }
 
+    /**
+     * Gets a Reader from a File.
+     *
+     * @param file the File
+     * @return the Reader
+     * @throws FileNotFoundException if the File couldn't be found
+     */
     public static Reader getReader(final File file) throws FileNotFoundException {
         return new InputStreamReader(getStream(file));
     }
 
+    /**
+     * Gets a Reader. First attempts to open a file. On fail attempts to open the
+     * resource with name. On fail attempts to open name as a URL. Uses the given
+     * {@link java.nio.charset.Charset charset} as encoding.
+     *
+     * @param name     the name of the resource
+     * @param encoding the Charset
+     * @return the Reader
+     * @throws IOException if an I/O error occurs
+     */
     public static Reader getReader(final String name, final String encoding)
             throws IOException {
         return new InputStreamReader(getStream(name), encoding);
     }
 
+    /**
+     * Gets a Reader from a File using {@link java.nio.charset.Charset charset}.
+     *
+     * @param file     the File
+     * @param encoding the Charset
+     * @return the Reader
+     * @throws IOException if an I/O error occurs
+     */
     public static Reader getReader(final File file, final String encoding)
             throws IOException {
         return new InputStreamReader(getStream(file), encoding);
@@ -139,10 +179,26 @@ public static URL getUrl(final String name) throws MalformedURLException {
         return resourceUrl != null ? resourceUrl : new URL(name);
     }
 
+    /**
+     * Gets an URL of a File.
+     *
+     * @param file the File
+     * @return the URL
+     * @throws MalformedURLException if malformed URL has occurred
+     */
     public static URL getUrl(final File file) throws MalformedURLException {
         return file.toURI().toURL();
     }
 
+    /**
+     * Creates Properties based upon a location. First attempts to open a file. On
+     * fail attempts to open the resource with name. On fail attempts to open name
+     * as a URL.
+     *
+     * @param location the location of the resource
+     * @return the Properties
+     * @throws IOException if an I/O error occurs
+     */
     public static Properties loadProperties(final String location)
             throws IOException {
         return loadProperties(getStream(location));
@@ -152,7 +208,7 @@ public static Properties loadProperties(final String location)
      * Loads properties from an InputStream.
      *
      * @param stream properties as InputStream
-     * @return Properties
+     * @return the Properties
      * @throws IOException if an I/O error occurs
      */
     public static Properties loadProperties(final InputStream stream)
@@ -167,7 +223,7 @@ public static Properties loadProperties(final InputStream stream)
      * Loads properties from a URL.
      *
      * @param url properties as URL
-     * @return Properties
+     * @return the Properties
      * @throws IOException if an I/O error occurs
      */
     public static Properties loadProperties(final URL url) throws IOException {

metafacture-commons/src/main/java/org/metafacture/commons/StringUtil.java

@@ -49,15 +49,48 @@ public static <O> O fallback(final O value, final O fallbackValue) {
         return value;
     }
 
+    /**
+     * Formats a String. If a String has a variable it will be replaced based on a
+     * Map. The start and the end of indicating this variable must be defined.
+     * {@value #DEFAULT_VARSTART} indicates the start of a variable and
+     * {@value #DEFAULT_VAREND} the end of the variable . Unassigned variables are
+     * ignored.
+     *
+     * @param format            the String to be formatted
+     * @param variables         a Map of variable names and their values
+     * @return the formatted String
+     */
     public static String format(final String format, final Map<String, String> variables) {
         return format(format, DEFAULT_VARSTART, DEFAULT_VAREND, true, variables);
     }
 
+    /**
+     * Formats a String. If a String has a variable it will be replaced based on a
+     * Map. The start and the end of indicating this variable must be defined.
+     * Unassigned variables are ignored.
+     *
+     * @param format            the String to be formatted
+     * @param varStartIndicator a String indicating the start of a variable
+     * @param varEndIndicator   a String indicating the end of a variable
+     * @param variables         a Map of variable names and their values
+     * @return the formatted String
+     */
     public static String format(final String format, final String varStartIndicator, final String varEndIndicator,
             final Map<String, String> variables) {
         return format(format, varStartIndicator, varEndIndicator, true, variables);
     }
 
+    /**
+     * Formats a String. If a String has a variable it will be replaced based on a
+     * Map. The start and the end of indicating this variable must be defined.
+     * {@value #DEFAULT_VARSTART} indicates the start of a variable and
+     * {@value #DEFAULT_VAREND} the end of the variable .
+     *
+     * @param format            the String to be formatted
+     * @param ignoreMissingVars boolean if an unassigned variable should be ignored
+     * @param variables         a Map of variable names and their values
+     * @return the formatted String
+     */
     public static String format(final String format, final boolean ignoreMissingVars,
             final Map<String, String> variables) {
         return format(format, DEFAULT_VARSTART, DEFAULT_VAREND, ignoreMissingVars, variables);
@@ -72,7 +105,7 @@ public static String format(final String format, final boolean ignoreMissingVars
      * @param varEndIndicator   a String indicating the end of a variable
      * @param ignoreMissingVars boolean if an unassigned variable should be ignored
      * @param variables         a Map of variable names and their values
-     * @return a formatted String
+     * @return the formatted String
      */
     public static String format(final String format, final String varStartIndicator, final String varEndIndicator,
             final boolean ignoreMissingVars, final Map<String, String> variables) {

metafacture-commons/src/main/java/org/metafacture/commons/XmlUtil.java

@@ -45,6 +45,12 @@ private XmlUtil() {
         // No instances allowed
     }
 
+    /**
+     * Converts a Node to a String.
+     *
+     * @param node the Node
+     * @return the String represantation of the Node
+     */
     public static String nodeToString(final Node node) {
         return nodeToString(node, false);
     }
@@ -117,6 +123,12 @@ public static boolean isXmlMimeType(final String mimeType) {
                 mimeType.endsWith(XML_BASE_MIME_TYPE);
     }
 
+    /**
+     * Escapes an unescaped String.
+     *
+     * @param unescaped the unescaped String
+     * @return the escaped String
+     */
     public static String escape(final String unescaped) {
         return escape(unescaped, true);
     }

metafacture-commons/src/main/java/org/metafacture/commons/reflection/ConfigurableClass.java

@@ -46,10 +46,21 @@ public final class ConfigurableClass<T> {
 
     private Map<String, Method> settersCache;
 
+    /**
+     *
+     * Creates an instance of {@link ConfigurableClass} defined by a Class.
+     *
+     * @param plainClass the plain class of object type T
+     */
     public ConfigurableClass(final Class<T> plainClass) {
         this.plainClass = plainClass;
     }
 
+    /**
+     * Gets the plain class of the ConfigurableClass.
+     *
+     * @return the Class
+     */
     public Class<T> getPlainClass() {
         return plainClass;
     }
@@ -101,6 +112,11 @@ public Map<String, Class<?>> getSetterTypes() {
         return setterTypes;
     }
 
+    /**
+     * Creates an empty instance of the class.
+     *
+     * @return a new instance
+     */
     public T newInstance() {
         return newInstance(Collections.emptyMap());
     }

metafacture-commons/src/main/java/org/metafacture/commons/reflection/ObjectFactory.java

@@ -37,6 +37,9 @@ public class ObjectFactory<T> {
     private final Map<String, ConfigurableClass<? extends T>> classes =
             new HashMap<>();
 
+    /**
+     * Creates an instance of {@link ObjectFactory}.
+     */
     public ObjectFactory() {
     }
 
@@ -55,14 +58,33 @@ public final void loadClassesFromMap(final Map<?, ?> classMap, final Class<T> ba
         }
     }
 
+    /**
+     * Registers a Class as a ConfigurableClass.
+     *
+     * @param key         the key associcated with the Class
+     * @param objectClass the Class
+     */
     public final void registerClass(final String key, final Class<? extends T> objectClass) {
         registerClass(key, new ConfigurableClass<>(objectClass));
     }
 
+    /**
+     * Registers a ConfigurableClass.
+     *
+     * @param key         the key associcated with the ConfigurableClass
+     * @param objectClass the ConfigurableClass
+     */
     public final void registerClass(final String key, final ConfigurableClass<? extends T> objectClass) {
         classes.put(key, objectClass);
     }
 
+    /**
+     * Returns a new instance of a ConfigurableClass with no setters.
+     *
+     * @param key             the name of the class
+     * @param constructorArgs the args of the constructor
+     * @return a new instance
+     */
     public final T newInstance(final String key, final Object... constructorArgs) {
         return newInstance(key, Collections.emptyMap(), constructorArgs);
     }
@@ -83,14 +105,31 @@ public final T newInstance(final String key, final Map<String, String> values, f
         return instanceClass.newInstance(values, constructorArgs);
     }
 
+    /**
+     * Checks wether a ConfigurableClass is asscociated with a key.
+     *
+     * @param key the key
+     * @return true if the key is associcated with a ConfigurableClass
+     */
     public final boolean containsKey(final String key) {
         return classes.containsKey(key);
     }
 
+    /**
+     * Gets the key set of all {ConfigurableClass}es.
+     *
+     * @return all keys that identify the {ConfigurableClass}es
+     */
     public final Set<String> keySet() {
         return Collections.unmodifiableSet(classes.keySet());
     }
 
+    /**
+     * Gets a ConfigurableClass.
+     *
+     * @param key the key that identifies the ConfigurableClass
+     * @return the ConfigurableClass
+     */
     public final ConfigurableClass<? extends T> get(final String key) {
         return classes.get(key);
     }

metafacture-commons/src/main/java/org/metafacture/commons/reflection/ReflectionUtil.java

@@ -40,6 +40,14 @@ public static ClassLoader getContextClassLoader() {
         return loader;
     }
 
+    /**
+     * Loads a Class.
+     *
+     * @param <T>       the object type
+     * @param className the name of the class
+     * @param baseType  the object type of the class to be wrapped
+     * @return the ConfigurableClass
+     */
     public static <T> ConfigurableClass<? extends T> loadClass(final String className, final Class<T> baseType) {
         return loadClass(getContextClassLoader(), className, baseType);
     }

metafacture-commons/src/main/java/org/metafacture/commons/tries/SetMatcher.java

@@ -33,6 +33,9 @@ public final class SetMatcher<T> {
     private final ACNode<T> root = new ACNode<>(null, 0);
     private boolean isPrepared;
 
+    /**
+     * Creates an instance of {@link SetMatcher}.
+     */
     public SetMatcher() {
     }
 
@@ -198,14 +201,29 @@ public Match(final T value, final int start, final int length) {
             this.length = length;
         }
 
+        /**
+         * Gets the value.
+         *
+         * @return the value
+         */
         public T getValue() {
             return value;
         }
 
+        /**
+         * Gets the start position.
+         *
+         * @return the start position
+         */
         public int getStart() {
             return start;
         }
 
+        /**
+         * Gets the length.
+         *
+         * @return the length
+         */
         public int getLength() {
             return length;
         }

metafacture-commons/src/main/java/org/metafacture/commons/tries/SetReplacer.java

@@ -32,6 +32,9 @@
 public final class SetReplacer {
     private final SetMatcher<String> matcher = new SetMatcher<String>();
 
+    /**
+     * Creates an instance of {@link SetReplacer}.
+     */
     public SetReplacer() {
     }