Mercurial > dive4elements > framework
diff artifact-database/src/main/java/de/intevation/artifactdatabase/DefaultArtifactContext.java @ 90:68285f7bc476
More javadoc.
artifacts/trunk@846 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author | Sascha L. Teichmann <sascha.teichmann@intevation.de> |
---|---|
date | Fri, 26 Mar 2010 17:59:50 +0000 |
parents | 48d1a9a082c2 |
children | 933bbc9fc11f |
line wrap: on
line diff
--- a/artifact-database/src/main/java/de/intevation/artifactdatabase/DefaultArtifactContext.java Fri Mar 26 16:16:32 2010 +0000 +++ b/artifact-database/src/main/java/de/intevation/artifactdatabase/DefaultArtifactContext.java Fri Mar 26 17:59:50 2010 +0000 @@ -12,29 +12,62 @@ */ public class DefaultArtifactContext { + /** + * The global configuration document of the artifact database. + */ protected Document config; + /** + * Custom key/value pairs to be used globally in the whole server. + */ protected HashMap map; + /** + * Default constructor + */ public DefaultArtifactContext() { this(null); } + /** + * Constructor to create a context with a given global + * configuration document and an empty map of custom + * key/value pairs. + * @param config + */ public DefaultArtifactContext(Document config) { this.config = config; map = new HashMap(); } + /** + * Fetch a custom value from the global key/value map using + * a given key. + * @param key The key. + * @return The stored value or null if no value was found under + * this key. + */ public synchronized Object get(Object key) { return map.get(key); } + /** + * Store a custom key/value pair in the global map. + * @param key The key to store + * @param value The value to store + * @return The old value registered under the key or null + * if none wa there before. + */ public synchronized Object put(Object key, Object value) { return map.put(key, value); } + /** + * Returns a reference to the global configuration document. + * @return The global configuration document. + */ public Document getConfig() { return config; } } -// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8: +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :