Package com.ibm.icu.text
Class ListFormatter
java.lang.Object
com.ibm.icu.text.ListFormatter
Immutable class for formatting a list, using data from CLDR (or supplied
separately). The class is not subclassable.
- Author:
- Mark Davis
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
Field selectors for format fields defined by ListFormatter.static final class
An immutable class containing the result of a list formatting operation.static final class
Class for span fields in FormattedList.static enum
Type of meaning expressed by the list.static enum
Verbosity level of the list patterns. -
Constructor Summary
ConstructorsConstructorDescriptionListFormatter
(String two, String start, String middle, String end) Deprecated.This API is ICU internal only. -
Method Summary
Modifier and TypeMethodDescriptionFormat a list of objects.format
(Collection<?> items) Format a collection of objects.formatToValue
(Object... items) Format a list of objects to a FormattedList.formatToValue
(Collection<?> items) Format a collection of objects to a FormattedList.static ListFormatter
Create a list formatter that is appropriate for the default FORMAT locale.static ListFormatter
getInstance
(ULocale locale) Create a list formatter that is appropriate for a locale.static ListFormatter
getInstance
(ULocale locale, ListFormatter.Type type, ListFormatter.Width width) Create a list formatter that is appropriate for a locale.static ListFormatter
getInstance
(Locale locale) Create a list formatter that is appropriate for a locale.static ListFormatter
getInstance
(Locale locale, ListFormatter.Type type, ListFormatter.Width width) Create a list formatter that is appropriate for a locale.Deprecated.This API is ICU internal only.getPatternForNumItems
(int count) Returns the pattern to use for a particular item count.
-
Constructor Details
-
ListFormatter
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.
-
-
Method Details
-
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
Create a list formatter that is appropriate for a locale.- Parameters:
locale
- the locale in question.- Returns:
- ListFormatter
-
getInstance
Create a list formatter that is appropriate for a locale.- Parameters:
locale
- the locale in question.- Returns:
- ListFormatter
-
getInstance
Create a list formatter that is appropriate for the default FORMAT locale.- Returns:
- ListFormatter
-
format
Format a list of objects.- Parameters:
items
- items to format. The toString() method is called on each.- Returns:
- items formatted into a string
-
format
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
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
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
-
getPatternForNumItems
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.This API is ICU internal only.Returns the locale of this object.
-