Package javax.measure

Enum Class BinaryPrefix

java.lang.Object
java.lang.Enum<BinaryPrefix>
javax.measure.BinaryPrefix
All Implemented Interfaces:
Serializable, Comparable<BinaryPrefix>, Constable, Prefix
public enum BinaryPrefix extends Enum<BinaryPrefix> implements Prefix
Provides support for common binary prefixes to be used by units. For example: 
 import static systems.uom.unicode.CLDR.*;  // Static import (from Unicode System).
 import static javax.measure.BinaryPrefix.*; // Static import.
 import javax.measure.*;
 import systems.uom.quantity.Information; // (from Systems Quantities)
 ...
 Unit<Information> MEBIT  = MEBI(BIT);
 Unit<Information> GIBYTE = GIBI(BYTE);
You could also apply Unit.prefix: 
 ...
 Unit<Information> MEBIT  = BIT.prefix(MEBI);
 Unit<Information> GIBYTE = BYTE.prefix(GIBI);

Do not use ordinal() to obtain the numeric representation of BinaryPrefix. Use getValue() and getExponent() instead.

Implementation Requirements
This is an immutable and thread-safe enum.
Since:
2.0
Version:
2.2, May 20, 2023
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    EXBI
    Prefix for 10246.
    GIBI
    Prefix for 10243.
    KIBI
    Prefix for 1024.
    MEBI
    Prefix for 10242.
    PEBI
    Prefix for 10245.
    TEBI
    Prefix for 10244.
    YOBI
    Prefix for 10248.
    ZEBI
    Prefix for 10247.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final int
    exponent
    Exponent part of the associated factor in base^exponent representation.
    private final String
    symbol
    The symbol of this prefix, as returned by getSymbol().

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    BinaryPrefix(String symbol, int exponent)
    Creates a new prefix.

  • Method Summary

    Modifier and Type
    Method
    Description
    static <Q extends Quantity<Q>>
    Unit<Q>
    EXBI(Unit<Q> unit)
    Returns the specified unit multiplied by the factor 10246 (binary prefix).
    int
    getExponent()
    Exponent part of the associated factor in base^exponent representation.
    String
    getName()
    Returns the name of this prefix.
    String
    getSymbol()
    Returns the symbol of this prefix.
    Integer
    getValue()
    Base part of the associated factor in base^exponent representation.
    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(String name)
    Returns the enum constant of this class with the specified name.
    static BinaryPrefix[]
    values()
    Returns an array containing the constants of this enum class, 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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • KIBI

      public static final BinaryPrefix KIBI
      Prefix for 1024.

    • MEBI

      public static final BinaryPrefix MEBI
      Prefix for 10242.

    • GIBI

      public static final BinaryPrefix GIBI
      Prefix for 10243.

    • TEBI

      public static final BinaryPrefix TEBI
      Prefix for 10244.

    • PEBI

      public static final BinaryPrefix PEBI
      Prefix for 10245.

    • EXBI

      public static final BinaryPrefix EXBI
      Prefix for 10246.

    • ZEBI

      public static final BinaryPrefix ZEBI
      Prefix for 10247.

    • YOBI

      public static final BinaryPrefix YOBI
      Prefix for 10248.

  • Field Details

    • symbol

      private final String symbol
      The symbol of this prefix, as returned by getSymbol().
      See Also:

    • exponent

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

  • Constructor Details

    • BinaryPrefix

      private BinaryPrefix(String symbol, int exponent)
      Creates a new prefix.
      Parameters:
      symbol - the symbol of this prefix.
      exponent - part of the associated factor in base^exponent representation.

  • Method Details

    • values

      public static BinaryPrefix[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static BinaryPrefix valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      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).
      Type Parameters:
      Q - type of the quantity measured by the unit.
      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).
      Type Parameters:
      Q - type of the quantity measured by the unit.
      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).
      Type Parameters:
      Q - type of the quantity measured by the unit.
      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).
      Type Parameters:
      Q - type of the quantity measured by the unit.
      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).
      Type Parameters:
      Q - type of the quantity measured by the unit.
      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).
      Type Parameters:
      Q - type of the quantity measured by the unit.
      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).
      Type Parameters:
      Q - type of the quantity measured by the unit.
      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).
      Type Parameters:
      Q - type of the quantity measured by the unit.
      Parameters:
      unit - any unit.
      Returns:
      unit.multiply(1208925819614629174706176d).

    • getSymbol

      public String getSymbol()
      Returns the symbol of this prefix.
      Specified by:
      getSymbol in interface Prefix
      Returns:
      this prefix symbol, not null.

    • getValue

      public Integer getValue()
      Base part of the associated factor in base^exponent representation. For binary prefix, this is always 1024.
      Specified by:
      getValue in interface Prefix
      Returns:
      The prefix value.

    • 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 String getName()
      Returns the name of this prefix.
      Specified by:
      getName in interface Prefix
      Returns:
      this prefix name, not null.