equality based on the ids of the contents of SingleRouterConfig.

[xmlrouter] / impl / src / main / java / org / wamblee / xmlrouter / impl / TransformationPath.java

diff --git a/impl/src/main/java/org/wamblee/xmlrouter/impl/TransformationPath.java b/impl/src/main/java/org/wamblee/xmlrouter/impl/TransformationPath.java
index 359b4b4647ae4e4be02c439692b1d6c29917c59d..230c7fcae4a35d2f59df2784bb62c4ee772bceef 100644 (file)
--- a/impl/src/main/java/org/wamblee/xmlrouter/impl/TransformationPath.java
+++ b/impl/src/main/java/org/wamblee/xmlrouter/impl/TransformationPath.java
@@ -12,7 +12,7 @@
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- */ 
+ */
 package org.wamblee.xmlrouter.impl;
 
 import java.util.ArrayList;
@@ -20,24 +20,54 @@ import java.util.List;
 
 import org.wamblee.xmlrouter.config.Transformation;
 
+/**
+ * Transformation path from a source document to a destination.
+ * 
+ * @author Erik Brakkee
+ * 
+ */
 public class TransformationPath {
 
     private List<Transformation> transformations;
 
+    /**
+     * Constructs empty path.
+     */
     public TransformationPath() {
         transformations = new ArrayList<Transformation>();
     }
 
+    /**
+     * Constructs path with single transformation.
+     * 
+     * @param aTransformation
+     *            Single transformation.
+     */
     public TransformationPath(Transformation aTransformation) {
         this();
         transformations.add(aTransformation);
     }
 
+    /**
+     * Constructs path with list of transformations.
+     * 
+     * @param aTransformations
+     *            List of transformations.
+     */
     public TransformationPath(List<Transformation> aTransformations) {
         this();
         transformations.addAll(aTransformations);
     }
 
+    /**
+     * Appends a transormation path to the current path.
+     * 
+     * @param aSequence
+     *            Transformation sequence to append.
+     * @return Appended transformations equence.
+     * @throws Runtime
+     *             exception if the appended transformation would not be valid.
+     */
     public TransformationPath appendPath(TransformationPath aSequence) {
         if (transformations.isEmpty()) {
             return new TransformationPath(aSequence.transformations);
@@ -56,10 +86,16 @@ public class TransformationPath {
         return new TransformationPath(t);
     }
 
+    /**
+     * @return Number of transformations.
+     */
     public int size() {
         return transformations.size();
     }
 
+    /**
+     * @return From type of the path or null if the sequence is empty.
+     */
     public String getFromType() {
         if (transformations.isEmpty()) {
             return null;
@@ -67,6 +103,9 @@ public class TransformationPath {
         return transformations.get(0).getFromType();
     }
 
+    /**
+     * @return To type of the path or null if the sequence is empty.
+     */
     public String getToType() {
         if (transformations.isEmpty()) {
             return null;
@@ -74,6 +113,9 @@ public class TransformationPath {
         return transformations.get(transformations.size() - 1).getToType();
     }
 
+    /**
+     * @return The transformations.
+     */
     public List<Transformation> getTransformations() {
         return transformations;
     }