Mercurial > dive4elements > gnv-client
diff gnv-artifacts/src/main/java/de/intevation/gnv/statistics/Statistic.java @ 814:9d427dd2a96a
Added Javadoc in statistic package.
gnv-artifacts/trunk@898 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author | Ingo Weinzierl <ingo.weinzierl@intevation.de> |
---|---|
date | Fri, 09 Apr 2010 14:34:45 +0000 |
parents | 7fb9441dd8af |
children | 05bf8534a35a |
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/statistics/Statistic.java Fri Apr 09 13:09:25 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/statistics/Statistic.java Fri Apr 09 14:34:45 2010 +0000 @@ -18,16 +18,9 @@ import org.apache.log4j.Logger; /** - * The class <code>Statistic</code> fulfills the following purposes: - * <ol> - * <li></li> - * </ol> + * This class stores a double value with a specific key. * * @author blume - * @version 1.0 - * @serial 1.0 - * @see - * @since 14.12.2007 09:38:18 */ public class Statistic { @@ -40,22 +33,41 @@ private double mValue; private String mKey; + /** + * Creates a new Statistic with a given key and a value. + * @param pKey The key. + * @param pValue The value. + */ public Statistic(String pKey, double pValue) { mKey = pKey; mValue = pValue; } + /** + * Returns the value. + * @return the value. + */ public double getValue() { return mValue; } + /** + * Returns the key. + * @return the key. + */ public String getKey() { return mKey; } + /** + * Turns the value into string representation and returns it.<br> + * <b>Attention:</b> This method doesn't take a locale into account. + * + * @return the value as string. + */ public String getStringValue() { java.text.DecimalFormat df = new java.text.DecimalFormat("#.##"); return df.format(mValue); } - } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file