Fix javadoc for module "metamorph" (#396)

Author: dr0i

metamorph-api/src/main/java/org/metafacture/metamorph/api/helpers/AbstractFunction.java

@@ -49,6 +49,11 @@ public final String getMapName() {
         return mapName;
     }
 
+    /**
+     * Gets the {@value #localMap} or a Map with the name of {@value #mapName}.
+     *
+     * @return the Map
+     */
     public final Map<String, String> getMap() {
         if (localMap == null) {
             return maps.getMap(mapName);

metamorph/src/main/java/org/metafacture/metamorph/AbstractMetamorphDomWalker.java

@@ -100,6 +100,13 @@ protected final MapFactory getMapFactory() {
         return mapFactory;
     }
 
+    /**
+     * Walks through the metamorph definition file. Respects the metamorph
+     * variables.
+     *
+     * @param morphScript the InputSource of the metamorph definition file
+     * @param newVars     the Map of Metamorph variables
+     */
     public final void walk(final InputSource morphScript, final Map<String, String> newVars) {
         vars.putAll(newVars);
         walk(morphScript);

metamorph/src/main/java/org/metafacture/metamorph/Entity.java

@@ -53,6 +53,11 @@ public Entity(final Supplier<StreamReceiver> receiver) {
         this.receiver = receiver;
     }
 
+    /**
+     * Sets the NamedValueSource the entity will act on.
+     *
+     * @param source the NamedValueSource
+     */
     public void setNameSource(final NamedValueSource source) {
         nameSource = source;
         nameSource.setNamedValueReceiver(this);

metamorph/src/main/java/org/metafacture/metamorph/Filter.java

@@ -45,21 +45,45 @@ public final class Filter extends DefaultStreamPipe<StreamReceiver> {
     private final SingleValue singleValue = new SingleValue();
     private final Metamorph metamorph;
 
+    /**
+     * Constructs a Filter by a path to the metamorph definition.
+     *
+     * @param morphDef the path to the metamorph definition
+     */
     public Filter(final String morphDef) {
         metamorph = new Metamorph(morphDef);
         metamorph.setReceiver(singleValue);
     }
 
+    /**
+     * Constructs a Filter by a Metamorph.
+     *
+     * @param metamorph the Metamorph
+     */
     public Filter(final Metamorph metamorph) {
         this.metamorph = metamorph;
         metamorph.setReceiver(singleValue);
     }
 
+    /**
+     * Constructs a Filter by a path to the metamorph definition and a Map of
+     * Metamorph variables.
+     *
+     * @param morphDef the path to the metamorph definition
+     * @param vars     the Map of the metamorph variables
+     */
     public Filter(final String morphDef, final Map<String, String> vars) {
         metamorph = new Metamorph(morphDef, vars);
         metamorph.setReceiver(singleValue);
     }
 
+    /**
+     * Constructs a Filter by a path to the metamorph definition and an
+     * InterceptorFactory.
+     *
+     * @param morphDef           the path to the metamorph definition
+     * @param interceptorFactory the InterceptorFactory
+     */
     public Filter(final String morphDef, final InterceptorFactory interceptorFactory) {
         metamorph = new Metamorph(morphDef, interceptorFactory);
         metamorph.setReceiver(singleValue);

metamorph/src/main/java/org/metafacture/metamorph/Metamorph.java

@@ -174,6 +174,14 @@ public Metamorph(final InputSource inputSource, final InterceptorFactory interce
         this(inputSource, NO_VARS, interceptorFactory);
     }
 
+    /**
+     * Constructs a Metamorph by setting an InputSource, a Map of variables and an
+     * InterceptorFactory.
+     *
+     * @param inputSource        the InputSource
+     * @param vars               the Map of variables
+     * @param interceptorFactory the InterceptorFactory
+     */
     public Metamorph(final InputSource inputSource, final Map<String, String> vars,
             final InterceptorFactory interceptorFactory) {
         buildPipeline(inputSource, vars, interceptorFactory);

metamorph/src/main/java/org/metafacture/metamorph/Splitter.java

@@ -44,16 +44,31 @@ public final class Splitter implements StreamPipe<StreamReceiver> {
     private final Map<String, StreamReceiver> receiverMap = new HashMap<String, StreamReceiver>();
     private final Metamorph metamorph;
 
+    /**
+     * Constructs a Splitter by setting a the path to a metamorph definition file.
+     *
+     * @param morphDef the name of the file of the metamorph definition
+     */
     public Splitter(final String morphDef) {
         metamorph = new Metamorph(morphDef);
         metamorph.setReceiver(singleValue);
     }
 
+    /**
+     * Constructs a Splitter by setting a Reader of a metamorph definition.
+     *
+     * @param morphDef the Reader of the metamorph definition
+     */
     public Splitter(final Reader morphDef) {
         metamorph = new Metamorph(morphDef);
         metamorph.setReceiver(singleValue);
     }
 
+    /**
+     * Constructs a Splitter by setting the Metamorph.
+     *
+     * @param metamorph the Metamoprh
+     */
     public Splitter(final Metamorph metamorph) {
         this.metamorph = metamorph;
         metamorph.setReceiver(singleValue);
@@ -65,6 +80,14 @@ public <R extends StreamReceiver> R setReceiver(final R receiver) {
         return receiver;
     }
 
+    /**
+     * Sets the receiver.
+     *
+     * @param <R>      the type of the receiver
+     * @param key      the name of the receiver
+     * @param receiver the receiver
+     * @return the receiver
+     */
     public <R extends StreamReceiver> R setReceiver(final String key, final R receiver) {
         receiverMap.put(key, receiver);
         return receiver;

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

@@ -58,6 +58,11 @@ public void setTo(final String string) {
         this.toUpper = UPPER.equals(string);
     }
 
+    /**
+     * Sets the language if it's present in {@value #SUPPORTED_LANGUAGES}.
+     *
+     * @param language the language
+     */
     public void setLanguage(final String language) {
         if (!LANGUAGES.contains(language)) {
             throw new MorphBuildException("Language " + language + " not supported.");

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

@@ -178,6 +178,11 @@ public final void setRemoveLeadingZeros(final boolean removeLeadingZeros) {
         this.removeLeadingZeros = removeLeadingZeros;
     }
 
+    /**
+     * Sets the language if it's present in {@value #SUPPORTED_LANGUAGES}.
+     *
+     * @param language the language
+     */
     public final void setLanguage(final String language) {
         if (!SUPPORTED_LANGUAGES.contains(language)) {
             throw new MorphBuildException("Language '" + language + "' not supported.");

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

@@ -75,6 +75,14 @@ else if (to13 && ISBN10_SIZE == size) {
         return result;
     }
 
+    /**
+     * Cleanse the ISBN free of semantic sugar and uppercase a possible "x"
+     * character.
+     *
+     * @param isbn the ISBN
+     * @return the normalized ISBN or an empty string if normalization is not
+     *         succesful
+     */
     public static String cleanse(final String isbn) {
         String normValue = isbn.replace('x', 'X');
         normValue = DIRT_PATTERN.matcher(normValue).replaceAll("");
@@ -85,6 +93,11 @@ public static String cleanse(final String isbn) {
         return "";
     }
 
+    /**
+     * Sets the ISBN to ISBN-10 or ISBN-13.
+     *
+     * @param toString {@value #ISBN10} or {@value #ISBN13}
+     */
     public void setTo(final String toString) {
         to13 = toString.equalsIgnoreCase(ISBN13);
         to10 = toString.equalsIgnoreCase(ISBN10);
@@ -127,6 +140,12 @@ private static int charToInt(final char cha) {
         return (byte) cha - (byte) '0';
     }
 
+    /**
+     * Converts a ISBN-13 to ISBN-10.
+     *
+     * @param isbn the ISBN-13
+     * @return the ISBN-10
+     */
     public static String isbn13to10(final String isbn) {
         if (isbn.length() != ISBN13_SIZE) {
             throw new IllegalArgumentException(
@@ -137,6 +156,12 @@ public static String isbn13to10(final String isbn) {
         return isbn10Data + check10(isbn10Data);
     }
 
+    /**
+     * Converts a ISBN-10 to ISBN-13.
+     *
+     * @param isbn the ISBN-10
+     * @return the ISBN-13
+     */
     public static String isbn10to13(final String isbn) {
         if (isbn.length() != ISBN10_SIZE) {
             throw new IllegalArgumentException(
@@ -148,6 +173,12 @@ public static String isbn10to13(final String isbn) {
         return isbn13Data + check13(isbn13Data);
     }
 
+    /**
+     * Checks if a ISBN is valid.
+     *
+     * @param isbn the ISBN
+     * @return true if it's valid and false if not
+     */
     public static boolean isValid(final String isbn) {
         boolean result = false;
 

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

@@ -44,6 +44,11 @@ public void setInvoke(final String invoke) {
         this.invoke = invoke;
     }
 
+    /**
+     * Sets the filename of a JavaScript and loads it.
+     *
+     * @param file the file
+     */
     public void setFile(final String file) {
 
         final ScriptEngineManager manager = new ScriptEngineManager();