Package org.apache.struts2.locale

Interface LocaleProvider

All Known Subinterfaces:
ValidatorContext
All Known Implementing Classes:
ActionSupport, CspReportAction, DefaultActionSupport, DefaultCspReportAction, DefaultLocaleProvider, DelegatingValidatorContext, VisitorFieldValidator.AppendingValidatorContext
public interface LocaleProvider
Indicates that the implementing class can provide its own Locale.

This is useful for when an action may wish override the default locale. All that is needed is to implement this interface and return your own custom locale. The TextProvider interface uses this interface heavily for retrieving internationalized messages from resource bundles.

  • Method Details

    • getLocale

      Locale getLocale()
      Gets the provided locale.
      Returns:
      the locale.

    • isValidLocaleString

      boolean isValidLocaleString(String localeStr)
      Validates if provided string is a valid Locale
      Parameters:
      localeStr - a String representing locale, e.g. en_EN
      Returns:
      true if valid

    • isValidLocale

      boolean isValidLocale(Locale locale)
      Validates if provided Locale is value
      Parameters:
      locale - instance of Locale to validate
      Returns:
      true if valid

    • toLocale

      default Locale toLocale(String localeStr)
      Tries to convert provided locale string into Locale or returns null
      Parameters:
      localeStr - a String representing locale, e.g.: en_EN
      Returns:
      instance of Locale or null
      Since:
      Struts 6.5.0