senselogic.sitevision.api.format

Interface FormatterBuilderFactory

@Requireable(value="FormatterBuilderFactory")
public interface FormatterBuilderFactory

Factory for creating formatter builders.

An instance of the Sitevision class implementing this interface can be obtained via Utils.getFormatterBuilderFactory(). See Utils for how to obtain an instance of the Utils interface.

Since:

Sitevision 6.1

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
NumericFormatterBuilder	getCurrencyFormatterBuilder(Locale aLocale) Returns a builder for creating currency formatters with a given Locale.
NumericFormatterBuilder	getCurrencyFormatterBuilder(Locale aLocale, Currency aCurrency) Returns a builder for creating currency formatters with a given Locale and Currency.
NumericFormatterBuilder	getNumberFormatterBuilder(Locale aLocale) Returns a builder for creating number formatters with a given Locale.
NumericFormatterBuilder	getPercentFormatterBuilder(Locale aLocale) Returns a builder for creating percent formatters with a given Locale.

Method Detail

getNumberFormatterBuilder

NumericFormatterBuilder getNumberFormatterBuilder(Locale aLocale)
                                           throws NullPointerException

Returns a builder for creating number formatters with a given Locale.

The builder returned by this method will create instances that are conceptually equivalent with java.text.NumberFormat.getNumberInstance(aLocale).

Parameters:

aLocale - the Locale

Returns:

a NumericFormatterBuilder that creates number formatters

Throws:

NullPointerException - if aLocale is null

getPercentFormatterBuilder

NumericFormatterBuilder getPercentFormatterBuilder(Locale aLocale)
                                            throws NullPointerException

Returns a builder for creating percent formatters with a given Locale.

The builder returned by this method will create instances that are conceptually equivalent with java.text.NumberFormat.getPercentInstance(aLocale).

Parameters:

aLocale - the Locale

Returns:

a NumericFormatterBuilder that creates percent formatters

Throws:

NullPointerException - if aLocale is null

getCurrencyFormatterBuilder

NumericFormatterBuilder getCurrencyFormatterBuilder(Locale aLocale)
                                             throws NullPointerException

Returns a builder for creating currency formatters with a given Locale.

Currency note! Currency typically depends on a country. A language-only Locale will typically be formatted without any specific currency. Use getCurrencyFormatterBuilder(Locale, Currency) to actively specify what currency to use when using such locale.

The builder returned by this method will create instances that are conceptually equivalent with java.text.NumberFormat.getCurrencyInstance(aLocale).

Parameters:

aLocale - the Locale

Returns:

a NumericFormatterBuilder that creates currency formatters

Throws:

NullPointerException - if aLocale is null

See Also:

getCurrencyFormatterBuilder(Locale, Currency)

getCurrencyFormatterBuilder

NumericFormatterBuilder getCurrencyFormatterBuilder(Locale aLocale,
                                                    Currency aCurrency)
                                             throws NullPointerException

Returns a builder for creating currency formatters with a given Locale and Currency.

Currency instances are created via methods in CurrencyFactory.

The builder returned by this method will create instances that are conceptually equivalent with java.text.NumberFormat.getCurrencyInstance(aLocale) with a java.util.Currency.getInstance(aCurrencyCode) set.

Parameters:

aLocale - the Locale

aCurrency - the currency

Returns:

a NumericFormatterBuilder that creates currency formatters

Throws:

NullPointerException - if aLocale or aCurrency is null

See Also:

CurrencyFactory