Mercurial > dive4elements > gnv-client
changeset 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 | 0846c9c4abdd |
| children | d98d3e82118c |
| files | gnv/ChangeLog gnv/src/main/java/de/intevation/gnv/propertiesreader/MapPropertiesReader.java gnv/src/main/java/de/intevation/gnv/propertiesreader/ServletPropertiesReader.java gnv/src/main/java/de/intevation/gnv/propertiesreader/package.html |
| diffstat | 4 files changed, 28 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/gnv/ChangeLog Tue May 18 10:00:27 2010 +0000 +++ b/gnv/ChangeLog Tue May 18 10:08:57 2010 +0000 @@ -1,7 +1,14 @@ 2010-05-18 Tim Englich <tim.englich@intevation.de> - * src/main/java/de/intevation/gnv/artifactdatabase/objects/map/DefaultMapService.java: - * src/main/java/de/intevation/gnv/artifactdatabase/objects/map/DefaultLayer.java: + * src/main/java/de/intevation/gnv/propertiesreader/package.html, + src/main/java/de/intevation/gnv/propertiesreader/ServletPropertiesReader.java, + src/main/java/de/intevation/gnv/propertiesreader/MapPropertiesReader.java: + Added more Javadocs. + +2010-05-18 Tim Englich <tim.englich@intevation.de> + + * src/main/java/de/intevation/gnv/artifactdatabase/objects/map/DefaultMapService.java, + src/main/java/de/intevation/gnv/artifactdatabase/objects/map/DefaultLayer.java: Added more Javadocs. 2010-05-18 Tim Englich <tim.englich@intevation.de>
--- a/gnv/src/main/java/de/intevation/gnv/propertiesreader/MapPropertiesReader.java Tue May 18 10:00:27 2010 +0000 +++ b/gnv/src/main/java/de/intevation/gnv/propertiesreader/MapPropertiesReader.java Tue May 18 10:08:57 2010 +0000 @@ -14,10 +14,16 @@ private static Logger log = Logger.getLogger(MapPropertiesReader.class); + /** + * The properties which are served by this <code>PropertiesReader</code>. + */ private Map<String, String> properties = null; /** * Constructs a new MapPropertiesReader with an initial map. + * + * @param properties the properties which should be served by this + * <code>PropertiesReader</code>. */ public MapPropertiesReader(Map<String, String> properties) { super();
--- 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();
--- a/gnv/src/main/java/de/intevation/gnv/propertiesreader/package.html Tue May 18 10:00:27 2010 +0000 +++ b/gnv/src/main/java/de/intevation/gnv/propertiesreader/package.html Tue May 18 10:08:57 2010 +0000 @@ -3,6 +3,7 @@ <head> </head> <body> -DOCUMENT ME! +This package provides reader and factories which will provide properties which +are configured in different files (e.g. web.xml) in the whole system. </body> </html>