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:

Draft ICU 50.

Constructor Summary

Constructors

Constructor and Description
ListFormatter(String two, String start, String middle, String end) Internal: Create a ListFormatter from component strings, with definitions as in LDML.

Method Summary

Methods

Modifier and Type	Method and Description
String	format(Collection<Object> items) Format a collection of objects.
String	format(Object... items) Format a list of objects.
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(ULocale locale) Create a list formatter that is appropriate for a locale.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListFormatter

public ListFormatter(String two,
             String start,
             String middle,
             String end)

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)

Create a list formatter that is appropriate for a locale.

Parameters:

locale - the locale in question.

Returns:

ListFormatter

Status:

Draft 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:

Draft ICU 50.

getInstance

public static ListFormatter getInstance()

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

Returns:

ListFormatter

Status:

Draft 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:

Draft ICU 50.

format

public String format(Collection<Object> 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:

Draft ICU 50.