ilog.views.util.text

Class IlvListFormat

java.lang.Object

ilog.views.util.text.IlvListFormat

Direct Known Subclasses:

IlvPatternBasedListFormat, IlvSimpleListFormat

public abstract class IlvListFormat
extends Object

This class is the abstract base class for classes that format a list of items, producing a single string.

Since:

JViews 8.7

See Also:

IlvSimpleListFormat

Field Summary

Fields

Modifier and Type	Field and Description
static int	LONG Identifies the list formatting style that results in a full part of a sentence.
static int	SHORT Identifies the list formatting style that contains the minimum possible amount of verbose text.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IlvListFormat() Creates the list format.

Method Summary

Modifier and Type	Method and Description
abstract String	format(String[] elements) Returns the string that expresses the given elements, in order.
static IlvListFormat	getInstance() Returns the default list formatter, of default style, for the default locale.
static IlvListFormat	getInstance(int style) Returns the default list formatter for the default locale, using the given style.
static IlvListFormat	getInstance(int style, Locale inLocale) Returns the default list formatter for the given locale, using the given style.

Methods inherited from class java.lang.Object

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

Field Detail

SHORT

public static final int SHORT

Identifies the list formatting style that contains the minimum possible amount of verbose text.

See Also:

getInstance(int), getInstance(int, Locale), Constant Field Values

LONG

public static final int LONG

Identifies the list formatting style that results in a full part of a sentence.

See Also:

getInstance(int), getInstance(int, Locale), Constant Field Values

Constructor Detail

IlvListFormat

protected IlvListFormat()

Creates the list format.

Method Detail

format

public abstract String format(String[] elements)

Returns the string that expresses the given elements, in order. For example, in an English locale, when the elements "a", "b", "c" are given, this may return the string "a, b, and c".

Parameters:

elements - An array of strings.

Returns:

A single string containing the elements as substrings in the given order.

getInstance

public static IlvListFormat getInstance()

Returns the default list formatter, of default style, for the default locale.

Returns:

A list formatter, freshly created or taken from a cache.

See Also:

Locale.getDefault()

getInstance

public static IlvListFormat getInstance(int style)

Returns the default list formatter for the default locale, using the given style.

Parameters:

style - One of SHORT, LONG.

Returns:

A list formatter, freshly created or taken from a cache.

See Also:

Locale.getDefault()

getInstance

public static IlvListFormat getInstance(int style,
                                        Locale inLocale)

Returns the default list formatter for the given locale, using the given style.

Parameters:

style - One of SHORT, LONG.

inLocale - The locale for which to return the default list formatter.

Returns:

A list formatter, freshly created or taken from a cache.