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

Enum Class CapacityBaseUnit

java.lang.Object

java.lang.Enum<CapacityBaseUnit>

de.iip_ecosphere.platform.services.environment.metricsProvider.CapacityBaseUnit

All Implemented Interfaces:

Serializable, Comparable<CapacityBaseUnit>, Constable

public enum CapacityBaseUnit
extends 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

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BYTES
GIGABYTES
KILOBYTES
MEGABYTES
TERABYTES

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CapacityBaseUnit()

Method Summary

Modifier and Type	Method	Description
abstract double	byteValue()	Retrieves the amount of bytes per unit of this CapacityBaseUnit.
String	stringValue()	Retrieves a String representing the lowercase name of this CapacityBaseUnit.
static CapacityBaseUnit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CapacityBaseUnit[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BYTES

public static final CapacityBaseUnit BYTES

KILOBYTES

public static final CapacityBaseUnit KILOBYTES

MEGABYTES

public static final CapacityBaseUnit MEGABYTES

GIGABYTES

public static final CapacityBaseUnit GIGABYTES

TERABYTES

public static final CapacityBaseUnit TERABYTES

Constructor Details

CapacityBaseUnit

private CapacityBaseUnit()

Method Details

values

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

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 String stringValue()

Retrieves a String representing the lowercase name of this CapacityBaseUnit.

Returns:

name of this capacity base unit in lowercase letters