com.sun.grizzly.util.res..svn.text-base.StringManager.svn-base Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the "License"). You may not use this file except
* in compliance with the License.
*
* You can obtain a copy of the license at
* glassfish/bootstrap/legal/CDDLv1.0.txt or
* https://glassfish.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* HEADER in each file and include the License file at
* glassfish/bootstrap/legal/CDDLv1.0.txt. If applicable,
* add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your
* own identifying information: Portions Copyright [yyyy]
* [name of copyright owner]
*
* Copyright 2005 Sun Microsystems, Inc. All rights reserved.
*
* Portions Copyright Apache Software Foundation.
*/
package com.sun.grizzly.util.res;
import java.text.MessageFormat;
import java.util.*;
/**
* An internationalization / localization helper class which reduces
* the bother of handling ResourceBundles and takes care of the
* common cases of message formating which otherwise require the
* creation of Object arrays and such.
*
* The StringManager operates on a package basis. One StringManager
* per package can be created and accessed via the getManager method
* call.
*
*
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 classpath.
*
*
Please see the documentation for java.util.ResourceBundle for
* more information.
*
* @version $Revision: 1.2 $ $Date: 2005/12/08 01:29:37 $
*
* @author James Duncan Davidson [[email protected]]
* @author James Todd [[email protected]]
* @author Mel Martinez [[email protected]]
* @see java.util.ResourceBundle
*/
public class StringManager {
/**
* The ResourceBundle for this StringManager.
*/
private ResourceBundle bundle;
/**
* 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.
*/
private StringManager(String packageName) {
this( packageName, Locale.getDefault() );
}
private StringManager(String packageName,Locale loc) {
String bundleName = packageName + ".LocalStrings";
try {
bundle = ResourceBundle.getBundle(bundleName,loc);
} catch( MissingResourceException ex ) {
bundle= ResourceBundle.getBundle( bundleName, Locale.US, Thread.currentThread().getContextClassLoader());
}
}
private StringManager(ResourceBundle bundle )
{
this.bundle=bundle;
}
/**
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 key from underlying
bundle or null if not found.
@throws IllegalArgumentException if key is null.
*/
public String getString(String key) {
if(key == null){
String msg = "key may not have a null value";
throw new IllegalArgumentException(msg);
}
String str = null;
try{
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.
str = null;
}
return str;
}
/**
* Get a string from the underlying resource bundle and format
* it with the given set of arguments.
*
* @param key
* @param args
*/
public String getString(String key, Object[] args) {
String iString = null;
String value = getString(key);
// this check for the runtime exception is some pre 1.1.6
// VM's don't do an automatic toString() on the passed in
// objects and barf out
try {
// ensure the arguments are not null so pre 1.2 VM's don't barf
if(args==null){
args = new Object[1];
}
Object[] nonNullArgs = args;
for (int i=0; i