public abstract class

LocaleContextHolder

extends Object
java.lang.Object
   ↳ org.springframework.context.i18n.LocaleContextHolder

Class Overview

Simple holder class that associates a LocaleContext instance with the current thread. The LocaleContext will be inherited by any child threads spawned by the current thread if the inheritable flag is set to true.

Used as a central holder for the current Locale in Spring, wherever necessary: for example, in MessageSourceAccessor. DispatcherServlet automatically exposes its current Locale here. Other applications can expose theirs too, to make classes like MessageSourceAccessor automatically use that Locale.

See Also

Summary

Public Constructors
LocaleContextHolder()
Public Methods
static Locale getLocale()
Return the Locale associated with the current thread, if any, or the system default Locale else.
static LocaleContext getLocaleContext()
Return the LocaleContext associated with the current thread, if any.
static void resetLocaleContext()
Reset the LocaleContext for the current thread.
static void setLocale(Locale locale, boolean inheritable)
Associate the given Locale with the current thread.
static void setLocale(Locale locale)
Associate the given Locale with the current thread.
static void setLocaleContext(LocaleContext localeContext)
Associate the given LocaleContext with the current thread, not exposing it as inheritable for child threads.
static void setLocaleContext(LocaleContext localeContext, boolean inheritable)
Associate the given LocaleContext with the current thread.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public LocaleContextHolder ()

Public Methods

public static Locale getLocale ()

Return the Locale associated with the current thread, if any, or the system default Locale else.

Returns
  • the current Locale, or the system default Locale if no specific Locale has been associated with the current thread
See Also

public static LocaleContext getLocaleContext ()

Return the LocaleContext associated with the current thread, if any.

Returns
  • the current LocaleContext, or null if none

public static void resetLocaleContext ()

Reset the LocaleContext for the current thread.

public static void setLocale (Locale locale, boolean inheritable)

Associate the given Locale with the current thread.

Will implicitly create a LocaleContext for the given Locale.

Parameters
locale the current Locale, or null to reset the thread-bound context
inheritable whether to expose the LocaleContext as inheritable for child threads (using an InheritableThreadLocal)
See Also

public static void setLocale (Locale locale)

Associate the given Locale with the current thread.

Will implicitly create a LocaleContext for the given Locale, not exposing it as inheritable for child threads.

Parameters
locale the current Locale, or null to reset the thread-bound context
See Also

public static void setLocaleContext (LocaleContext localeContext)

Associate the given LocaleContext with the current thread, not exposing it as inheritable for child threads.

Parameters
localeContext the current LocaleContext

public static void setLocaleContext (LocaleContext localeContext, boolean inheritable)

Associate the given LocaleContext with the current thread.

Parameters
localeContext the current LocaleContext, or null to reset the thread-bound context
inheritable whether to expose the LocaleContext as inheritable for child threads (using an InheritableThreadLocal)