Module io.github.tonywasher.joceanus.oceanus

Package io.github.tonywasher.joceanus.oceanus.decimal

Class OceanusDecimalFormatter

java.lang.Object

io.github.tonywasher.joceanus.oceanus.decimal.OceanusDecimalFormatter

public class OceanusDecimalFormatter
extends Object

Presentation methods for decimals in a particular locale.

Author:

Tony Washer

Field Summary

Fields

Modifier and Type	Field	Description
static final char	CHAR_BLANK	The Blank character.
static final char	CHAR_GROUP	The Group character.
static final char	CHAR_MINUS	The Minus character.
static final char	CHAR_ZERO	The Zero character.
protected static final int	INITIAL_BUFLEN	The Buffer length for building decimal strings.
(package private) static final OceanusDecimalLocale	LOCALE_DEFAULT	The locale.
protected static final String	STR_CURRSEP	The Currency separator.
static final String	STR_DEC	The Decimal character.

Constructor Summary

Constructors

Constructor	Description
OceanusDecimalFormatter()	Constructor.
OceanusDecimalFormatter(Locale pLocale)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	clearAccounting()	Clear accounting mode.
String	formatDecimal(OceanusDecimal pDecimal)	Format Decimal value.
String	formatInteger(Integer pValue)	Format Integer value.
String	formatLong(Long pValue)	Format Long value.
String	formatMoney(OceanusMoney pMoney)	Format Money value.
String	formatPrice(OceanusPrice pPrice)	Format Price value.
String	formatRate(OceanusRate pRate)	Format Rate value.
String	formatRatePerMille(OceanusRate pRate)	Format Rate value.
String	formatRatio(OceanusRatio pRatio)	Format Ratio value.
String	formatShort(Short pValue)	Format Short value.
String	formatUnits(OceanusUnits pUnits)	Format Units value.
void	setAccountingWidth(int pWidth)	Set accounting width.
final void	setLocale(Locale pLocale)	Set the locale.
String	toCurrencyString(OceanusMoney pValue)	Format a money value with currency code, into a locale independent format.
protected static String	toString(OceanusDecimal pValue)	Format a decimal value without reference to locale.

Methods inherited from class java.lang.Object

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

Field Details

INITIAL_BUFLEN

protected static final int INITIAL_BUFLEN

The Buffer length for building decimal strings.

See Also:

• Constant Field Values

CHAR_BLANK

public static final char CHAR_BLANK

The Blank character.

See Also:

• Constant Field Values

CHAR_ZERO

public static final char CHAR_ZERO

The Zero character.

See Also:

• Constant Field Values

CHAR_MINUS

public static final char CHAR_MINUS

The Minus character.

See Also:

• Constant Field Values

CHAR_GROUP

public static final char CHAR_GROUP

The Group character.

See Also:

• Constant Field Values

STR_DEC

public static final String STR_DEC

The Decimal character.

See Also:

• Constant Field Values

STR_CURRSEP

protected static final String STR_CURRSEP

The Currency separator.

See Also:

• Constant Field Values

LOCALE_DEFAULT

static final OceanusDecimalLocale LOCALE_DEFAULT

The locale.

Constructor Details

OceanusDecimalFormatter

public OceanusDecimalFormatter()

Constructor.

OceanusDecimalFormatter

public OceanusDecimalFormatter(Locale pLocale)

Constructor.

Parameters:

pLocale - the locale

Method Details

setLocale

public final void setLocale(Locale pLocale)

Set the locale.

Parameters:

pLocale - the locale

setAccountingWidth

public void setAccountingWidth(int pWidth)

Set accounting width.

Parameters:

pWidth - the accounting width to use

clearAccounting

public void clearAccounting()

Clear accounting mode.

toString

protected static String toString(OceanusDecimal pValue)

Format a decimal value without reference to locale.

Parameters:

pValue - the value to format

Returns:

the formatted value

toCurrencyString

public String toCurrencyString(OceanusMoney pValue)

Format a money value with currency code, into a locale independent format.

Parameters:

pValue - the value to format

Returns:

the formatted value

formatMoney

public String formatMoney(OceanusMoney pMoney)

Format Money value.

Parameters:

pMoney - the value to format

Returns:

the formatted value

formatPrice

public String formatPrice(OceanusPrice pPrice)

Format Price value.

Parameters:

pPrice - the value to format

Returns:

the formatted value

formatRate

public String formatRate(OceanusRate pRate)

Format Rate value.

Parameters:

pRate - the value to format

Returns:

the formatted value

formatRatePerMille

public String formatRatePerMille(OceanusRate pRate)

Format Rate value.

Parameters:

pRate - the value to format

Returns:

the formatted value

formatUnits

public String formatUnits(OceanusUnits pUnits)

Format Units value.

Parameters:

pUnits - the value to format

Returns:

the formatted value

formatRatio

public String formatRatio(OceanusRatio pRatio)

Format Ratio value.

Parameters:

pRatio - the value to format

Returns:

the formatted value

formatDecimal

public String formatDecimal(OceanusDecimal pDecimal)

Format Decimal value.

Parameters:

pDecimal - the value to format

Returns:

the formatted value

formatLong

public String formatLong(Long pValue)

Format Long value.

Parameters:

pValue - the value to format

Returns:

the formatted value

formatInteger

public String formatInteger(Integer pValue)

Format Integer value.

Parameters:

pValue - the value to format

Returns:

the formatted value

formatShort

public String formatShort(Short pValue)

Format Short value.

Parameters:

pValue - the value to format

Returns:

the formatted value