javax.measure

Enum BinaryPrefix

java.lang.Object

java.lang.Enum<BinaryPrefix>

javax.measure.BinaryPrefix

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BinaryPrefix>, Prefix

public enum BinaryPrefix
extends java.lang.Enum<BinaryPrefix>
implements Prefix

This class provides support for common binary prefixes to be used by units.

Since:

2.0

Version:

1.4, August 8, 2018

Author:

Werner Keil

See Also:

Wikipedia: Binary Prefix

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXBI
GIBI
KIBI
MEBI
PEBI
TEBI
YOBI
ZEBI

Method Summary

Modifier and Type	Method and Description
static <Q extends Quantity<Q>> Unit<Q>	EXBI(Unit<Q> unit) Returns the specified unit multiplied by the factor 10246 (binary prefix).
int	getBase() Base part of the associated factor in base^exponent representation.
int	getExponent() Exponent part of the associated factor in base^exponent representation.
java.lang.String	getName() Returns the name of this prefix.
java.lang.String	getSymbol() Returns the symbol of this prefix.
static <Q extends Quantity<Q>> Unit<Q>	GIBI(Unit<Q> unit) Returns the specified unit multiplied by the factor 10243 (binary prefix).
static <Q extends Quantity<Q>> Unit<Q>	KIBI(Unit<Q> unit) Returns the specified unit multiplied by the factor 1024 (binary prefix).
static <Q extends Quantity<Q>> Unit<Q>	MEBI(Unit<Q> unit) Returns the specified unit multiplied by the factor 10242 (binary prefix).
static <Q extends Quantity<Q>> Unit<Q>	PEBI(Unit<Q> unit) Returns the specified unit multiplied by the factor 10245 (binary prefix).
static <Q extends Quantity<Q>> Unit<Q>	TEBI(Unit<Q> unit) Returns the specified unit multiplied by the factor 10244 (binary prefix).
static BinaryPrefix	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BinaryPrefix[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static <Q extends Quantity<Q>> Unit<Q>	YOBI(Unit<Q> unit) Returns the specified unit multiplied by the factor 10248 (binary prefix).
static <Q extends Quantity<Q>> Unit<Q>	ZEBI(Unit<Q> unit) Returns the specified unit multiplied by the factor 10247 (binary prefix).

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

Enum Constant Detail

KIBI

public static final BinaryPrefix KIBI

MEBI

public static final BinaryPrefix MEBI

GIBI

public static final BinaryPrefix GIBI

TEBI

public static final BinaryPrefix TEBI

PEBI

public static final BinaryPrefix PEBI

EXBI

public static final BinaryPrefix EXBI

ZEBI

public static final BinaryPrefix ZEBI

YOBI

public static final BinaryPrefix YOBI

Method Detail

values

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

Returns:

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

valueOf

public static BinaryPrefix valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

KIBI

public static <Q extends Quantity<Q>> Unit<Q> KIBI(Unit<Q> unit)

Returns the specified unit multiplied by the factor 1024 (binary prefix).

Parameters:

unit - any unit.

Returns:

unit.multiply(1024).

MEBI

public static <Q extends Quantity<Q>> Unit<Q> MEBI(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10242 (binary prefix).

Parameters:

unit - any unit.

Returns:

unit.multiply(1048576).

GIBI

public static <Q extends Quantity<Q>> Unit<Q> GIBI(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10243 (binary prefix).

Parameters:

unit - any unit.

Returns:

unit.multiply(1073741824).

TEBI

public static <Q extends Quantity<Q>> Unit<Q> TEBI(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10244 (binary prefix).

Parameters:

unit - any unit.

Returns:

unit.multiply(1099511627776L).

PEBI

public static <Q extends Quantity<Q>> Unit<Q> PEBI(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10245 (binary prefix).

Parameters:

unit - any unit.

Returns:

unit.multiply(1125899906842624L).

EXBI

public static <Q extends Quantity<Q>> Unit<Q> EXBI(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10246 (binary prefix).

Parameters:

unit - any unit.

Returns:

unit.multiply(1152921504606846976L).

ZEBI

public static <Q extends Quantity<Q>> Unit<Q> ZEBI(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10247 (binary prefix).

Parameters:

unit - any unit.

Returns:

unit.multiply(1152921504606846976d).

YOBI

public static <Q extends Quantity<Q>> Unit<Q> YOBI(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10248 (binary prefix).

Parameters:

unit - any unit.

Returns:

unit.multiply(1208925819614629174706176d).

getSymbol

public java.lang.String getSymbol()

Returns the symbol of this prefix.

Specified by:

getSymbol in interface Prefix

Returns:

this prefix symbol, not null.

getBase

public int getBase()

Base part of the associated factor in base^exponent representation.

Specified by:

getBase in interface Prefix

Returns:

the base part of this prefix.

getExponent

public int getExponent()

Exponent part of the associated factor in base^exponent representation.

Specified by:

getExponent in interface Prefix

Returns:

the exponent part of this prefix.

getName

public java.lang.String getName()

Returns the name of this prefix.

Specified by:

getName in interface Prefix

Returns:

this prefix name, not null.