changeset 436:15179c77aa1d flys-2.9.3

Documentation, so that readers know a tiny bit more what is going on.
author Felix Wolfsteller <felix.wolfsteller@intevation.de>
date Tue, 16 Oct 2012 15:08:43 +0200
parents e39e23320a23
children 423c6e6b0cac f3bf22423c95
files ChangeLog artifact-database/src/main/java/de/intevation/artifactdatabase/state/FacetActivity.java
diffstat 2 files changed, 22 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/ChangeLog	Sat Oct 06 14:20:40 2012 +0200
+++ b/ChangeLog	Tue Oct 16 15:08:43 2012 +0200
@@ -1,3 +1,15 @@
+2012-10-16	Felix Wolfsteller	<felix.wolfsteller@intevation.de>
+
+	* artifact-database/src/main/java/de/intevation/artifactdatabase/state/FacetActivity.java:
+	  Documentation of a somewhat important part.
+
+2012-10-08	Felix Wolfsteller	<felix.wolfsteller@intevation.de>
+
+	* flys-artifacts/src/main/java/de/intevation/flys/artifacts/access/ExtremeAccess.java,
+	  flys-artifacts/src/main/java/de/intevation/flys/artifacts/charts/TimeseriesStepChart.java,
+	  flys-artifacts/src/main/java/de/intevation/flys/utils/DoubleUtil.java:
+	  Doc.
+
 2012-10-06	Sascha L. Teichmann	<sascha.teichmann@intevation.de>
 
 	* artifacts-common/src/main/java/de/intevation/artifacts/common/utils/FileTools.java:
--- a/artifact-database/src/main/java/de/intevation/artifactdatabase/state/FacetActivity.java	Sat Oct 06 14:20:40 2012 +0200
+++ b/artifact-database/src/main/java/de/intevation/artifactdatabase/state/FacetActivity.java	Tue Oct 16 15:08:43 2012 +0200
@@ -7,8 +7,11 @@
 import java.util.List;
 import java.util.Map;
 
+
+/** Magical system. */
 public interface FacetActivity
 {
+    /** Static 'activity' that lets all facets be active. */
     public static final FacetActivity ACTIVE = new FacetActivity() {
         @Override
         public Boolean isInitialActive(
@@ -20,6 +23,7 @@
         }
     };
 
+    /** Static 'activity' that lets all facets be inactive. */
     public static final FacetActivity INACTIVE = new FacetActivity() {
         @Override
         public Boolean isInitialActive(
@@ -33,20 +37,26 @@
 
     Boolean isInitialActive(Artifact artifact, Facet facet, String output);
 
+    /** Singleton registry, that maps artifact names to the activities, which
+     * decide whether or not a facet should be (initially) active. */
     public static final class Registry {
 
+        /** Singleton instance. */
         private static final Registry INSTANCE = new Registry();
 
         private Map<String, List<FacetActivity>> activities;
 
+        /** Private singleton constructor for the Facet-Activity-Registry. */
         private Registry() {
             activities = new HashMap<String, List<FacetActivity>>();
         }
 
+        /** Access Singleton instance. */
         public static Registry getInstance() {
             return INSTANCE;
         }
 
+        /** Queries whether a given facet should be active or not. */
         public synchronized boolean isInitialActive(
             String   key,
             Artifact artifact,

http://dive4elements.wald.intevation.org