org.ehcache.config.units
Enum MemoryUnit

java.lang.Object
  extended by java.lang.Enum<MemoryUnit>
      extended by org.ehcache.config.units.MemoryUnit
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<MemoryUnit>, ResourceUnit

public enum MemoryUnit
extends java.lang.Enum<MemoryUnit>
implements ResourceUnit

A ResourceUnit that designates memory quantity.


Enum Constant Summary
B
          Bytes.
GB
          Gigabytes.
KB
          Kilobytes.
MB
          Megabytes.
PB
          Petabytes.
TB
          Terabytes.
 
Method Summary
 int compareTo(long thisSize, long thatSize, ResourceUnit thatUnit)
          Compares thisSize in this unit to thatSize in thatUnit.
 long convert(long quantity, MemoryUnit unit)
          Converts quantity in unit into this unit.
 long toBytes(long quantity)
          Converts quantity in this unit to bytes.
 java.lang.String toString()
          
static MemoryUnit valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static MemoryUnit[] 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, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

B

public static final MemoryUnit B
Bytes.


KB

public static final MemoryUnit KB
Kilobytes.


MB

public static final MemoryUnit MB
Megabytes.


GB

public static final MemoryUnit GB
Gigabytes.


TB

public static final MemoryUnit TB
Terabytes.


PB

public static final MemoryUnit PB
Petabytes.

Method Detail

values

public static MemoryUnit[] 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 (MemoryUnit c : MemoryUnit.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

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

toBytes

public long toBytes(long quantity)
Converts quantity in this unit to bytes.

Parameters:
quantity - the quantity
Returns:
the quantity in bytes

convert

public long convert(long quantity,
                    MemoryUnit unit)
Converts quantity in unit into this unit.

Parameters:
quantity - quantity to convert
unit - quantity's unit
Returns:
the quantity in this unit

toString

public java.lang.String toString()

Overrides:
toString in class java.lang.Enum<MemoryUnit>

compareTo

public int compareTo(long thisSize,
                     long thatSize,
                     ResourceUnit thatUnit)
              throws java.lang.IllegalArgumentException
Compares thisSize in this unit to thatSize in thatUnit.

Returns 1, 0, or -1 if the thisSize of this is greater than, equal to, or less than thatSize of thatUnit respectively.

Specified by:
compareTo in interface ResourceUnit
Parameters:
thisSize - size in this unit
thatSize - size in thatUnit
thatUnit - other ResourceUnit
Returns:
as per the compareTo contract
Throws:
java.lang.IllegalArgumentException - if the units are not comparable