This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch 10.1.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
commit 92ad2363b2fa836d0bc5443272c00507a3fe4573
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Tue Jan 24 11:11:08 2023 +0000
Code cleanup (format). No functional change.
---
java/org/apache/tomcat/util/res/StringManager.java | 119 +++++++++------------
1 file changed, 49 insertions(+), 70 deletions(-)
diff --git a/java/org/apache/tomcat/util/res/StringManager.java
b/java/org/apache/tomcat/util/res/StringManager.java
index ce68dc9827..8abff4dc71 100644
--- a/java/org/apache/tomcat/util/res/StringManager.java
+++ b/java/org/apache/tomcat/util/res/StringManager.java
@@ -26,27 +26,22 @@ import java.util.MissingResourceException;
import java.util.ResourceBundle;
/**
- * An internationalization / localization helper class which reduces
- * the bother of handling ResourceBundles and takes care of the
- * common cases of message formatting which otherwise require the
- * creation of Object arrays and such.
- *
- * <p>The StringManager operates on a package basis. One StringManager
- * per package can be created and accessed via the getManager method
- * call.
- *
- * <p>The StringManager will look for a ResourceBundle named by
- * the package name given plus the suffix of "LocalStrings". In
- * practice, this means that the localized information will be contained
- * in a LocalStrings.properties file located in the package
- * directory of the class path.
- *
- * <p>Please see the documentation for java.util.ResourceBundle for
- * more information.
+ * An internationalization / localization helper class which reduces the
bother of handling ResourceBundles and takes
+ * care of the common cases of message formatting which otherwise require the
creation of Object arrays and such.
+ * <p>
+ * The StringManager operates on a package basis. One StringManager per
package can be created and accessed via the
+ * getManager method call.
+ * <p>
+ * The StringManager will look for a ResourceBundle named by the package name
given plus the suffix of "LocalStrings".
+ * In practice, this means that the localized information will be contained in
a LocalStrings.properties file located in
+ * the package directory of the class path.
+ * <p>
+ * Please see the documentation for java.util.ResourceBundle for more
information.
*
* @author James Duncan Davidson [dun...@eng.sun.com]
* @author James Todd [go...@eng.sun.com]
* @author Mel Martinez [mmarti...@g1440.com]
+ *
* @see java.util.ResourceBundle
*/
public class StringManager {
@@ -61,10 +56,8 @@ public class StringManager {
/**
- * Creates a new StringManager for a given package. This is a
- * private method and all access to it is arbitrated by the
- * static getManager method call so that only one StringManager
- * per package will be created.
+ * Creates a new StringManager for a given package. This is a private
method and all access to it is arbitrated by
+ * the static getManager method call so that only one StringManager per
package will be created.
*
* @param packageName Name of package to create StringManager for.
*/
@@ -109,18 +102,16 @@ public class StringManager {
/**
- * Get a string from the underlying resource bundle or return null if the
- * String is not found.
+ * Get a string from the underlying resource bundle or return null if the
String is not found.
*
* @param key to desired resource String
*
- * @return resource String matching <i>key</i> from underlying bundle or
- * null if not found.
+ * @return resource String matching <i>key</i> from underlying bundle or
null if not found.
*
* @throws IllegalArgumentException if <i>key</i> is null
*/
public String getString(String key) {
- if (key == null){
+ if (key == null) {
String msg = "key may not have a null value";
throw new IllegalArgumentException(msg);
}
@@ -133,17 +124,17 @@ public class StringManager {
str = bundle.getString(key);
}
} catch (MissingResourceException mre) {
- //bad: shouldn't mask an exception the following way:
- // str = "[cannot find message associated with key '" + key +
- // "' due to " + mre + "]";
- // because it hides the fact that the String was missing
- // from the calling code.
- //good: could just throw the exception (or wrap it in another)
- // but that would probably cause much havoc on existing
- // code.
- //better: consistent with container pattern to
- // simply return null. Calling code can then do
- // a null check.
+ // bad: shouldn't mask an exception the following way:
+ // str = "[cannot find message associated with key '" + key +
+ // "' due to " + mre + "]";
+ // because it hides the fact that the String was missing
+ // from the calling code.
+ // good: could just throw the exception (or wrap it in another)
+ // but that would probably cause much havoc on existing
+ // code.
+ // better: consistent with container pattern to
+ // simply return null. Calling code can then do
+ // a null check.
str = null;
}
@@ -152,14 +143,12 @@ public class StringManager {
/**
- * Get a string from the underlying resource bundle and format
- * it with the given set of arguments.
+ * Get a string from the underlying resource bundle and format it with the
given set of arguments.
*
* @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.
+ * @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);
@@ -187,14 +176,13 @@ public class StringManager {
// STATIC SUPPORT METHODS
// --------------------------------------------------------------
- private static final Map<String, Map<Locale,StringManager>> managers = new
HashMap<>();
+ private static final Map<String, Map<Locale, StringManager>> managers =
new HashMap<>();
/**
- * Get the StringManager for a given class. The StringManager will be
- * returned for the package in which the class is located. If a manager for
- * that package already exists, it will be reused, else a new
- * StringManager will be created and returned.
+ * Get the StringManager for a given class. The StringManager will be
returned for the package in which the class is
+ * located. If a manager for that package already exists, it will be
reused, else a new StringManager will be
+ * created and returned.
*
* @param clazz The class for which to retrieve the StringManager
*
@@ -206,14 +194,12 @@ public class StringManager {
/**
- * Get the StringManager for a particular package. If a manager for
- * a package already exists, it will be reused, else a new
- * StringManager will be created and returned.
+ * Get the StringManager for a particular package. If a manager for a
package already exists, it will be reused,
+ * else a new StringManager will be created and returned.
*
* @param packageName The package name
*
- * @return The instance associated with the given package and the default
- * Locale
+ * @return The instance associated with the given package and the default
Locale
*/
public static final StringManager getManager(String packageName) {
return getManager(packageName, Locale.getDefault());
@@ -221,33 +207,29 @@ public class StringManager {
/**
- * Get the StringManager for a particular package and Locale. If a manager
- * for a package/Locale combination already exists, it will be reused, else
- * a new StringManager will be created and returned.
+ * Get the StringManager for a particular package and Locale. If a manager
for a package/Locale combination already
+ * exists, it will be reused, else a new StringManager will be created and
returned.
*
* @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) {
+ public static final synchronized StringManager getManager(String
packageName, Locale locale) {
- Map<Locale,StringManager> map = managers.get(packageName);
+ Map<Locale, StringManager> map = managers.get(packageName);
if (map == null) {
/*
- * Don't want the HashMap to be expanded beyond LOCALE_CACHE_SIZE.
- * Expansion occurs when size() exceeds capacity. Therefore keep
- * size at or below capacity.
- * removeEldestEntry() executes after insertion therefore the test
- * for removal needs to use one less than the maximum desired size
+ * Don't want the HashMap to be expanded beyond LOCALE_CACHE_SIZE.
Expansion occurs when size() exceeds
+ * capacity. Therefore keep size at or below capacity.
removeEldestEntry() executes after insertion
+ * therefore the test for removal needs to use one less than the
maximum desired size
*
*/
map = new LinkedHashMap<>(LOCALE_CACHE_SIZE, 1, true) {
private static final long serialVersionUID = 1L;
+
@Override
- protected boolean removeEldestEntry(
- Map.Entry<Locale,StringManager> eldest) {
+ protected boolean removeEldestEntry(Map.Entry<Locale,
StringManager> eldest) {
if (size() > (LOCALE_CACHE_SIZE - 1)) {
return true;
}
@@ -267,17 +249,14 @@ public class StringManager {
/**
- * Retrieve the StringManager for a list of Locales. The first
StringManager
- * found will be returned.
+ * Retrieve the StringManager for a list of Locales. The first
StringManager found will be returned.
*
- * @param packageName The package for which the StringManager was
- * requested
+ * @param packageName The package for which the StringManager was
requested
* @param requestedLocales The list of Locales
*
* @return the found StringManager or the default StringManager
*/
- public static StringManager getManager(String packageName,
- Enumeration<Locale> requestedLocales) {
+ public static StringManager getManager(String packageName,
Enumeration<Locale> requestedLocales) {
while (requestedLocales.hasMoreElements()) {
Locale locale = requestedLocales.nextElement();
StringManager result = getManager(packageName, locale);
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
