diff gnv-artifacts/src/main/java/de/intevation/gnv/raster/DemuxRingsHandler.java @ 802:4abe172be970

Finished Javadoc of the raster package. gnv-artifacts/trunk@884 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Sascha L. Teichmann <sascha.teichmann@intevation.de>
date Wed, 07 Apr 2010 07:49:12 +0000
parents c4156275c1e1
children feae2f9d6c6f
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/raster/DemuxRingsHandler.java	Tue Apr 06 16:53:43 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/raster/DemuxRingsHandler.java	Wed Apr 07 07:49:12 2010 +0000
@@ -7,17 +7,31 @@
 import java.util.List;
 
 /**
+ * Ring Handler that demultiplexes to a list of other ring handlers.
+ * Handy if you want to pipe the polygons and line strings produced
+ * by the Vectorize to more than one handler at once.
+ * 
  * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a>
  */
 public class DemuxRingsHandler
 implements   RingsHandler
 {
+    /**
+     * The list of internal ring handlers.
+     */
     protected ArrayList<RingsHandler> handlers;
 
+    /**
+     * Default constructor.
+     */
     public DemuxRingsHandler() {
         handlers = new ArrayList<RingsHandler>();
     }
 
+    /**
+     * Add a ring handler to the list of handlers.
+     * @param handler The handler to add to the internal list.
+     */
     public void addHandler(RingsHandler handler) {
         handlers.add(handler);
     }
@@ -33,6 +47,9 @@
         }
     }
 
+    /**
+     * Empties the internal list of ring handlers.
+     */
     public void clear() {
         handlers.clear();
     }

http://dive4elements.wald.intevation.org