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.

Author:

Mark Davis

Status:

Stable ICU 50.

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.

Constructor Summary

Constructors

Constructor and Description
ListFormatter(String two, String start, String middle, String end) Deprecated. This API is ICU internal only.

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.
ULocale	getLocale() Deprecated. This API is ICU internal only.
String	getPatternForNumItems(int count) Returns the pattern to use for a particular item count.

Methods inherited from class java.lang.Object

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

Constructor Detail

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.

Status:

Internal. This API is ICU internal only.

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

Status:

Stable ICU 67.

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

Status:

Stable ICU 67.

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

Status:

Stable ICU 50.

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

Status:

Stable ICU 50.

getInstance

public static ListFormatter getInstance()

Create a list formatter that is appropriate for the default FORMAT locale.

Returns:

ListFormatter

Status:

Stable ICU 50.

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

Status:

Stable ICU 50.

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

Status:

Stable ICU 50.

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

Status:

Stable ICU 67.

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

Status:

Stable ICU 67.

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.

Status:

Stable ICU 52.

getLocale

@Deprecated
public ULocale getLocale()

Deprecated. This API is ICU internal only.

Returns the locale of this object.

Status:

Internal. This API is ICU internal only.