diff gnv-artifacts/src/main/java/de/intevation/gnv/statistics/StatisticSet.java @ 814:9d427dd2a96a

Added Javadoc in statistic package. gnv-artifacts/trunk@898 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Fri, 09 Apr 2010 14:34:45 +0000
parents c4156275c1e1
children 05bf8534a35a
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/statistics/StatisticSet.java	Fri Apr 09 13:09:25 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/statistics/StatisticSet.java	Fri Apr 09 14:34:45 2010 +0000
@@ -4,8 +4,9 @@
 import java.util.Collection;
 
 /**
+ * A container to store several statistics.
+ *
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
- *
  */
 public class StatisticSet {
 
@@ -16,22 +17,36 @@
 
     /**
      * Constructor
+     * @param name Name of this container.
      */
     public StatisticSet(String name) {
         this.name = name;
     }
 
 
+    /**
+     * Add a further statistic to this container.
+     *
+     * @param statistic A statistic.
+     */
     public void addStatistic(Statistic statistic){
         this.statistics.add(statistic);
     }
 
+    /**
+     * Returns all statistics in this container.
+     * @return all statistics.
+     */
     public Collection<Statistic> getStatistics(){
         return this.statistics;
     }
 
+    /**
+     * Returns the name of this container.
+     * @return the name.
+     */
     public String getName(){
         return this.name;
     }
-
 }
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :
\ No newline at end of file

http://dive4elements.wald.intevation.org