com.jakewharton.byteunits

Enum BitUnit

java.lang.Object

java.lang.Enum<BitUnit>

com.jakewharton.byteunits.BitUnit

All Implemented Interfaces:

ByteUnit, Serializable, Comparable<BitUnit>

public enum BitUnit
extends Enum<BitUnit>
implements ByteUnit

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
BITS Bit unit representing one bit.
GIGABITS A bit unit representing 1000 megabits.
KILOBITS A bit unit representing 1000 bits.
MEGABITS A bit unit representing 1000 kilobits.
PETABITS A bit unit representing 1000 terabits.
TERABITS A bit unit representing 1000 gigabits.

Method Summary

Modifier and Type	Method and Description
long	convert(long sourceCount, BitUnit sourceUnit) Converts the given size in the given unit to this unit.
long	toBits(long count) Equivalent to BITS.convert(count, this).
long	toGigabits(long count) Equivalent to GIGABITS.convert(count, this).
long	toKilobits(long count) Equivalent to KILOBITS.convert(count, this).
long	toMegabits(long count) Equivalent to MEGABITS.convert(count, this).
long	toPetabits(long count) Equivalent to PETABITS.convert(count, this).
long	toTerabits(long count) Equivalent to TERABITS.convert(count, this).
static BitUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static BitUnit[]	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

BITS

public static final BitUnit BITS

Bit unit representing one bit.

KILOBITS

public static final BitUnit KILOBITS

A bit unit representing 1000 bits.

MEGABITS

public static final BitUnit MEGABITS

A bit unit representing 1000 kilobits.

GIGABITS

public static final BitUnit GIGABITS

A bit unit representing 1000 megabits.

TERABITS

public static final BitUnit TERABITS

A bit unit representing 1000 gigabits.

PETABITS

public static final BitUnit PETABITS

A bit unit representing 1000 terabits.

Method Detail

values

public static BitUnit[] 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 (BitUnit c : BitUnit.values())
    System.out.println(c);

Returns:

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

valueOf

public static BitUnit 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,
                    BitUnit 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 bit to kilobits 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.KILOBITS.convert(10, ByteUnit.BITS)

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.

toBits

public long toBits(long count)

Equivalent to BITS.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.

toKilobits

public long toKilobits(long count)

Equivalent to KILOBITS.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.

toMegabits

public long toMegabits(long count)

Equivalent to MEGABITS.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.

toGigabits

public long toGigabits(long count)

Equivalent to GIGABITS.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.

toTerabits

public long toTerabits(long count)

Equivalent to TERABITS.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.

toPetabits

public long toPetabits(long count)

Equivalent to PETABITS.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.