/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2008-2010 Oracle and/or its affiliates. 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_1_1.html
* or packager/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 packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [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.
*/
package com.sun.enterprise.universal.i18n;
/**
* This class makes getting localized strings super-simple. All methods are static.
* The reason is that that makes it much simpler to use -- you never need to create an
* instance and store it. You simply call one of the 2 methods directly. However,
* there is a performance penalty for this convenience. This class has to figure out
* what package your calling code is in (every time). My reasoning is that the emitting
* of log messages tends to be much less frequent than other normal processing steps.
* If performance is an issue -- use an instance of LocalStringsImpl.
* <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>Examples:
* <ul>
* <li>String s = LocalStrings.get("xyz");
* <li>String s = LocalStrings.get("xyz", new Date(), 500, "something", 2.00003);
* <li>String s = LocalStrings.get("xyz", "something", "foo", "whatever");
* </ul>
*
*
*
* @author bnevins
*/
public class LocalStrings {
private LocalStrings() {
}
/**
* 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 static String get(String indexString) {
return new LocalStringsImpl().get(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 static String get(String indexString, Object... objects) {
return new LocalStringsImpl().get(indexString, objects);
}
/**
* 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) {
return new LocalStringsImpl().get(indexString, 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 static int getInt(String indexString, int defaultValue) {
return new LocalStringsImpl().getInt(indexString, 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) {
return new LocalStringsImpl().getBoolean(indexString, defaultValue);
}
}