Context Navigation

Changeset 3434

Timestamp:

04/28/09 15:46:42 (4 years ago)

Author:

mosipov

Message:

Improved JavaDocs

Location:

Files:

-                      r2868
+                      r3434
         /**
+         * Returns the locale of a give request.
+         *
          * @param request
          *            The current request instance.
          * @return The locale of the user or <code>null</code> if the locale
          *         cannot be resolved.
+         *            the current request instance
+         * @return the locale of the request, <code>null</code> if the locale
+         *         couldn't be resolved
          */
         public Locale resolveLocale(final HttpServletRequest request);

-                      r2868
+                      r3434
 /**
+ * This implementation simply returns the user locale with
+ * {@link ServletRequest#getLocale()} but it has an advantage over the named
+ * method. If the <code>Accept-Language</code> header is empty, the default
+ * server locale will be returned. This behavior is undesired and can lead to
+ * wrong localized messages. Instead, this implementation will only return the
+ * locale if the header is not empty.
+ * Resolves the current user locale by calling
+ * {@link ServletRequest#getLocale()}. This method is somewhat superior to the
+ * <code>getLocale</code> method because it returns a locale if and only if the
+ * <code>Accept-Language</code> header is not empty.
+ *
  * @version $Id$
 …
 public class AcceptLanguageHeaderResolver implements LocaleResolver {
-        /*
-         * (non-Javadoc)
+         *
-         * @see net.fckeditor.localization.LocaleResolver#resolveLocale(javax.servlet.http.HttpServletRequest)
-         */
         public Locale resolveLocale(final HttpServletRequest request) {

-                      r2868
+                      r3434
 /**
  * This implementation maps directly to the JSTL locale mechanism. This is
+ * Resolves the current user locale against JSTL/FMT session locale. This is
  * recommended for those who use FMT tags for example.
+ *
 …
+        }
-        /*
-         * (non-Javadoc)
-         * @see net.fckeditor.localization.LocaleResolver#resolveLocale(javax.servlet.http.HttpServletRequest)
-         */
         public Locale resolveLocale(final HttpServletRequest request) {

Note: See TracChangeset for help on using the changeset viewer.