public class DataUnitFormatter extends Object implements Serializable
Formats a data unit to a human-readable string.
As of 2.0.0, a distinction is made between decimal (default) and binary units. Also, units are now supported up to yotta (10008) or yobi (10248).
Constructor and Description |
---|
DataUnitFormatter()
Creates a new DataUnit formatter using decimal notation,
with default system locale, and without decimals.
|
DataUnitFormatter(DataUnitFormatter formatter)
Copy constructor.
|
DataUnitFormatter(int decimalPrecision)
Deprecated.
Since 2.0.0 use setter methods.
|
DataUnitFormatter(Locale locale)
Deprecated.
Since 2.0.0 use setter methods.
|
DataUnitFormatter(Locale locale,
int decimalPrecision)
Deprecated.
Since 2.0.0 use setter methods.
|
DataUnitFormatter(Locale locale,
int decimalPrecision,
boolean fixedUnit)
Deprecated.
Since 2.0.0 use setter methods.
|
public DataUnitFormatter()
public DataUnitFormatter(DataUnitFormatter formatter)
null
formatter is the same
as invoking DataUnitFormatter()
without argumentsformatter
- formatter to copy@Deprecated public DataUnitFormatter(Locale locale)
locale
- a locale@Deprecated public DataUnitFormatter(int decimalPrecision)
decimalPrecision
- number of decimals@Deprecated public DataUnitFormatter(Locale locale, int decimalPrecision)
locale
- a localedecimalPrecision
- number of decimals@Deprecated public DataUnitFormatter(Locale locale, int decimalPrecision, boolean fixedUnit)
fixedUnit
to true
to ensure
the data units supplied are not change in the formatting.locale
- a localedecimalPrecision
- number of decimalsfixedUnit
- true
to keep original unit in formattingpublic Locale getLocale()
public DataUnitFormatter setLocale(Locale locale)
public DataUnitFormatter withLocale(Locale locale)
public int getDecimalPrecision()
public DataUnitFormatter setDecimalPrecision(int decimalPrecision)
public DataUnitFormatter withDecimalPrecision(int decimalPrecision)
public boolean isFixedUnit()
public DataUnitFormatter setFixedUnit(boolean fixedUnit)
public DataUnitFormatter withFixedUnit(boolean fixedUnit)
public boolean isBinaryNotation()
public DataUnitFormatter setBinaryNotation(boolean binaryNotation)
public DataUnitFormatter withBinaryNotation(boolean binaryNotation)
public RoundingMode getRoundingMode()
public DataUnitFormatter setRoundingMode(RoundingMode roundingMode)
public DataUnitFormatter withRoundingMode(RoundingMode roundingMode)
public String format(double amount, DataUnit unit)
amount
- the amount to formatunit
- the data unit type of the amountpublic String format(BigDecimal amount, DataUnit unit)
amount
- the amount to formatunit
- the data unit type of the amountCopyright © 2008–2023 Norconex Inc.. All rights reserved.