Class AbstractInternationalString

    • Constructor Detail

      • AbstractInternationalString

        protected AbstractInternationalString()
        Constructs an international string.
    • Method Detail

      • length

        public int length()
        Returns the length of the string in the default locale. This is the length of the string returned by to­String().
        Specified by:
        length in interface Char­Sequence
        Returns:
        length of the string in the default locale.
      • subSequence

        public CharSequence subSequence​(int start,
                                        int end)
        Returns a subsequence of the string in the default locale. The subsequence is a String object starting with the character value at the specified index and ending with the character value at index end - 1.
        Specified by:
        sub­Sequence in interface Char­Sequence
        Parameters:
        start - the start index, inclusive.
        end - the end index, exclusive.
        Returns:
        the specified subsequence.
        Throws:
        Index­Out­Of­Bounds­Exception - if start or end is out of range.
      • toString

        public abstract String toString​(Locale locale)
        Returns this string in the given locale. If no string is available in the given locale, then some fallback locale is used. The fallback locale is implementation-dependent, and is not necessarily the same than the default locale used by the to­String() method.
        Handling of Locale​.ROOT argument value
        Locale​.ROOT can be given to this method for requesting a "unlocalized" string, typically some programmatic values like enumerations or identifiers. While identifiers often look like English words, Locale​.ROOT is not considered synonymous to Locale​.ENGLISH because the values may differ in the way numbers and dates are formatted (e.g. using the ISO 8601 standard for dates instead than English conventions).
        Handling of null argument value
        The Locale​.ROOT constant is new in Java 6. Some other libraries designed for Java 5 use the null value for "unlocalized" strings. Apache SIS accepts null value for inter-operability with those libraries. However the behavior is implementation dependent: some subclasses will take null as a synonymous of the system default locale, while other subclasses will take null as a synonymous of the root locale. In order to ensure determinist behavior, client code are encouraged to specify only non-null values.
        Specified by:
        to­String in interface International­String
        Parameters:
        locale - the desired locale for the string to be returned.
        Returns:
        the string in the given locale if available, or in an implementation-dependent fallback locale otherwise.
        See Also:
        Locale​.get­Default(), Locale​.ROOT
      • formatTo

        public void formatTo​(Formatter formatter,
                             int flags,
                             int width,
                             int precision)
        Formats this international string using the given formatter. This method appends the string obtained by:
        to­String(formatter.Formatter​.locale())
        Specified by:
        format­To in interface Formattable
        Parameters:
        formatter - the formatter to use for formatting this string.
        flags - a bitmask of Formattable­Flags values.
        width - the minimum number of characters, or -1 if none.
        precision - the maximum number of characters (before expanding to the width), or -1 for no restriction.
      • compareTo

        public int compareTo​(InternationalString object)
        Compares this string with the specified object for order. This method compares the string in the default locale, as returned by to­String().
        Specified by:
        compare­To in interface Comparable<International­String>
        Parameters:
        object - the string to compare with this string.
        Returns:
        a negative number if this string is before the given string, a positive number if after, or 0 if equals.