Package org.elasticsearch.common.unit

Enum Class ByteSizeUnit

java.lang.Object
java.lang.Enum<ByteSizeUnit>
org.elasticsearch.common.unit.ByteSizeUnit
All Implemented Interfaces:
Serializable, Comparable<ByteSizeUnit>, Constable, Writeable
public enum ByteSizeUnit extends Enum<ByteSizeUnit> implements Writeable
A SizeUnit represents size at a given unit of granularity and provides utility methods to convert across units. A SizeUnit does not maintain size information, but only helps organize and use size representations that may be maintained separately across various contexts.

  • Enum Constant Details

  • Method Details

    • values

      public static ByteSizeUnit[] 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 ByteSizeUnit 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

    • fromId

      public static ByteSizeUnit fromId​(int id)

    • toIntBytes

      public final int toIntBytes​(long size)
      Convert to an int number of bytes. Callers are expected to be certain this will not overflow.
      Returns:
      The number of bytes represented as an int.
      Throws:
      IllegalArgumentException - on overflow, unless assertions are enabled in which case it throws an AssertionError.

    • toBytes

      public abstract long toBytes​(long size)

    • toKB

      public abstract long toKB​(long size)

    • toMB

      public abstract long toMB​(long size)

    • toGB

      public abstract long toGB​(long size)

    • toTB

      public abstract long toTB​(long size)

    • toPB

      public abstract long toPB​(long size)

    • getSuffix

      public abstract String getSuffix()

    • writeTo

      public void writeTo​(StreamOutput out) throws IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException

    • readFrom

      public static ByteSizeUnit readFrom​(StreamInput in) throws IOException
      Reads a ByteSizeUnit from a given StreamInput
      Throws:
      IOException