ilog.views.util.text

Class IlvSimpleListFormat

java.lang.Object

ilog.views.util.text.IlvListFormat

ilog.views.util.text.IlvSimpleListFormat

public class IlvSimpleListFormat
extends IlvListFormat

This class formats a list of items, producing a single string. It does so by using a separator string between items. Optionally, a terminator string may be given as well.

Note: This class may be obsoleted once the corresponding support is added to the International Components for Unicode library.

Since:

JViews 8.7

Field Summary

Fields inherited from class ilog.views.util.text.IlvListFormat

LONG, SHORT

Constructor Summary

Constructors

Constructor and Description
IlvSimpleListFormat(Locale locale) Creates a list formatter, based on a separator string suitable for the given locale.
IlvSimpleListFormat(String separator) Creates a list formatter, based on the given separator string.
IlvSimpleListFormat(String separator, String terminator, String zeroElementsString) Creates a list formatter, based on the given separator and terminator strings.

Method Summary

Modifier and Type	Method and Description
String	format(String[] elements) Returns the string that expresses the given elements, in order.
String	getSeparator() Returns the string that separates two elements.
String	getTerminator() Returns the string that terminates the list.
String	getZeroElementsString() Returns the string that represents a list of zero elements.

Methods inherited from class ilog.views.util.text.IlvListFormat

getInstance, getInstance, getInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvSimpleListFormat

public IlvSimpleListFormat(Locale locale)

Creates a list formatter, based on a separator string suitable for the given locale.

IlvSimpleListFormat

public IlvSimpleListFormat(String separator)

Creates a list formatter, based on the given separator string.

Parameters:

separator - The string to be used to separate two elements.

IlvSimpleListFormat

public IlvSimpleListFormat(String separator,
                           String terminator,
                           String zeroElementsString)

Creates a list formatter, based on the given separator and terminator strings.

Parameters:

separator - The string to be used to separate two elements.

terminator - The string that terminates the list.

zeroElementsString - The string that represents a list of zero elements.

Method Detail

getSeparator

public String getSeparator()

Returns the string that separates two elements.

getTerminator

public String getTerminator()

Returns the string that terminates the list.

getZeroElementsString

public String getZeroElementsString()

Returns the string that represents a list of zero elements.

format

public 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".

Specified by:

format in class IlvListFormat

Parameters:

elements - An array of strings.

Returns:

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