--- a/artifact-database/src/main/java/de/intevation/artifactdatabase/DefaultPreferredLocale.java	Fri Mar 26 15:05:11 2010 +0000
+++ b/artifact-database/src/main/java/de/intevation/artifactdatabase/DefaultPreferredLocale.java	Fri Mar 26 16:16:32 2010 +0000
@@ -5,17 +5,35 @@
 import java.util.Locale;
 
 /**
+ * Models a pair of Locale and quality (0.0-1.0) to be used to
+ * find best matching locale between server offerings and clients requests.
+ * 
  * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a>
  */
 public class DefaultPreferredLocale
 implements   PreferredLocale
 {
+    /**
+     * The locale of this tuple pair.
+     */
     protected Locale locale;
+    /**
+     * The quality of this tuple pair between 0.0 and 1.0.
+     */
     protected float  quality;
 
+    /**
+     * Default constructor
+     */
     public DefaultPreferredLocale() {
     }
 
+    /**
+     * Constructor to build a pair of given a locale speficied by
+     * string 'lang' and an given 'quality'.
+     * @param lang The name of the locale.
+     * @param quality The quality of the locale.
+     */
     public DefaultPreferredLocale(String lang, float quality) {
         locale = new Locale(lang);
         this.quality = quality;
@@ -29,4 +47,4 @@
         return quality;
     }
 }
-// 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 :