com.sun.enterprise.naming.util.LocalStringManager Maven / Gradle / Ivy
/*
* Copyright (c) 2006, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package com.sun.enterprise.naming.util;
/**
* 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.
*
* 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 ResourceBundle this seems
* reasonable.
*
* Due to that, sub-classes must 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
*/
public String getLocalString(
Class callerClass,
String key,
String defaultValue
);
/**
* 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
*/
public String getLocalString(
Class callerClass,
String key,
String defaultFormat,
Object arguments[]
);
}