Package de.iip_ecosphere.platform.services.environment.metricsProvider

Enum CapacityBaseUnit

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<CapacityBaseUnit>
    public enum CapacityBaseUnit
extends java.lang.Enum<CapacityBaseUnit>
    This enum represents a capacity base unit.
    This base units will be used in the MetricsProvider to correctly set the memory and disk capacity base units in a secure and simple way.
    The base units that can be represented by this enum and, as a result, can be used in the metrics provider are:
    • BYTES
    • KILOBYTES
    • MEGABYTES
    • GIGABYTES
    • TERABYTES
    Each value represented in this enum will provide the value in bytes of a single unit as well as a lower case representation of the base unit.
    Author:
    Miguel Gomez

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private CapacityBaseUnit()  

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract double byteValue()
      Retrieves the amount of bytes per unit of this CapacityBaseUnit.
      java.lang.String stringValue()
      Retrieves a String representing the lowercase name of this CapacityBaseUnit.
      static CapacityBaseUnit valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static CapacityBaseUnit[] 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

    • Constructor Detail

      • CapacityBaseUnit

        private CapacityBaseUnit()

    • Method Detail

      • values

        public static CapacityBaseUnit[] 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 (CapacityBaseUnit c : CapacityBaseUnit.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

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

      • byteValue

        public abstract double byteValue()
        Retrieves the amount of bytes per unit of this CapacityBaseUnit.
        Returns:
        number of bytes per unit of this CapacityBaseUnit

      • stringValue

        public java.lang.String stringValue()
        Retrieves a String representing the lowercase name of this CapacityBaseUnit.
        Returns:
        name of this capacity base unit in lowercase letters