Package com.marcpg.libpg.data.storage

Class BitData

java.lang.Object

com.marcpg.libpg.data.storage.BitData

public class BitData
extends Object

ByteData is used to convert and store data.
Sources:
- IBM - Units of Measurement for Storage Data
- Wikipedia - Units of information
- WebPerfect - Data Units

Since:

0.0.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BitData.Unit	A data unit in the Bit Format, such as megabit or gigabit

Constructor Summary

Constructors

Constructor	Description
BitData(long bits)	Create a new BitData object.
BitData(long data, @NotNull BitData.Unit unit)	Create a new BitData object.

Method Summary

Modifier and Type	Method	Description
long	getAs(@NotNull BitData.Unit unit)	Get the bit-data in a specific unit.
double	getAsExact(@NotNull BitData.Unit unit)	Get the bit-data in a specific unit as a double for exact precision.
String	getOneUnitFormatted(BitData.Unit.Format format)	Get the bit-data as a formatted string that is readable.
String	getPreciselyFormatted(BitData.Unit.Format format)	Get the bit-data as a formatted string that is readable.
static @NotNull String	oneUnitFormat(long b, BitData.Unit.Format format)	Format the bit-data as a string representation using the highest possible unit.
static @NotNull String	oneUnitFormat(@NotNull BitData bitData, BitData.Unit.Format format)	Format the bit-data as a string representation using the highest possible unit.
static @NotNull String	preciselyFormat(long b, BitData.Unit.Format format)	Format the bit-data as a string representation using the highest possible unit and then lower ones for remaining data.
static @NotNull String	preciselyFormat(@NotNull BitData bitData, BitData.Unit.Format format)	Format the bit-data as a string representation using the highest possible unit and then lower ones for remaining data.

Methods inherited from class java.lang.Object

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

Constructor Details

BitData

public BitData(long bits)

Create a new BitData object.

Parameters:

bits - The data in bits.

BitData

public BitData(long data,
 @NotNull
 @NotNull BitData.Unit unit)

Create a new BitData object.

Parameters:

data - The data value.

unit - The unit of the time value.

Method Details

getOneUnitFormatted

public String getOneUnitFormatted(BitData.Unit.Format format)

Get the bit-data as a formatted string that is readable. The formatted bit-data uses the highest unit possible for the best readability.

Parameters:

format - The format to use.

Returns:

The bit-data as a formatted string.

See Also:

• oneUnitFormat(long, Unit.Format)

getPreciselyFormatted

public String getPreciselyFormatted(BitData.Unit.Format format)

Get the bit-data as a formatted string that is readable. The formatted bit-data uses the highest unit possible and then lower ones for remaining time.

Parameters:

format - The format to use.

Returns:

The bit-data as a formatted string.

See Also:

• preciselyFormat(BitData, Unit.Format)

getAs

public long getAs(@NotNull
 @NotNull BitData.Unit unit)

Get the bit-data in a specific unit.

Parameters:

unit - The unit in which the bit-data should be converted.

Returns:

The converted bit-data.

getAsExact

public double getAsExact(@NotNull
 @NotNull BitData.Unit unit)

Get the bit-data in a specific unit as a double for exact precision.

Parameters:

unit - The unit in which the bit-data should be converted.

Returns:

The converted bit-data.

oneUnitFormat

@NotNull
public static @NotNull String oneUnitFormat(long b,
 BitData.Unit.Format format)

Format the bit-data as a string representation using the highest possible unit.

Parameters:

b - The data in bits.

format - The format to use.

Returns:

The formatted bit-data string.

oneUnitFormat

@NotNull
public static @NotNull String oneUnitFormat(@NotNull
 @NotNull BitData bitData,
 BitData.Unit.Format format)

Format the bit-data as a string representation using the highest possible unit.

Parameters:

bitData - The data.

format - The format to use.

Returns:

The formatted bit-data string.

preciselyFormat

@NotNull
public static @NotNull String preciselyFormat(long b,
 BitData.Unit.Format format)

Format the bit-data as a string representation using the highest possible unit and then lower ones for remaining data.

Parameters:

b - The data in bit.

format - The format to use.

Returns:

The formatted bit-data string.

preciselyFormat

@NotNull
public static @NotNull String preciselyFormat(@NotNull
 @NotNull BitData bitData,
 BitData.Unit.Format format)

Format the bit-data as a string representation using the highest possible unit and then lower ones for remaining data.

Parameters:

bitData - The data.

format - The format to use.

Returns:

The formatted bit-data string.