Package com.ibm.icu.text

Class ListFormatter

java.lang.Object
com.ibm.icu.text.ListFormatter
public final class ListFormatter extends Object
Immutable class for formatting a list, using data from CLDR (or supplied separately). The class is not subclassable.

  • Field Details

    • start

      private final String start

    • middle

      private final String middle

    • locale

      private final ULocale locale

    • patternHandler

      private final ListFormatter.PatternHandler patternHandler

    • compiledY

      private static final String compiledY

    • compiledE

      private static final String compiledE

    • compiledO

      private static final String compiledO

    • compiledU

      private static final String compiledU

    • changeToE

      private static final Pattern changeToE

    • changeToU

      private static final Pattern changeToU

    • compiledVav

      private static final String compiledVav

    • compiledVavDash

      private static final String compiledVavDash

    • changeToVavDash

      private static final Pattern changeToVavDash

    • cache

      static ListFormatter.Cache cache

  • Constructor Details

    • ListFormatter

      @Deprecated public ListFormatter(String two, String start, String middle, String end)
      Deprecated.
      This API is ICU internal only.
      Internal: Create a ListFormatter from component strings, with definitions as in LDML.
      Parameters:
      two - string for two items, containing {0} for the first, and {1} for the second.
      start - string for the start of a list items, containing {0} for the first, and {1} for the rest.
      middle - string for the start of a list items, containing {0} for the first part of the list, and {1} for the rest of the list.
      end - string for the end of a list items, containing {0} for the first part of the list, and {1} for the last item.

    • ListFormatter

      private ListFormatter(String two, String start, String middle, String end, ULocale locale)

  • Method Details

    • compilePattern

      private static String compilePattern(String pattern, StringBuilder sb)

    • getInstance

      public static ListFormatter getInstance(ULocale locale, ListFormatter.Type type, ListFormatter.Width width)
      Create a list formatter that is appropriate for a locale.
      Parameters:
      locale - the locale in question.
      Returns:
      ListFormatter

    • getInstance

      public static ListFormatter getInstance(Locale locale, ListFormatter.Type type, ListFormatter.Width width)
      Create a list formatter that is appropriate for a locale.
      Parameters:
      locale - the locale in question.
      Returns:
      ListFormatter

    • getInstance

      public static ListFormatter getInstance(ULocale locale)
      Create a list formatter that is appropriate for a locale.
      Parameters:
      locale - the locale in question.
      Returns:
      ListFormatter

    • getInstance

      public static ListFormatter getInstance(Locale locale)
      Create a list formatter that is appropriate for a locale.
      Parameters:
      locale - the locale in question.
      Returns:
      ListFormatter

    • getInstance

      public static ListFormatter getInstance()
      Create a list formatter that is appropriate for the default FORMAT locale.
      Returns:
      ListFormatter

    • format

      public String format(Object... items)
      Format a list of objects.
      Parameters:
      items - items to format. The toString() method is called on each.
      Returns:
      items formatted into a string

    • format

      public String format(Collection<?> items)
      Format a collection of objects. The toString() method is called on each.
      Parameters:
      items - items to format. The toString() method is called on each.
      Returns:
      items formatted into a string

    • formatToValue

      public ListFormatter.FormattedList formatToValue(Object... items)
      Format a list of objects to a FormattedList. You can access the offsets of each element from the FormattedList.
      Parameters:
      items - items to format. The toString() method is called on each.
      Returns:
      items formatted into a FormattedList

    • formatToValue

      public ListFormatter.FormattedList formatToValue(Collection<?> items)
      Format a collection of objects to a FormattedList. You can access the offsets of each element from the FormattedList.
      Parameters:
      items - items to format. The toString() method is called on each.
      Returns:
      items formatted into a FormattedList

    • formatImpl

      ListFormatter.FormattedListBuilder formatImpl(Collection<?> items, boolean needsFields)

    • createPatternHandler

      private ListFormatter.PatternHandler createPatternHandler(String two, String end)

    • getPatternForNumItems

      public String getPatternForNumItems(int count)
      Returns the pattern to use for a particular item count.
      Parameters:
      count - the item count.
      Returns:
      the pattern with {0}, {1}, {2}, etc. For English, getPatternForNumItems(3) == "{0}, {1}, and {2}"
      Throws:
      IllegalArgumentException - when count is 0 or negative.

    • getLocale

      @Deprecated public ULocale getLocale()
      Deprecated.
      This API is ICU internal only.
      Returns the locale of this object.

    • typeWidthToStyleString

      static String typeWidthToStyleString(ListFormatter.Type type, ListFormatter.Width width)