org.eclipse.osgi.service.localization.LocaleProvider Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aspectjtools Show documentation
Show all versions of aspectjtools Show documentation
Tools from the AspectJ project
/*******************************************************************************
* Copyright (c) 2009 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.osgi.service.localization;
import java.util.Locale;
/**
* A service that is used to determine what the current locale is for a
* particular context or session. If no LocaleProvider
* service is available then the locale must be determined by other
* means, for example, by calling {@link Locale#getDefault()}.
*
* More advanced environments can support multiple locales within a
* single system. For example, a server may support multiple users,
* each needing a different locale. In such an environment a
* LocaleProvider service must be registered that can
* determine the current locale for the context of the call to the
* {@link #getLocale()} method.
*
* @since 1.1
*/
public interface LocaleProvider {
/**
* Determines the current locale for the context of the call to
* this method. For environments that support a single system wide
* locale, this is equivalent to calling {@link Locale#getDefault()}.
*
* The result of this method should not be retained or passed to other
* threads. The current locale can change any time and may be
* different for each thread.
*
* @return The current locale.
*/
public Locale getLocale();
}