# HG changeset patch # User Tim Englich # Date 1274177337 0 # Node ID c3d628c2c4c3c84abc351988bf6934d3ecf2dffc # Parent 0846c9c4abdd5dcce0e61b1dc8f85c0df852ee4e Add more Javadocs gnv/trunk@1104 c6561f87-3c4e-4783-a992-168aeb5c3f6f diff -r 0846c9c4abdd -r c3d628c2c4c3 gnv/ChangeLog --- 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 - * 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 + + * 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 diff -r 0846c9c4abdd -r c3d628c2c4c3 gnv/src/main/java/de/intevation/gnv/propertiesreader/MapPropertiesReader.java --- 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 PropertiesReader. + */ private Map properties = null; /** * Constructs a new MapPropertiesReader with an initial map. + * + * @param properties the properties which should be served by this + * PropertiesReader. */ public MapPropertiesReader(Map properties) { super(); diff -r 0846c9c4abdd -r c3d628c2c4c3 gnv/src/main/java/de/intevation/gnv/propertiesreader/ServletPropertiesReader.java --- 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 + * ServletConfig of an Context. + * It will read the InitParameters which could be configured using + * the web.xmlcontext. + * * @author Tim Englich * */ @@ -19,10 +24,16 @@ */ private static Logger log = Logger.getLogger(ServletPropertiesReader.class); + /** + * The properties which are read from the ServletConfig. + */ private Map properties = null; /** * Constructor + * + * @param config the ServletConfig where + * the properties should be read from. */ public ServletPropertiesReader(ServletConfig config) { super(); diff -r 0846c9c4abdd -r c3d628c2c4c3 gnv/src/main/java/de/intevation/gnv/propertiesreader/package.html --- 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 @@ -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.