Interface InternationalString

All Superinterfaces:
Char­Sequence, Comparable<International­String>
All Known Implementing Classes:
Abstract­International­String, Default­International­String, Resource­International­String, Simple­International­String
public interface InternationalString extends CharSequence, Comparable<InternationalString>
A string that has been internationalized into several locales. This interface is used as a replacement for the String type whenever an attribute needs to be internationalization capable.

The natural ordering is defined by the lexicographical ordering of strings in the default locale, as returned by to­String(). This string also defines the character sequence for this object.

Since:
2.0
See Also:

  • Method Details

    • toString

      String toString(Locale locale)
      Returns this string in the given locale. If no string is available in the given locale, then some default locale is used. The default locale is implementation-dependent. It may or may not be the system default.
      Parameters:
      locale - The desired locale for the string to be returned, or null for a string in the implementation default locale.
      Returns:
      The string in the given locale if available, or in the default locale otherwise.

    • toString

      String toString()
      Returns this string in the default locale. The default locale is implementation-dependent. It may or may not be the system default. If the default locale is the system default (a recommended practice), then invoking this method is equivalent to invoking to­String(Locale​.get­Default()).

      All methods from Char­Sequence operate on this string. This string is also used as the criterion for natural ordering.

      Specified by:
      to­String in interface Char­Sequence
      Overrides:
      to­String in class Object
      Returns:
      The string in the default locale.