org.ehcache.config.units
Enum MemoryUnit

java.lang.Object
  java.lang.Enum<MemoryUnit>
      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

An enumeration implementing ResourceUnit to represent memory consumption.

Enum Constant Summary

B
Bytes unit.

GB
Gigabytes unit.

KB
Kilobytes unit.

MB
Megabytes unit.

PB
Petabytes unit.

TB
Terabytes unit.

Method Summary

int	compareTo(long thisSize, long thatSize, ResourceUnit thatUnit) Compare thisSize of this unit to thatSize of thatUnit.
long	convert(long amount, MemoryUnit unit) Returns amount in unit in to this unit.
long	toBytes(long size) Returns the size in bytes according to the unit this is invoked on.
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 unit.

KB

public static final MemoryUnit KB

Kilobytes unit.

MB

public static final MemoryUnit MB

Megabytes unit.

GB

public static final MemoryUnit GB

Gigabytes unit.

TB

public static final MemoryUnit TB

Terabytes unit.

PB

public static final MemoryUnit PB

Petabytes unit.

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 size)

Returns the size in bytes according to the unit this is invoked on.

Parameters:

size - the size, relative to the unit

Returns:

the size in bytes

convert

public long convert(long amount,
                    MemoryUnit unit)

Returns amount in unit in to this unit.

Parameters:

amount - size to convert

unit - amount's unit

Returns:

the amount 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)

Description copied from interface: ResourceUnit

Compare thisSize of this unit to thatSize of 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 unit

Returns:

as per the conventional compare contract