Package org.elasticsearch.common.unit

Enum Class ByteSizeUnit

<ByteSizeUnit>
org.elasticsearch.common.unit.ByteSizeUnit
All Implemented Interfaces:
, <, Writeable
public enum ByteSizeUnit extends <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.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.

    < extends <>>

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    Writeable.Reader<V>, Writeable.Writer<V>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    BYTES
     
    GB
     
    KB
     
    MB
     
    PB
     
    TB
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static ByteSizeUnit
    fromId​(int id)
     
    abstract
    getSuffix()
     
    static ByteSizeUnit
    readFrom​(StreamInput in)
    Reads a ByteSizeUnit from a given StreamInput
    abstract long
    toBytes​(long size)
     
    abstract long
    toGB​(long size)
     
    int
    toIntBytes​(long size)
    Convert to an int number of bytes.
    abstract long
    toKB​(long size)
     
    abstract long
    toMB​(long size)
     
    abstract long
    toPB​(long size)
     
    abstract long
    toTB​(long size)
     
    static ByteSizeUnit
     name)
    Returns the enum constant of this class with the specified name.
    static ByteSizeUnit[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.
    void
    writeTo​(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class java.lang.

    , , , , , , , , , ,

    Methods inherited from class java.lang.

    , , , , ,

  • 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  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:
      - if this enum class has no constant with the specified name
      - 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:
      - on overflow, unless assertions are enabled in which case it throws an .

    • 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  getSuffix()

    • writeTo

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

    • readFrom

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