com.jakewharton.byteunits

Enum DecimalByteUnit

java.lang.Object

java.lang.Enum<DecimalByteUnit>

com.jakewharton.byteunits.DecimalByteUnit

All Implemented Interfaces:

ByteUnit, Serializable, Comparable<DecimalByteUnit>

public enum DecimalByteUnit
extends Enum<DecimalByteUnit>
implements ByteUnit

A DecimalByteUnit represents power-of-ten byte sizes at a given unit of granularity and provides utility methods to convert across units. A DecimalByteUnit does not maintain byte size information, but only helps organize and use byte size representations that may be maintained separately across various contexts.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BYTES Byte unit representing one byte.
GIGABYTES A byte unit representing 1000 megabytes.
KILOBYTES A byte unit representing 1000 bytes.
MEGABYTES A byte unit representing 1000 kilobytes.
PETABYTES A byte unit representing 1000 terabytes.
TERABYTES A byte unit representing 1000 gigabytes.

Method Summary

Modifier and Type	Method and Description
long	convert(long sourceCount, DecimalByteUnit sourceUnit) Converts the given size in the given unit to this unit.
long	toGigabytes(long count) Equivalent to GIGABYTES.convert(count, this).
long	toKilobytes(long count) Equivalent to KILOBYTES.convert(count, this).
long	toMegabytes(long count) Equivalent to MEGABYTES.convert(count, this).
long	toPetabytes(long count) Equivalent to PETABYTES.convert(count, this).
long	toTerabytes(long count) Equivalent to TERABYTES.convert(count, this).
static DecimalByteUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static DecimalByteUnit[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.jakewharton.byteunits.ByteUnit

toBytes

Enum Constant Detail

BYTES

public static final DecimalByteUnit BYTES

Byte unit representing one byte.

KILOBYTES

public static final DecimalByteUnit KILOBYTES

A byte unit representing 1000 bytes.

MEGABYTES

public static final DecimalByteUnit MEGABYTES

A byte unit representing 1000 kilobytes.

GIGABYTES

public static final DecimalByteUnit GIGABYTES

A byte unit representing 1000 megabytes.

TERABYTES

public static final DecimalByteUnit TERABYTES

A byte unit representing 1000 gigabytes.

PETABYTES

public static final DecimalByteUnit PETABYTES

A byte unit representing 1000 terabytes.

Method Detail

values

public static DecimalByteUnit[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DecimalByteUnit c : DecimalByteUnit.values())
    System.out.println(c);

Returns:

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

valueOf

public static DecimalByteUnit valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

convert

public long convert(long sourceCount,
                    DecimalByteUnit sourceUnit)

Converts the given size in the given unit to this unit. Conversions from finer to coarser granularities truncate, so lose precision. For example, converting from 999 bytes to kilobytes results in 0. Conversions from coarser to finer granularities with arguments that would numerically overflow saturate to Long.MIN_VALUE if negative or Long.MAX_VALUE if positive.

For example, to convert 10 kilobytes to bytes, use: ByteUnit.KILOBYTES.convert(10, ByteUnit.BYTES)

Parameters:

sourceCount - the size in the given sourceUnit.

sourceUnit - the unit of the sourceCount argument.

Returns:

the converted size in this unit, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.

toKilobytes

public long toKilobytes(long count)

Equivalent to KILOBYTES.convert(count, this).

Parameters:

count - the bit count

Returns:

the converted count, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.

toMegabytes

public long toMegabytes(long count)

Equivalent to MEGABYTES.convert(count, this).

Parameters:

count - the bit count

Returns:

the converted count, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.

toGigabytes

public long toGigabytes(long count)

Equivalent to GIGABYTES.convert(count, this).

Parameters:

count - the bit count

Returns:

the converted count, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.

toTerabytes

public long toTerabytes(long count)

Equivalent to TERABYTES.convert(count, this).

Parameters:

count - the bit count

Returns:

the converted count, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.

toPetabytes

public long toPetabytes(long count)

Equivalent to PETABYTES.convert(count, this).

Parameters:

count - the bit count

Returns:

the converted count, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.