icu::ListFormatter Class Reference

An immutable class for formatting a list, using data from CLDR (or supplied separately). More...

#include <listformatter.h>

Inheritance diagram for icu::ListFormatter:
icu::UObject icu::UMemory

Public Member Functions

virtual ~ListFormatter ()
 Destructor.
UnicodeStringformat (const UnicodeString items[], int32_t n_items, UnicodeString &appendTo, UErrorCode &errorCode) const
 Formats a list of strings.
 ListFormatter (const ListFormatData &listFormatterData)

Static Public Member Functions

static ListFormattercreateInstance (UErrorCode &errorCode)
 Creates a ListFormatter appropriate for the default locale.
static ListFormattercreateInstance (const Locale &locale, UErrorCode &errorCode)
 Creates a ListFormatter appropriate for a locale.
static void getFallbackLocale (const Locale &in, Locale &out, UErrorCode &errorCode)
 Gets the fallback locale for a given locale.

Detailed Description

An immutable class for formatting a list, using data from CLDR (or supplied separately).

Example: Input data ["Alice", "Bob", "Charlie", "Delta"] will be formatted as "Alice, Bob, Charlie and Delta" in English.

The ListFormatter class is not intended for public subclassing.

Definition at line 56 of file listformatter.h.


Constructor & Destructor Documentation

virtual icu::ListFormatter::~ListFormatter (  )  [virtual]

Destructor.

Draft:
This API may be changed in the future versions and was introduced in ICU 50
icu::ListFormatter::ListFormatter ( const ListFormatData listFormatterData  ) 
Internal:
Do not use. This API is for internal use only. constructor made public for testing.

Member Function Documentation

static ListFormatter* icu::ListFormatter::createInstance ( const Locale locale,
UErrorCode errorCode 
) [static]

Creates a ListFormatter appropriate for a locale.

Parameters:
locale The locale.
errorCode ICU error code, set if no data available for the given locale.
Returns:
A ListFormatter object created from internal data derived from CLDR data.
Draft:
This API may be changed in the future versions and was introduced in ICU 50
static ListFormatter* icu::ListFormatter::createInstance ( UErrorCode errorCode  )  [static]

Creates a ListFormatter appropriate for the default locale.

Parameters:
errorCode ICU error code, set if no data available for default locale.
Returns:
Pointer to a ListFormatter object for the default locale, created from internal data derived from CLDR data.
Draft:
This API may be changed in the future versions and was introduced in ICU 50
UnicodeString& icu::ListFormatter::format ( const UnicodeString  items[],
int32_t  n_items,
UnicodeString appendTo,
UErrorCode errorCode 
) const

Formats a list of strings.

Parameters:
items An array of strings to be combined and formatted.
n_items Length of the array items.
appendTo The string to which the result should be appended to.
errorCode ICU error code, set if there is an error.
Returns:
Formatted string combining the elements of items, appended to appendTo.
Draft:
This API may be changed in the future versions and was introduced in ICU 50
static void icu::ListFormatter::getFallbackLocale ( const Locale in,
Locale out,
UErrorCode errorCode 
) [static]

Gets the fallback locale for a given locale.

TODO: Consider moving this to the Locale class.

Parameters:
in The input locale.
out The output locale after fallback.
Internal:
Do not use. This API is for internal use only. For testing.

The documentation for this class was generated from the following file:

Generated on 5 Feb 2019 for ICU 50.1.2 by  doxygen 1.6.1