org.pentaho.reporting.libraries.formatting

Class FastChoiceFormat

java.lang.Object

org.pentaho.reporting.libraries.formatting.FastChoiceFormat

All Implemented Interfaces:

Serializable, Cloneable, FastFormat

public class FastChoiceFormat
extends Object
implements FastFormat

A wrapper around the java.text.ChoiceFormat class. This wrapper limits the possible interactions with the wrapped format class and therefore eliminates the need to clone the choice format whenever the wrapper is cloned.

Author:

Thomas Morgner

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FastChoiceFormat(String pattern) Creates a new ChoiceFormat with the given pattern and the default locale.
FastChoiceFormat(String pattern, Locale locale) Creates a new ChoiceFormat with the given pattern and locale.

Method Summary

Methods

Modifier and Type	Method and Description
FastChoiceFormat	clone() Clones the object.
String	format(Object parameters) Formats the given object using the choice-pattern.
Locale	getLocale() Returns the current locale of the formatter.
String	getPattern() Returns the currently active pattern.

Methods inherited from class java.lang.Object

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

Constructor Detail

FastChoiceFormat

public FastChoiceFormat(String pattern)

Creates a new ChoiceFormat with the given pattern and the default locale.

Parameters:

pattern - the pattern.

FastChoiceFormat

public FastChoiceFormat(String pattern,
                Locale locale)

Creates a new ChoiceFormat with the given pattern and locale. As the local is not used anywhere, this has no impact on the format itself.

Parameters:

pattern - the pattern.

locale - the locale.

Method Detail

getLocale

public Locale getLocale()

Returns the current locale of the formatter.

Specified by:

getLocale in interface FastFormat

Returns:

the current locale, never null.

getPattern

public String getPattern()

Returns the currently active pattern.

Returns:

the locale.

format

public String format(Object parameters)

Formats the given object using the choice-pattern.

Specified by:

format in interface FastFormat

Parameters:

parameters - the parameters, usually a Number- or Date object.

Returns:

the formatted text.

clone

public FastChoiceFormat clone()

Clones the object.

Specified by:

clone in interface FastFormat

Overrides:

clone in class Object

Returns:

the clone.

Throws:

CloneNotSupportedException - if cloning failed for some reason.