org.omnifaces.el.functions

Class Numbers

java.lang.Object

org.omnifaces.el.functions.Numbers

public final class Numbers
extends Object

Collection of EL functions for number formatting: of:formatBytes(), of:formatCurrency(), of:formatNumber(), of:formatNumberDefault() and of:formatPercent().

Since:

1.2

Author:

Bauke Scholtz

Method Summary

Modifier and Type	Method and Description
static String	formatBytes(Long bytes) Format the given bytes to nearest 10n with IEC binary unit (KiB, MiB, etc) with rounding precision of 1 fraction.
static String	formatCurrency(Number number, String currencySymbol) Format the given number as currency with the given symbol.
static String	formatNumber(Number number, String pattern) Format the given number in the given pattern.
static String	formatNumberDefault(Number number) Format the given number in the locale-default pattern.
static String	formatPercent(Number number) Format the given number as percentage.

Methods inherited from class java.lang.Object

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

Method Detail

formatBytes

public static String formatBytes(Long bytes)

Format the given bytes to nearest 10ⁿ with IEC binary unit (KiB, MiB, etc) with rounding precision of 1 fraction. For example:

• 1023 bytes will appear as 1023 B
• 1024 bytes will appear as 1.0 KiB
• 500000 bytes will appear as 488.3 KiB
• 1048576 bytes will appear as 1.0 MiB

The format locale will be set to the one as obtained by Faces.getLocale().

Parameters:

bytes - The bytes to be formatted.

Returns:

The formatted bytes.

formatCurrency

public static String formatCurrency(Number number,
                                    String currencySymbol)

Format the given number as currency with the given symbol. This is useful when you want to format numbers as currency in for example the title attribute of an UI component, or the itemLabel attribute of select item, or wherever you can't use the <f:convertNumber> tag. The format locale will be set to the one as obtained by Faces.getLocale().

Parameters:

number - The number to be formatted as currency.

currencySymbol - The currency symbol to be used.

Returns:

The number which is formatted as currency with the given symbol.

Throws:

NullPointerException - When the currency symbol is null.

formatNumber

public static String formatNumber(Number number,
                                  String pattern)

Format the given number in the given pattern. This is useful when you want to format numbers in for example the title attribute of an UI component, or the itemLabel attribute of select item, or wherever you can't use the <f:convertNumber> tag. The format locale will be set to the one as obtained by Faces.getLocale().

Parameters:

number - The number to be formatted in the given pattern.

pattern - The pattern to format the given number in.

Returns:

The number which is formatted in the given pattern.

Throws:

NullPointerException - When the pattern is null.

formatNumberDefault

public static String formatNumberDefault(Number number)

Format the given number in the locale-default pattern. This is useful when you want to format numbers in for example the title attribute of an UI component, or the itemLabel attribute of select item, or wherever you can't use the <f:convertNumber> tag. The format locale will be set to the one as obtained by Faces.getLocale().

Parameters:

number - The number to be formatted in the locale-default pattern.

Returns:

The number which is formatted in the locale-default pattern.

Since:

1.3

formatPercent

public static String formatPercent(Number number)

Format the given number as percentage. This is useful when you want to format numbers as percentage in for example the title attribute of an UI component, or the itemLabel attribute of select item, or wherever you can't use the <f:convertNumber> tag. The format locale will be set to the one as obtained by Faces.getLocale().

Parameters:

number - The number to be formatted as percentage.

Returns:

The number which is formatted as percentage.

Since:

1.6