Package com.github.alex1304.ultimategdbot.api.utils

Enum SystemUnit

java.lang.Object
java.lang.Enum<SystemUnit>
com.github.alex1304.ultimategdbot.api.utils.SystemUnit
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<SystemUnit>, java.lang.constant.Constable
public enum SystemUnit
extends java.lang.Enum<SystemUnit>
Enumerates system units (bytes, kilobytes, etc until terabytes) Provides methods for conversion and formatting.

  • Nested Class Summary

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

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    BYTE  
    GIGABYTE  
    KILOBYTE  
    MEGABYTE  
    TERABYTE  

  • Method Summary

    Modifier and Type Method Description
    double convert​(long byteValue)
    Converts the given value to the unit represented by the current object
    static java.lang.String format​(long byteValue)
    Formats the given value to a human readable format, using the appropriate unit
    java.lang.String toString()  
    static SystemUnit valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static SystemUnit[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

  • Method Details

    • values

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

    • convert

      public double convert​(long byteValue)
      Converts the given value to the unit represented by the current object
      Parameters:
      byteValue - the value to convert
      Returns:
      double

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Enum<SystemUnit>

    • format

      public static java.lang.String format​(long byteValue)
      Formats the given value to a human readable format, using the appropriate unit
      Parameters:
      byteValue - the value to format
      Returns:
      String