org.graalvm.shadowed.com.ibm.icu.text

Class ListFormatter

java.lang.Object

org.graalvm.shadowed.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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListFormatter.Field Field selectors for format fields defined by ListFormatter.
static class	ListFormatter.FormattedList An immutable class containing the result of a list formatting operation.
static class	ListFormatter.SpanField Class for span fields in FormattedList.
static class	ListFormatter.Type Type of meaning expressed by the list.
static class	ListFormatter.Width Verbosity level of the list patterns.

Method Summary

Modifier and Type	Method and Description
String	format(Collection<?> items) Format a collection of objects.
String	format(Object... items) Format a list of objects.
ListFormatter.FormattedList	formatToValue(Collection<?> items) Format a collection of objects to a FormattedList.
ListFormatter.FormattedList	formatToValue(Object... items) Format a list of objects to a FormattedList.
static ListFormatter	getInstance() Create a list formatter that is appropriate for the default FORMAT 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.
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.
String	getPatternForNumItems(int count) Returns the pattern to use for a particular item count.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

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

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.