Package org.apache.tapestry5.services

# Interface PersistentLocale

All Known Implementing Classes:
  `PersistentLocaleImpl`

public interface PersistentLocale
Manages the persistent locale stored in the browser (inside the URL).

See Also:
  - `LocalizationSetter.setLocaleFromLocaleName(String)`
  - `LocalizationSetter`
  - `ComponentEventLinkEncoder`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `Locale`
  `get()`
  Gets the locale obtained from the request, or null if the response did not indicate a specific locale (in which case the active locale may have been determined from request headers).
  `boolean`
  `isSet()`
  `void`
  `set(Locale locale)`
  Sets the locale value that will be encoded into the response.

- ## Method Details

  - ### set

    void set(Locale locale)
    Sets the locale value that will be encoded into the response. This must match a locale configured via `SymbolConstants.SUPPORTED_LOCALES`.
    Throws:
      `IllegalArgumentException` - if the locale is not valid

  - ### get

    Locale get()
    Gets the locale obtained from the request, or null if the response did not indicate a specific locale (in which case the active locale may have been determined from request headers).

  - ### isSet

    boolean isSet()
    Returns:
      true if a locale was present in the request URL; false otherwise.