incubator-sling-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fmesc...@apache.org
Subject svn commit: r1089329 - in /sling/trunk/contrib/extensions/i18n/src/main/java/org/apache/sling/i18n: LocaleResolver.java ResourceBundleProvider.java
Date Wed, 06 Apr 2011 07:04:41 GMT
Author: fmeschbe
Date: Wed Apr  6 07:04:41 2011
New Revision: 1089329

URL: http://svn.apache.org/viewvc?rev=1089329&view=rev
Log:
JavaDoc ...

Modified:
    sling/trunk/contrib/extensions/i18n/src/main/java/org/apache/sling/i18n/LocaleResolver.java
    sling/trunk/contrib/extensions/i18n/src/main/java/org/apache/sling/i18n/ResourceBundleProvider.java

Modified: sling/trunk/contrib/extensions/i18n/src/main/java/org/apache/sling/i18n/LocaleResolver.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/i18n/src/main/java/org/apache/sling/i18n/LocaleResolver.java?rev=1089329&r1=1089328&r2=1089329&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/i18n/src/main/java/org/apache/sling/i18n/LocaleResolver.java
(original)
+++ sling/trunk/contrib/extensions/i18n/src/main/java/org/apache/sling/i18n/LocaleResolver.java
Wed Apr  6 07:04:41 2011
@@ -23,8 +23,30 @@ import java.util.Locale;
 
 import org.apache.sling.api.SlingHttpServletRequest;
 
+/**
+ * The <code>LocaleResolver</code> service interface may be implemented by a
+ * service registered under this name to allow the resolution of the request
+ * <code>Locale</code> to apply.
+ * <p>
+ * This interface is intended to be implemented by providers knowing how to
+ * resolve one or more <code>Locale</code>s applicable to handle the request.
+ * <p>
+ * Only a single <code>LocaleResolver</code> service is currently used.
+ */
 public interface LocaleResolver {
 
+    /**
+     * Return a non-<code>null</code> but possiby empty list of
+     * <code>Locale</code> instances to consider for localization of the current
+     * request. The list returned is assumed to be ordered by preference where
+     * the first entry is the prefered <code>Locale</code> and the last entry
is
+     * the least prefered <code>Locale</code>.
+     *
+     * @param request The <code>SlingHttpServletRequest</code> providing hints
+     *            and information for the <code>Locale</code> resolution.
+     * @return The list of <code>Locale</code>s to use for internationalization
+     *         of request processing
+     */
     List<Locale> resolveLocale(SlingHttpServletRequest request);
-    
+
 }

Modified: sling/trunk/contrib/extensions/i18n/src/main/java/org/apache/sling/i18n/ResourceBundleProvider.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/i18n/src/main/java/org/apache/sling/i18n/ResourceBundleProvider.java?rev=1089329&r1=1089328&r2=1089329&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/i18n/src/main/java/org/apache/sling/i18n/ResourceBundleProvider.java
(original)
+++ sling/trunk/contrib/extensions/i18n/src/main/java/org/apache/sling/i18n/ResourceBundleProvider.java
Wed Apr  6 07:04:41 2011
@@ -25,6 +25,11 @@ import java.util.ResourceBundle;
  * The <code>ResourceBundleProvider</code> service interface defines the API
  * for a service, which is capable of returned <code>ResourceBundle</code> for
  * given any <code>Locale</code>.
+ * <p>
+ * This interface defines the service API implemented by the existing
+ * implementation. It is not intended to be implemented by application bundles.
+ * Rather such bundles should get the <code>ResourceBundleProvider</code>
+ * service from the service registry to access the data provided.
  */
 public interface ResourceBundleProvider {
 



Mime
View raw message