com.trivago.triava.util

Class UnitFormatter

java.lang.Object

com.trivago.triava.util.UnitFormatter

public class UnitFormatter
extends Object

UnitTools contain methods to format a numerical value using units from a UnitSystem. For example 13504653 can be formatted as 13,5 MB", "12.9 MiB", "13MB 504KB 653B" "or "14MW". The highest unit prefix is giga (e.g. "G" or "Gi", the lowest prefix is the one from the base (typically empty)

Author:

cesken

Constructor Summary

Constructors

Constructor and Description
UnitFormatter()

Method Summary

Modifier and Type	Method and Description
static String	formatAsUnit(long value, UnitSystem unitSystem, String unitPostfix) Formats a value to human readable representation, using the given Unit System.
static String	formatAsUnit(long value, UnitSystem unitSystem, String unitPostfix, DecimalFormat format) Formats a value to human readable representation, using the given Unit System.
static String	formatAsUnits(long number, UnitSystem unitSystem, String unitPostfix, String separator) Formats the value to human readable representation, using the given Unit System.

Methods inherited from class java.lang.Object

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

Constructor Detail

UnitFormatter

public UnitFormatter()

Method Detail

formatAsUnit

public static String formatAsUnit(long value,
                                  UnitSystem unitSystem,
                                  String unitPostfix)

Formats a value to human readable representation, using the given Unit System. with a maximum of two fraction digits, e.g. 13504653 is converted to "13.5M". If you need more control on the format, call formatAsUnit(long, UnitSystem, String, DecimalFormat).

Parameters:

value - The number to format

unitSystem - The Unit system

unitPostfix - The postfix, for example "B" for byte or "W" for Watt. May be empty.

Returns:

The formatted value

formatAsUnit

public static String formatAsUnit(long value,
                                  UnitSystem unitSystem,
                                  String unitPostfix,
                                  DecimalFormat format)

Formats a value to human readable representation, using the given Unit System. For example 13500653 is converted to "13.501MB".

Parameters:

value - The number to format

unitSystem - The Unit system

unitPostfix - The postfix, for example "B" for byte or "W" for Watt. May be empty.

format - The decimal format for formatting the number

Returns:

The formatted value

formatAsUnits

public static String formatAsUnits(long number,
                                   UnitSystem unitSystem,
                                   String unitPostfix,
                                   String separator)

Formats the value to human readable representation, using the given Unit System. Zero values are omitted, e.g. 13000653 is converted to "13MB 653B".

Parameters:

number - The number to format

unitSystem - The Unit system

unitPostfix - The postfix, for example "B" for byte or "W" for Watt. May be empty.

separator - The separator between the elements

Returns:

The formatted value