Mercurial > dive4elements > gnv-client
diff gnv/src/main/java/de/intevation/gnv/propertiesreader/PropertiesReader.java @ 690:254f062e334b
Added JavaDoc.
gnv/trunk@908 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author | Ingo Weinzierl <ingo.weinzierl@intevation.de> |
---|---|
date | Mon, 12 Apr 2010 16:45:16 +0000 |
parents | 57fa8019fbdc |
children | 89ade245ca7a |
line wrap: on
line diff
--- a/gnv/src/main/java/de/intevation/gnv/propertiesreader/PropertiesReader.java Mon Apr 12 10:56:55 2010 +0000 +++ b/gnv/src/main/java/de/intevation/gnv/propertiesreader/PropertiesReader.java Mon Apr 12 16:45:16 2010 +0000 @@ -1,11 +1,21 @@ package de.intevation.gnv.propertiesreader; /** + * An interface that defines a single method to retrieve properties specified by + * a key. + * * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> - * */ public interface PropertiesReader { + /** + * Retrieves a property by the given <i>ke<</i>. + * + * @param key The key of a property. + * @param defaultValue The default value which is returned if no property + * is found by <i>key</i>. + * @return the value of a property. + */ public String getPropertieValue(String key, String defaultValue); - } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file