Enum ByteUnit

java.lang.Object
java.lang.Enum<ByteUnit>
one.microstream.configuration.types.ByteUnit
All Implemented Interfaces:
Serializable, Comparable<ByteUnit>, java.lang.constant.Constable

public enum ByteUnit
extends Enum<ByteUnit>
Size units for byte multiples:

Can be used to convert between units as well, see convert(double, ByteUnit).

See Also:
https://en.wikipedia.org/wiki/Binary_prefix, https://physics.nist.gov/cuu/Units/prefixes.html, https://physics.nist.gov/cuu/Units/binary.html
  • Enum Constant Details

  • Method Details

    • values

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

      public static ByteUnit 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
    • ofName

      public static ByteUnit ofName​(String name)
    • convert

      public static ByteUnit.Conversion convert​(double sourceValue, ByteUnit sourceUnit)
      Starts a conversion, continue with ByteUnit.Conversion.to(ByteUnit), e.g.:

      convert(1.5, ByteMultiple.MB).to(ByteMultiple.KB);

      Parameters:
      sourceValue - the source value to convert
      sourceUnit - the source unit to convert
      Returns:
      the conversion for method chaining
      See Also:
      ByteUnit.Conversion
    • toBytes

      public long toBytes​(double value)
      Returns the number of bytes, which this unit multiplied by value yields.
      Parameters:
      value - the value to convert
      Returns:
      the value converted to bytes