Author: markt
Date: Tue May 26 07:51:05 2015
New Revision: 1681699
URL: http://svn.apache.org/r1681699
Log:
Javadoc
Modified:
tomcat/trunk/java/org/apache/tomcat/util/res/StringManager.java
Modified: tomcat/trunk/java/org/apache/tomcat/util/res/StringManager.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/res/StringManager.java?rev=1681699&r1=1681698&r2=1681699&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/util/res/StringManager.java (original)
+++ tomcat/trunk/java/org/apache/tomcat/util/res/StringManager.java Tue May 26
07:51:05 2015
@@ -150,6 +150,9 @@ public class StringManager {
*
* @param key The key for the required message
* @param args The values to insert into the message
+ *
+ * @return The request string formatted with the provided arguments or the
+ * key if the key was not found.
*/
public String getString(final String key, final Object... args) {
String value = getString(key);
@@ -164,7 +167,9 @@ public class StringManager {
/**
- * Identify the Locale this StringManager is associated with
+ * Identify the Locale this StringManager is associated with.
+ *
+ * @return The Locale associated with the StringManager
*/
public Locale getLocale() {
return locale;
@@ -186,6 +191,8 @@ public class StringManager {
* StringManager will be created and returned.
*
* @param clazz The class for which to retrieve the StringManager
+ *
+ * @return The instance associated with the package of the provide class
*/
public static final StringManager getManager(Class<?> clazz) {
return getManager(clazz.getPackage().getName());
@@ -198,6 +205,9 @@ public class StringManager {
* StringManager will be created and returned.
*
* @param packageName The package name
+ *
+ * @return The instance associated with the given package and the default
+ * Locale
*/
public static final StringManager getManager(String packageName) {
return getManager(packageName, Locale.getDefault());
@@ -211,6 +221,8 @@ public class StringManager {
*
* @param packageName The package name
* @param locale The Locale
+ *
+ * @return The instance associated with the given package and Locale
*/
public static final synchronized StringManager getManager(
String packageName, Locale locale) {
@@ -252,7 +264,9 @@ public class StringManager {
* Retrieve the StringManager for a list of Locales. The first
StringManager
* found will be returned.
*
- * @param requestedLocales the list of Locales
+ * @param packageName The package for which the StringManager was
+ * requested
+ * @param requestedLocales The list of Locales
*
* @return the found StringManager or the default StringManager
*/
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
