diff gnv/src/main/java/de/intevation/gnv/propertiesreader/ServletPropertiesReader.java @ 960:c3d628c2c4c3

Add more Javadocs gnv/trunk@1104 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Tim Englich <tim.englich@intevation.de>
date Tue, 18 May 2010 10:08:57 +0000
parents 89ade245ca7a
children 28a0628b11b0
line wrap: on
line diff
--- a/gnv/src/main/java/de/intevation/gnv/propertiesreader/ServletPropertiesReader.java	Tue May 18 10:00:27 2010 +0000
+++ b/gnv/src/main/java/de/intevation/gnv/propertiesreader/ServletPropertiesReader.java	Tue May 18 10:08:57 2010 +0000
@@ -9,6 +9,11 @@
 import org.apache.log4j.Logger;
 
 /**
+ * This reader fetches the properties it will provide from the 
+ * <code>ServletConfig</code> of an <code>Context</code>.
+ * It will read the InitParameters which could be configured using
+ * the <code>web.xml</code-file of each <code>context</code>.
+ * 
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
  *
  */
@@ -19,10 +24,16 @@
      */
     private static Logger log = Logger.getLogger(ServletPropertiesReader.class);
 
+    /**
+     * The properties which are read from the <code>ServletConfig</code>.
+     */
     private Map<String, String> properties = null;
 
     /**
      * Constructor
+     * 
+     * @param config the <code>ServletConfig</code> where 
+     *               the properties should be read from.
      */
     public ServletPropertiesReader(ServletConfig config) {
         super();

http://dive4elements.wald.intevation.org