/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
*
* 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
* 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.
*/
/**
* A local string manager.
* This interface describes the access to i18n messages for classes that need
* them.
*/
public interface LocalStringManager {
/**
* Get a localized string.
* Strings are stored in a single property file per package named
* LocalStrings[_locale].properties. Starting from the class of the
* caller, we walk up the class hierarchy until we find a package
* resource bundle that provides a value for the requested key.
* <p/>
* <p>This simplifies access to resources, at the cost of checking for
* the resource bundle of several classes upon each call. However, due
* to the caching performed by <tt>ResourceBundle</tt> this seems
* reasonable.
* <p/>
* <p>Due to that, sub-classes <strong>must</strong> make sure they don't
* have conflicting resource naming.
*
* @param callerClass The object making the call, to allow per-package
* resource bundles
* @param key The name of the resource to fetch
* @param defaultValue The default return value if not found
* @return The localized value for the resource
*/
);
/**
* Get a local string for the caller and format the arguments accordingly.
*
* @param callerClass The caller (to walk through its class hierarchy)
* @param key The key to the local format string
* @param defaultFormat The default format if not found in the resources
* @param arguments The set of arguments to provide to the formatter
* @return A formatted localized string
*/
);
}