sirius.kernel.commons

Class NumberFormat

java.lang.Object

sirius.kernel.commons.NumberFormat

public class NumberFormat
extends Object

Used to define the parameters used to create a string representation of a number.

Provides a set of default formats and also describes the parameters used to format a number. This is used by Amount to create string representations.

Field Summary

Fields

Modifier and Type	Field and Description
static NumberFormat	MACHINE_NO_DECIMAL_PLACES Describes a format which rounds to integer numbers (no decimal places).
static NumberFormat	MACHINE_TWO_DECIMAL_PLACES Describes a format which rounds to two decimal places.
static NumberFormat	NO_DECIMAL_PLACES Describes a format which rounds to integer numbers (no decimal places).
static NumberFormat	PERCENT Describes the default format used to create string representations of percentages.
static NumberFormat	TWO_DECIMAL_PLACES Describes a format which rounds to two decimal places.

Constructor Summary

Constructors

Constructor and Description
NumberFormat(int scale, RoundingMode roundingMode, DecimalFormatSymbols formatSymbols, boolean useGrouping, String suffix) Creates a new number format used to format amounts.

Method Summary

Modifier and Type	Method and Description
DecimalFormatSymbols	getDecimalFormatSymbols() Returns the utilized format symbols when creating a string representation.
RoundingMode	getRoundingMode() Determines the rounding mode if more decimal places are available.
int	getScale() Returns the desired number of decimal places.
String	getSuffix() Returns the suffix appended to a formatted string, like a % sign.
boolean	isUseGrouping() Determines if grouping separaters (by thousands) should be placed or not.

Methods inherited from class java.lang.Object

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

Field Detail

PERCENT

public static final NumberFormat PERCENT

Describes the default format used to create string representations of percentages.

It therefore specifies two decimal places which are rounded RoundingMode.HALF_UP. It uses the decimal format symbols for the currently active language provided by NLS. As suffix the percent sign % is used.

See Also:

NLS.getDecimalFormatSymbols()

TWO_DECIMAL_PLACES

public static final NumberFormat TWO_DECIMAL_PLACES

Describes a format which rounds to two decimal places.

It specifies RoundingMode.HALF_UP as rounding mode and uses the decimal format symbols for the currently active language provided by NLS.

See Also:

NLS.getDecimalFormatSymbols()

MACHINE_TWO_DECIMAL_PLACES

public static final NumberFormat MACHINE_TWO_DECIMAL_PLACES

Describes a format which rounds to two decimal places.

It specifies RoundingMode.HALF_UP as rounding mode and uses the decimal format symbols for machine formats, provided by NLS.

See Also:

NLS.getMachineFormatSymbols()

NO_DECIMAL_PLACES

public static final NumberFormat NO_DECIMAL_PLACES

Describes a format which rounds to integer numbers (no decimal places).

It specifies RoundingMode.HALF_UP as rounding mode and uses the decimal format symbols for the currently active language provided by NLS.

See Also:

NLS.getDecimalFormatSymbols()

MACHINE_NO_DECIMAL_PLACES

public static final NumberFormat MACHINE_NO_DECIMAL_PLACES

Describes a format which rounds to integer numbers (no decimal places).

It specifies RoundingMode.HALF_UP as rounding mode and uses the decimal format symbols for machine formats, provided by NLS.

See Also:

NLS.getMachineFormatSymbols()

Constructor Detail

NumberFormat

public NumberFormat(int scale,
                    @Nonnull
                    RoundingMode roundingMode,
                    @Nullable
                    DecimalFormatSymbols formatSymbols,
                    boolean useGrouping,
                    @Nullable
                    String suffix)

Creates a new number format used to format amounts.

Parameters:

scale - contains the number of decimal places shown. Use Amount.toSmartRoundedString(NumberFormat) to remove unwanted zeros.

roundingMode - contains the rounding mode to use. Most commonly RoundingMode.HALF_UP will be correct.

formatSymbols - contains the DecimalFormatSymbols to use. This parameter can be null to use the format symbols of the current language, which is present, when this format is used.

useGrouping - determines if grouping (by thousands) is used.

suffix - the suffix to append to a formatted string

Method Detail

getSuffix

public String getSuffix()

Returns the suffix appended to a formatted string, like a % sign.

Returns:

the suffix used by this format

getScale

public int getScale()

Returns the desired number of decimal places.

Returns:

the number of decimal places used by this format

getRoundingMode

public RoundingMode getRoundingMode()

Determines the rounding mode if more decimal places are available.

Returns:

the rounding mode used by this format

getDecimalFormatSymbols

public DecimalFormatSymbols getDecimalFormatSymbols()

Returns the utilized format symbols when creating a string representation.

Returns:

the decimal format symbols used by this format

isUseGrouping

public boolean isUseGrouping()

Determines if grouping separaters (by thousands) should be placed or not.

Returns:

true if grouping separators are used, false otherwise