Enum Class DataSize

java.lang.Object

java.lang.Enum<DataSize>

org.tquadrat.foundation.value.DataSize

All Implemented Interfaces:

Serializable, Comparable<DataSize>, Constable, Dimension, DimensionWithLinearConversion

@ClassVersion(sourceVersion="$Id: DataSize.java 1195 2026-04-15 21:33:40Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
public enum DataSize
extends Enum<DataSize>
implements DimensionWithLinearConversion

The various instances of data sizes (for files or free disk space or capacities of memory sticks …).

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: DataSize.java 1195 2026-04-15 21:33:40Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.value.DataSize"

⁠

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BYTE	A single byte.
GIBIBYTE	A gigabyte in the binary form.
GIGABYTE	A gigabyte (the decimal form).
KIBIBYTE	A Kilobyte with 1024 bytes.
KILOBYTE	A Kilobyte (with 1000 bytes).
MEBIBYTE	A megabyte in the binary form.
MEGABYTE	A megabyte (the decimal form).
TEBIBYTE	A terabyte in the binary form.
TERABYTE	A terabyte (the decimal form).

Field Summary

Fields

Modifier and Type	Field	Description
private final BigDecimal	m_Factor	The factor.
private final int	m_Precision	The default precision.
private final String	m_UnitSymbol	The unit string.

Fields inherited from interface DimensionWithLinearConversion

MSG_UnknownUnit

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DataSize(BigDecimal factor, String unitSymbol)	Creates a new DataSize instance, with a default precision of zero mantissa digits.
private	DataSize(BigDecimal factor, String unitSymbol, int precision)	Creates a new DataSize instance.

Method Summary

Modifier and Type	Method	Description
final DataSize	baseUnit()
final BigDecimal	factor()
static final DataSize	forUnit(String unit)	Returns the DataSize instance for the given unit.
final int	getPrecision()
final String	unitSymbol()
static DataSize	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DataSize[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Dimension

equals, name, toString, unitSymbolForPrinting

Methods inherited from interface DimensionWithLinearConversion

fromBase, toBase

Enum Constant Details

BYTE

public static final DataSize BYTE

A single byte.

KILOBYTE

public static final DataSize KILOBYTE

A Kilobyte (with 1000 bytes).

KIBIBYTE

public static final DataSize KIBIBYTE

A Kilobyte with 1024 bytes.

MEGABYTE

public static final DataSize MEGABYTE

A megabyte (the decimal form).

MEBIBYTE

public static final DataSize MEBIBYTE

A megabyte in the binary form.

GIGABYTE

public static final DataSize GIGABYTE

A gigabyte (the decimal form).

GIBIBYTE

public static final DataSize GIBIBYTE

A gigabyte in the binary form.

TERABYTE

public static final DataSize TERABYTE

A terabyte (the decimal form).

TEBIBYTE

public static final DataSize TEBIBYTE

A terabyte in the binary form.

Field Details

m_Factor

private final BigDecimal m_Factor

The factor.

m_Precision

private final int m_Precision

The default precision.

m_UnitSymbol

private final String m_UnitSymbol

The unit string.

Constructor Details

DataSize

private DataSize(BigDecimal factor,
 String unitSymbol,
 int precision)

Creates a new DataSize instance.

Parameters:

factor - The factor.

unitSymbol - The unit string.

precision - The default precision.

DataSize

private DataSize(BigDecimal factor,
 String unitSymbol)

Creates a new DataSize instance, with a default precision of zero mantissa digits.

Parameters:

factor - The factor.

unitSymbol - The unit string.

Method Details

values

public static DataSize[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static DataSize valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

baseUnit

public final DataSize baseUnit()

Specified by:

baseUnit in interface Dimension

factor

public final BigDecimal factor()

Specified by:

factor in interface DimensionWithLinearConversion

forUnit

public static final DataSize forUnit(String unit)
                              throws IllegalArgumentException

Returns the DataSize instance for the given unit.

Parameters:

unit - The unit.

Returns:

The respective instance.

Throws:

IllegalArgumentException - The given unit is unknown.

getPrecision

public final int getPrecision()

Specified by:

getPrecision in interface Dimension

unitSymbol

public final String unitSymbol()

Specified by:

unitSymbol in interface Dimension