All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.xml.ws.security.opt.impl.util.LocalStringManager Maven / Gradle / Ivy

There is a newer version: 4.0.3
Show newest version
/*
 * Copyright (c) 1997, 2021 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

package com.sun.xml.ws.security.opt.impl.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[] ); public String getLocalString(String key, String defaultValue); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy