Package org.springframework.util.unit

Enum DataUnit

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<DataUnit>
    public enum DataUnit
extends java.lang.Enum<DataUnit>
    A standard set of DataSize units.

    The unit prefixes used in this class are binary prefixes indicating multiplication by powers of 2. The following table displays the enum constants defined in this class and corresponding values.

    ConstantData SizePower of 2Size in Bytes
    BYTES1B2^01
    KILOBYTES1KB2^101,024
    MEGABYTES1MB2^201,048,576
    GIGABYTES1GB2^301,073,741,824
    TERABYTES1TB2^401,099,511,627,776
    Since:
    5.1
    Author:
    Stephane Nicoll, Sam Brannen
    See Also:
    DataSize

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BYTES
      Bytes, represented by suffix B.
      GIGABYTES
      Gigabytes, represented by suffix GB.
      KILOBYTES
      Kilobytes, represented by suffix KB.
      MEGABYTES
      Megabytes, represented by suffix MB.
      TERABYTES
      Terabytes, represented by suffix TB.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static DataUnit fromSuffix​(java.lang.String suffix)
      Return the DataUnit matching the specified suffix.
      static DataUnit valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static DataUnit[] 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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • BYTES

        public static final DataUnit BYTES
        Bytes, represented by suffix B.

      • KILOBYTES

        public static final DataUnit KILOBYTES
        Kilobytes, represented by suffix KB.

      • MEGABYTES

        public static final DataUnit MEGABYTES
        Megabytes, represented by suffix MB.

      • GIGABYTES

        public static final DataUnit GIGABYTES
        Gigabytes, represented by suffix GB.

      • TERABYTES

        public static final DataUnit TERABYTES
        Terabytes, represented by suffix TB.

    • Method Detail

      • values

        public static DataUnit[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (DataUnit c : DataUnit.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static DataUnit 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

      • fromSuffix

        public static DataUnit fromSuffix​(java.lang.String suffix)
        Return the DataUnit matching the specified suffix.
        Parameters:
        suffix - one of the standard suffixes
        Returns:
        the DataUnit matching the specified suffix
        Throws:
        java.lang.IllegalArgumentException - if the suffix does not match the suffix of any of this enum's constants