Mercurial > dive4elements > gnv-client
annotate 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 |
rev | line source |
---|---|
3
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
1 package de.intevation.gnv.propertiesreader; |
36
ad381cc47217
Format Code to max 80 Chars per Row
Tim Englich <tim.englich@intevation.de>
parents:
3
diff
changeset
|
2 |
3
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
3 /** |
690
254f062e334b
Added JavaDoc.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
684
diff
changeset
|
4 * An interface that defines a single method to retrieve properties specified by |
254f062e334b
Added JavaDoc.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
684
diff
changeset
|
5 * a key. |
254f062e334b
Added JavaDoc.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
684
diff
changeset
|
6 * |
684
57fa8019fbdc
Bring @author javadoc tags in form '@author <a href="john.doe@example.com">John Doe</a>'
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
683
diff
changeset
|
7 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> |
3
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
8 */ |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
9 public interface PropertiesReader { |
36
ad381cc47217
Format Code to max 80 Chars per Row
Tim Englich <tim.englich@intevation.de>
parents:
3
diff
changeset
|
10 |
690
254f062e334b
Added JavaDoc.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
684
diff
changeset
|
11 /** |
254f062e334b
Added JavaDoc.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
684
diff
changeset
|
12 * Retrieves a property by the given <i>ke<</i>. |
254f062e334b
Added JavaDoc.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
684
diff
changeset
|
13 * |
254f062e334b
Added JavaDoc.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
684
diff
changeset
|
14 * @param key The key of a property. |
254f062e334b
Added JavaDoc.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
684
diff
changeset
|
15 * @param defaultValue The default value which is returned if no property |
254f062e334b
Added JavaDoc.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
684
diff
changeset
|
16 * is found by <i>key</i>. |
254f062e334b
Added JavaDoc.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
684
diff
changeset
|
17 * @return the value of a property. |
254f062e334b
Added JavaDoc.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
684
diff
changeset
|
18 */ |
3
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
19 public String getPropertieValue(String key, String defaultValue); |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
20 } |
690
254f062e334b
Added JavaDoc.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
684
diff
changeset
|
21 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |