Annotation Type LocaleString


  • @Retention(RUNTIME)
    @Target(ANNOTATION_TYPE)
    public @interface LocaleString
    This annotation represents locale-specific strings used within composite portlet configuration annotations to represent information describing the portlet. It cannot be used as a stand-alone portlet annotation.
    Since:
    3.0
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String value
      The parameter value
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      String locale
      The locale for the locale-specific string.
    • Element Detail

      • value

        String value
        The parameter value
        Returns:
        The parameter value
      • locale

        String locale
        The locale for the locale-specific string.

        The locale is specified as a language tag as defined in IETF BCP 47, "Tags for Identifying Languages".

        Returns:
        The locale
        See Also:
        Locale, forLanguageTag, IETF BCP 47
        Default:
        "en"