com.github.jferard.fastods.datastyle

Class CurrencyStyleBuilder

java.lang.Object

com.github.jferard.fastods.datastyle.CurrencyStyleBuilder

All Implemented Interfaces:

DataStyleBuilder<CurrencyStyle,CurrencyStyleBuilder>, DecimalStyleBuilder<CurrencyStyleBuilder>, IsVolatileBuilder<CurrencyStyleBuilder>, LocalizedBuilder<CurrencyStyleBuilder>, NumberStyleBuilder<CurrencyStyle,CurrencyStyleBuilder>, ShowableBuilder<CurrencyStyleBuilder>, StyleBuilder<CurrencyStyle>

public class CurrencyStyleBuilder
extends Object
implements DataStyleBuilder<CurrencyStyle,CurrencyStyleBuilder>, NumberStyleBuilder<CurrencyStyle,CurrencyStyleBuilder>, DecimalStyleBuilder<CurrencyStyleBuilder>

Author:

Julien Férard

Constructor Summary

Constructors

Constructor and Description
CurrencyStyleBuilder(String name, Locale locale) The builder

Method Summary

Modifier and Type	Method and Description
CurrencyStyle	build()
CurrencyStyleBuilder	country(String countryCode) Set the country code
CurrencyStyleBuilder	currencySymbol(String currencySymbol) Change the currency symbol, e.g. '$'.
CurrencyStyleBuilder	currencySymbolPosition(CurrencyStyle.SymbolPosition symbolPosition) Set the position of the currency symbol
CurrencyStyleBuilder	decimalPlaces(int decimalPlaces) 20.250 style:decimal-places Set how many digits are to the right of the decimal symbol.
CurrencyStyleBuilder	groupThousands(boolean grouping)
CurrencyStyleBuilder	language(String languageCode) Set the language code
CurrencyStyleBuilder	locale(Locale locale) Set the locale
CurrencyStyleBuilder	minIntegerDigits(int minIntegerDigits)
CurrencyStyleBuilder	negativeValueColor(Color negativeValueColor)
CurrencyStyleBuilder	negativeValueRed() Sets the red color for negative values
CurrencyStyleBuilder	visible() Make this style visible, ie part of common styles
CurrencyStyleBuilder	volatileStyle(boolean volatileStyle) 19.517 style:volatile "The style:volatile attribute specifies whether unused style in a document are retained or discarded by consumers."

Methods inherited from class java.lang.Object

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

Constructor Detail

CurrencyStyleBuilder

public CurrencyStyleBuilder(String name,
                            Locale locale)

The builder

Parameters:

name - The name of this style

locale - The locale used

Method Detail

build

public CurrencyStyle build()

Specified by:

build in interface StyleBuilder<CurrencyStyle>

Returns:

a new S

currencySymbol

public CurrencyStyleBuilder currencySymbol(String currencySymbol)

Change the currency symbol, e.g. '$'.

Parameters:

currencySymbol - 16.27.8 number:currency-symbol

Returns:

this for fluent style

currencySymbolPosition

public CurrencyStyleBuilder currencySymbolPosition(CurrencyStyle.SymbolPosition symbolPosition)

Set the position of the currency symbol

Parameters:

symbolPosition - the position of the symbol (before or after the value).

Returns:

this for fluent style

decimalPlaces

public CurrencyStyleBuilder decimalPlaces(int decimalPlaces)

Description copied from interface: DecimalStyleBuilder

20.250 style:decimal-places Set how many digits are to the right of the decimal symbol.

Specified by:

decimalPlaces in interface DecimalStyleBuilder<CurrencyStyleBuilder>

Parameters:

decimalPlaces - "the maximum number of decimal places that are displayed if numbers are formatted by a data style that has no setting for number of decimal places itself"

Returns:

this for fluent style

groupThousands

public CurrencyStyleBuilder groupThousands(boolean grouping)

Specified by:

groupThousands in interface NumberStyleBuilder<CurrencyStyle,CurrencyStyleBuilder>

Parameters:

grouping - if true, the thousands separator is shown.

Returns:

this for fluent style

locale

public final CurrencyStyleBuilder locale(Locale locale)

Description copied from interface: LocalizedBuilder

Set the locale

Specified by:

locale in interface LocalizedBuilder<CurrencyStyleBuilder>

Parameters:

locale - the locale

Returns:

this for fluent style

minIntegerDigits

public CurrencyStyleBuilder minIntegerDigits(int minIntegerDigits)

Specified by:

minIntegerDigits in interface NumberStyleBuilder<CurrencyStyle,CurrencyStyleBuilder>

Parameters:

minIntegerDigits - The number of digits for integer part

Returns:

this for fluent style

negativeValueColor

public CurrencyStyleBuilder negativeValueColor(Color negativeValueColor)

Specified by:

negativeValueColor in interface NumberStyleBuilder<CurrencyStyle,CurrencyStyleBuilder>

Parameters:

negativeValueColor - the color for negative values, null if none

Returns:

this for fluent style

negativeValueRed

public CurrencyStyleBuilder negativeValueRed()

Description copied from interface: NumberStyleBuilder

Sets the red color for negative values

Specified by:

negativeValueRed in interface NumberStyleBuilder<CurrencyStyle,CurrencyStyleBuilder>

Returns:

this for fluent style

country

public CurrencyStyleBuilder country(String countryCode)

Description copied from interface: LocalizedBuilder

Set the country code

Specified by:

country in interface LocalizedBuilder<CurrencyStyleBuilder>

Parameters:

countryCode - The two letter country code, e.g. 'US'

Returns:

this for fluent style

language

public CurrencyStyleBuilder language(String languageCode)

Description copied from interface: LocalizedBuilder

Set the language code

Specified by:

language in interface LocalizedBuilder<CurrencyStyleBuilder>

Parameters:

languageCode - The two letter language code, e.g. 'en'. See http://www.ietf .org/rfc/rfc3066.txt

Returns:

this for fluent style

volatileStyle

public CurrencyStyleBuilder volatileStyle(boolean volatileStyle)

Description copied from interface: IsVolatileBuilder

19.517 style:volatile "The style:volatile attribute specifies whether unused style in a document are retained or discarded by consumers."

Specified by:

volatileStyle in interface IsVolatileBuilder<CurrencyStyleBuilder>

Parameters:

volatileStyle - true if "consumers should keep unused styles", false otherwise.

Returns:

this for fluent style

visible

public CurrencyStyleBuilder visible()

Description copied from interface: ShowableBuilder

Make this style visible, ie part of common styles

Specified by:

visible in interface ShowableBuilder<CurrencyStyleBuilder>

Returns:

this for fluent style