ehcache-core 2.10.9.2 · net.sf.ehcache.config.MemoryUnit

Modifier and Type	Field and Description
public static final MemoryUnit	BYTES BYTES
public static final MemoryUnit	GIGABYTES GIGABYTES (1024 MEGABYTES)
public static final MemoryUnit	KILOBYTES KILOBYTES (1024 BYTES)
public static final MemoryUnit	MEGABYTES MEGABYTES (1024 KILOBYTES)
private static final int	OFFSET
private final int	offset
private final char	unit

Access	Constructor and Description
private	MemoryUnit(final int offset, final char unit)

Method Summary

Modifier and Type	Method and Description
public static MemoryUnit	Returns: the MemoryUnit instance matching the unit forUnit(final char the unit to look for unit) Returns the MemoryUnit instance based on provided char
public char	Returns: the unit character getUnit() Retrieves the unit character for the MemoryUnit
private static boolean	hasUnit(final String value)
public static long	Returns: the amount of mem in the unit represented by the potential unit char parseAmount(final String the String representation of an amount of memory value) Parses the amount represented by the string, without caring for the unit
public static long	Returns: the amount of bytes represented by the string parseSizeInBytes(final String the String representation of an amount of memory value) Parses the string for its content, returning the represented value in bytes
public static MemoryUnit	Returns: the MemoryUnit instance, or BYTES if none parseUnit(final String the String representation of an amount of memory value) Parses the unit part of a String, if no unit char available, returns `MemoryUnit#BYTES`
private static long	safeShift(final long unit, final long shift)
public abstract long	Returns: value in bytes toBytes(long of the unit amount) returns the amount in bytes
public abstract long	Returns: value in gigabytes toGigaBytes(long of the unit amount) returns the amount in gigabytes
public abstract long	Returns: value in kilobytes toKiloBytes(long of the unit amount) returns the amount in kilobytes
public abstract long	Returns: value in megabytes toMegaBytes(long of the unit amount) returns the amount in megabytes
public String	Returns: the String representation toString(final long the amount to print amount) Human readable value, with the added unit character as a suffix
public static MemoryUnit	valueOf(String name)
public static MemoryUnit[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

BYTES	back to summary
public static final MemoryUnit BYTES BYTES

GIGABYTES	back to summary
public static final MemoryUnit GIGABYTES GIGABYTES (1024 MEGABYTES)

KILOBYTES	back to summary
public static final MemoryUnit KILOBYTES KILOBYTES (1024 BYTES)

MEGABYTES	back to summary
public static final MemoryUnit MEGABYTES MEGABYTES (1024 KILOBYTES)

OFFSET	back to summary
private static final int OFFSET

offset	back to summary
private final int offset

unit	back to summary
private final char unit

MemoryUnit	back to summary
private MemoryUnit(final int offset, final char unit)

Method Detail

forUnit	back to summary
public static MemoryUnit forUnit(final char unit) throws IllegalArgumentException Returns the MemoryUnit instance based on provided char Parameters unit:char the unit to look for Returns:MemoryUnit the MemoryUnit instance matching the unit Exceptions IllegalArgumentException: if no matching MemoryUnit matching the char

forUnit

back to summary

public static MemoryUnit forUnit(final char unit) throws IllegalArgumentException

Returns the MemoryUnit instance based on provided char

Parameters

unit:char: the unit to look for

Returns:MemoryUnit

the MemoryUnit instance matching the unit

Exceptions

IllegalArgumentException:: if no matching MemoryUnit matching the char

getUnit	back to summary
public char getUnit() Retrieves the unit character for the MemoryUnit Returns:char the unit character

getUnit

back to summary

public char getUnit()

Retrieves the unit character for the MemoryUnit

Returns:char: the unit character

hasUnit	back to summary
private static boolean hasUnit(final String value)

parseAmount	back to summary
public static long parseAmount(final String value) throws NumberFormatException Parses the amount represented by the string, without caring for the unit Parameters value:String the String representation of an amount of memory Returns:long the amount of mem in the unit represented by the potential unit char Exceptions NumberFormatException: if not a number (with potential unit char stripped)

parseAmount

back to summary

public static long parseAmount(final String value) throws NumberFormatException

Parses the amount represented by the string, without caring for the unit

Parameters

value:String: the String representation of an amount of memory

Returns:long

the amount of mem in the unit represented by the potential unit char

Exceptions

NumberFormatException:: if not a number (with potential unit char stripped)

parseSizeInBytes	back to summary
public static long parseSizeInBytes(final String value) throws NumberFormatException, IllegalArgumentException Parses the string for its content, returning the represented value in bytes Parameters value:String the String representation of an amount of memory Returns:long the amount of bytes represented by the string Exceptions NumberFormatException: if not a number (with potential unit char stripped) IllegalArgumentException: if no matching MemoryUnit matching the char

parseSizeInBytes

back to summary

public static long parseSizeInBytes(final String value) throws NumberFormatException, IllegalArgumentException

Parses the string for its content, returning the represented value in bytes

Parameters

value:String: the String representation of an amount of memory

Returns:long

the amount of bytes represented by the string

Exceptions

NumberFormatException:: if not a number (with potential unit char stripped)
IllegalArgumentException:: if no matching MemoryUnit matching the char

parseUnit back to summary

parseUnit	back to summary
public static MemoryUnit parseUnit(final String value) Parses the unit part of a String, if no unit char available, returns `MemoryUnit#BYTES` Parameters value:String the String representation of an amount of memory Returns:MemoryUnit the MemoryUnit instance, or BYTES if none

public static MemoryUnit parseUnit(final String value)

Parses the unit part of a String, if no unit char available, returns MemoryUnit#BYTES

Parameters

value:String: the String representation of an amount of memory

Returns:MemoryUnit

the MemoryUnit instance, or BYTES if none

safeShift	back to summary
private static long safeShift(final long unit, final long shift)

toBytes	back to summary
public abstract long toBytes(long amount) returns the amount in bytes Parameters amount:long of the unit Returns:long value in bytes

toBytes

back to summary

public abstract long toBytes(long amount)

returns the amount in bytes

Parameters

amount:long: of the unit

Returns:long

value in bytes

toGigaBytes	back to summary
public abstract long toGigaBytes(long amount) returns the amount in gigabytes Parameters amount:long of the unit Returns:long value in gigabytes

toGigaBytes

back to summary

public abstract long toGigaBytes(long amount)

returns the amount in gigabytes

Parameters

amount:long: of the unit

Returns:long

value in gigabytes

toKiloBytes	back to summary
public abstract long toKiloBytes(long amount) returns the amount in kilobytes Parameters amount:long of the unit Returns:long value in kilobytes

toKiloBytes

back to summary

public abstract long toKiloBytes(long amount)

returns the amount in kilobytes

Parameters

amount:long: of the unit

Returns:long

value in kilobytes

toMegaBytes	back to summary
public abstract long toMegaBytes(long amount) returns the amount in megabytes Parameters amount:long of the unit Returns:long value in megabytes

toMegaBytes

back to summary

public abstract long toMegaBytes(long amount)

returns the amount in megabytes

Parameters

amount:long: of the unit

Returns:long

value in megabytes

toString	back to summary
public String toString(final long amount) Human readable value, with the added unit character as a suffix Parameters amount:long the amount to print Returns:String the String representation

toString

back to summary

public String toString(final long amount)

Human readable value, with the added unit character as a suffix

Parameters

amount:long: the amount to print

Returns:String

the String representation

valueOf	back to summary
public static MemoryUnit valueOf(String name)

values	back to summary
public static MemoryUnit[] values()

public sealed Enum MemoryUnit

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail