commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dflo...@apache.org
Subject svn commit: r154509 - jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/MessageProvider.java
Date Sun, 20 Feb 2005 13:01:52 GMT
Author: dflorey
Date: Sun Feb 20 05:01:51 2005
New Revision: 154509

URL: http://svn.apache.org/viewcvs?view=rev&rev=154509
Log:
Javadocs added

Modified:
    jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/MessageProvider.java

Modified: jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/MessageProvider.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/MessageProvider.java?view=diff&r1=154508&r2=154509
==============================================================================
--- jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/MessageProvider.java
(original)
+++ jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/MessageProvider.java
Sun Feb 20 05:01:51 2005
@@ -25,8 +25,29 @@
 import java.util.Locale;
 import java.util.Map;
 
+/**
+ * The <code>MessageProvider</code> interface specifies the methods that
+ * must be implemented by each message provider in order to be pluggable 
+ * into the <code>MessageManager</code>.
+ *
+ */
 public interface MessageProvider {
+    /**
+     * @param id unique id that specifies a particular message  
+     * @param entry specifies a particular entry in the specified message 
+     * @param locale the locale for which this text should be provided
+     * @return returns the localized message entry matching the given message id, entry key
and locale
+     * @throws MessageNotFoundException thrown if no message exists matching the given id
or if 
+     * the specified message does not contain the desired entry 
+     */
     public String getText(String id, String entry, Locale locale) throws MessageNotFoundException;
     
+    /**
+     * @param id unique id that specifies a particular message  
+     * @param locale the locale for which to return the entries
+     * @return returns a map <code>&lt;entry(String) -> localized text(String)<code>
of 
+     * message entries matching the given message id and locale 
+     * @throws MessageNotFoundException thrown if no message could be found matching the
given message id
+     */
     public Map getEntries(String id, Locale locale) throws MessageNotFoundException;
 }



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message