/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
/*
* LocalStringsImpl.java
*
* Created on December 3, 2005, 5:26 PM
*
*/
package com.sun.enterprise.util;
import java.util.ResourceBundle;
import java.text.MessageFormat;
/**
* This class makes getting localized strings super-simple. This is the companion
* class to Strings. Use this class when performance may be an issue. I.e. Strings
* is all-static and creates a ResourceBundle on every call. This class is instantiated
* once and can be used over and over from the same package.
* <p>Specifics:
* <ul>
* <li>Your calling code should have a file named LocalStrings.properties in its
* package directory.
* <li>If your localized string has no arguments call get(String) to get the localized
* String value.
* <li>If you have a parameterized string, call get(String, Object...)
* </ul>
* <p>Note: <b>You can not get an Exception out of calling this code!</b> If the String
* or the properties file does not exist, it will return the String that you gave
* in the first place as the argument.
* <p>Example:
* <ul>
* <li> LocalStringsImpl sh = new LocalStringsImpl();
* <li>String s = sh.get("xyz");
* <li>String s = sh.get("xyz", new Date(), 500, "something", 2.00003);
* <li>String s = sh.get("xyz", "something", "foo", "whatever");
* </ul>
*
* @author bnevins
*/
public class LocalStringsImpl
{
/**
* Create a LocalStringsImpl instance.
* Automatically discover the caller's LocalStrings.properties file
*/
public LocalStringsImpl()
{
setBundle();
}
/**
* Create a LocalStringsImpl instance.
* use the proffered class object to find LocalStrings.properties.
* This is the constructor to use if you are concerned about getting
* the fastest performance.
*/
public LocalStringsImpl(Class clazz)
{
setBundle(clazz);
}
/**
* Get a String from the caller's package's LocalStrings.properties
* @param indexString The string index into the localized string file
* @return the String from LocalStrings or the supplied String if it doesn't exist
*/
public String get(String indexString)
{
try
{
return getBundle().getString(indexString);
}
catch (Exception e)
{
// it is not an error to have no key...
return indexString;
}
}
/**
* Get and format a String from the caller's package's LocalStrings.properties
* @param indexString The string index into the localized string file
* @param objects The arguments to give to MessageFormat
* @return the String from LocalStrings or the supplied String if it doesn't exist --
* using the array of supplied Object arguments
*/
public String get(String indexString, Object... objects)
{
indexString = get(indexString);
try
{
MessageFormat mf = new MessageFormat(indexString);
return mf.format(objects);
}
catch(Exception e)
{
return indexString;
}
}
/**
* Get a String from the caller's package's LocalStrings.properties
* @param indexString The string index into the localized string file
* @return the String from LocalStrings or the supplied default value if it doesn't exist
*/
public String getString(String indexString, String defaultValue)
{
try
{
return getBundle().getString(indexString);
}
catch (Exception e)
{
// it is not an error to have no key...
return defaultValue;
}
}
/**
* Get an integer from the caller's package's LocalStrings.properties
* @param indexString The string index into the localized string file
* @return the integer value from LocalStrings or the supplied default if
* it doesn't exist or is bad.
*/
public int getInt(String indexString, int defaultValue)
{
try
{
String s = getBundle().getString(indexString);
return Integer.parseInt(s);
}
catch (Exception e)
{
// it is not an error to have no key...
return defaultValue;
}
}
/**
* Get a boolean from the caller's package's LocalStrings.properties
* @param indexString The string index into the localized string file
* @return the integer value from LocalStrings or the supplied default if
* it doesn't exist or is bad.
*/
public boolean getBoolean(String indexString, boolean defaultValue)
{
try
{
return Boolean.valueOf(getBundle().getString(indexString));
}
catch (Exception e)
{
// it is not an error to have no key...
return defaultValue;
}
}
///////////////////////////////////////////////////////////////////////////
private ResourceBundle getBundle()
{
return bundle;
}
///////////////////////////////////////////////////////////////////////////
private void setBundle()
{
// go through the stack, top to bottom. The item that is below the LAST
// method that is in the util framework is where the logfile is.
// note that there may be more than one method from util in the stack
// because they may be calling us indirectly from LoggerHelper. Also
// note that this class won't work from any class in the util hierarchy itself.
try
{
StackTraceElement[] items = Thread.currentThread().getStackTrace();
int lastMeOnStack = -1;
for(int i = 0; i < items.length; i++)
{
StackTraceElement item = items[i];
if(item.getClassName().startsWith(thisPackage))
lastMeOnStack = i;
}
String className = items[lastMeOnStack + 1].getClassName();
setBundle(className);
}
catch(Exception e)
{
bundle = null;
}
}
///////////////////////////////////////////////////////////////////////////
private void setBundle(Class clazz)
{
setBundle(clazz.getName());
}
///////////////////////////////////////////////////////////////////////////
private void setBundle(String className)
{
try
{
String props;
// handle the default package...
if(className.indexOf('.') < 0)
props = propsFilename;
else
props = className.substring(0, className.lastIndexOf('.')) + '.' + propsFilename;
bundle = ResourceBundle.getBundle(props);
}
catch(Exception e)
{
bundle = null;
}
}
///////////////////////////////////////////////////////////////////////////
private ResourceBundle bundle;
private static final String thisPackage = "com.sun.enterprise.util";
private String propsFilename = "LocalStrings";
}
|
