Package com.marcpg.libpg.data.storage

Class ByteData

java.lang.Object

com.marcpg.libpg.data.storage.ByteData

public class ByteData
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	ByteData.Unit	A data unit in the Byte Format, such as megabytes or gigabytes

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
long	getAs(@NotNull ByteData.Unit unit)	Get the byte-data in a specific unit.
double	getAsExact(@NotNull ByteData.Unit unit)	Get the byte-data in a specific unit as a double for exact precision.
String	getOneUnitFormatted(ByteData.Unit.Format format)	Get the byte-data as a formatted string that is readable.
String	getPreciselyFormatted(ByteData.Unit.Format format)	Get the byte-data as a formatted string that is readable.
static @NotNull String	oneUnitFormat(long b, ByteData.Unit.Format format)	Format the byte-data as a string representation using the highest possible unit.
static @NotNull String	oneUnitFormat(@NotNull ByteData byteData, ByteData.Unit.Format format)	Format the byte-data as a string representation using the highest possible unit.
static @NotNull String	preciselyFormat(long b, ByteData.Unit.Format format)	Format the byte-data as a string representation using the highest possible unit and then lower ones for remaining data.
static @NotNull String	preciselyFormat(@NotNull ByteData byteData, ByteData.Unit.Format format)	Format the byte-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

ByteData

public ByteData(long bytes)

Create a new ByteData object.

Parameters:

bytes - The data in bytes.

ByteData

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

Create a new ByteData object.

Parameters:

data - The data value.

unit - The unit of the time value.

Method Details

getOneUnitFormatted

public String getOneUnitFormatted(ByteData.Unit.Format format)

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

Parameters:

format - The format to use.

Returns:

The byte-data as a formatted string.

See Also:

• oneUnitFormat(long, Unit.Format)

getPreciselyFormatted

public String getPreciselyFormatted(ByteData.Unit.Format format)

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

Parameters:

format - The format to use.

Returns:

The byte-data as a formatted string.

See Also:

• preciselyFormat(ByteData, Unit.Format)

getAs

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

Get the byte-data in a specific unit.

Parameters:

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

Returns:

The converted byte-data.

getAsExact

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

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

Parameters:

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

Returns:

The converted byte-data.

oneUnitFormat

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

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

Parameters:

b - The data in byte.

format - The format to use.

Returns:

The formatted byte-data string.

oneUnitFormat

@NotNull
public static @NotNull String oneUnitFormat(@NotNull
 @NotNull ByteData byteData,
 ByteData.Unit.Format format)

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

Parameters:

byteData - The data.

format - The format to use.

Returns:

The formatted byte-data string.

preciselyFormat

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

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

Parameters:

b - The data in byte.

format - The format to use.

Returns:

The formatted byte-data string.

preciselyFormat

@NotNull
public static @NotNull String preciselyFormat(@NotNull
 @NotNull ByteData byteData,
 ByteData.Unit.Format format)

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

Parameters:

byteData - The data.

format - The format to use.

Returns:

The formatted byte-data string.