com.complexible.common.memory

Enum PredefinedMemoryConfiguration

java.lang.Object

java.lang.Enum<PredefinedMemoryConfiguration>

com.complexible.common.memory.PredefinedMemoryConfiguration

All Implemented Interfaces:

MemoryConfiguration, Serializable, Comparable<PredefinedMemoryConfiguration>

public enum PredefinedMemoryConfiguration
extends Enum<PredefinedMemoryConfiguration>
implements MemoryConfiguration

Predefined memory configuration modes. The predefined modes specify the percentage of memory (between 0 and 100) a component will use rather then fixed amount of memory. A configuration with actual memory limits can be created using the withAvailableMemory(long, long) function.

Since:

5.0

Version:

5.0

Author:

Evren

Nested Class Summary

Nested classes/interfaces inherited from interface com.complexible.common.memory.MemoryConfiguration

MemoryConfiguration.HeapComponent, MemoryConfiguration.NativeComponent

Enum Constant Summary

Enum Constants

Enum Constant and Description
BULK_LOAD Memory configuration optimized for bulk loads.
DEFAULT Memory configuration optimized for mixed workloads.
READ_OPTIMIZED Memory configuration optimized for read queries.
WRITE_OPTIMIZED Memory configuration optimized for updates.

Field Summary

Fields inherited from interface com.complexible.common.memory.MemoryConfiguration

CURRENT

Method Summary

Modifier and Type	Method and Description
long	getMemory(MemoryConfiguration.HeapComponent component) Returns the maximum amount of heap memory in bytes that can be for the given component.
long	getMemory(MemoryConfiguration.NativeComponent component) Returns the maximum amount of native memory in bytes that can be for the given component.
static PredefinedMemoryConfiguration	valueOf(String name) Returns the enum constant of this type with the specified name.
static PredefinedMemoryConfiguration[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
MemoryConfiguration	withAvailableMemory(long nativeMem, long heapMem) Returns a new configuration object that applies the percentages defined in this instance to the given available memory amounts.

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

Methods inherited from interface com.complexible.common.memory.MemoryConfiguration

get, set

Enum Constant Detail

READ_OPTIMIZED

public static final PredefinedMemoryConfiguration READ_OPTIMIZED

Memory configuration optimized for read queries. Updates should be avoided as much as possible,

DEFAULT

public static final PredefinedMemoryConfiguration DEFAULT

Memory configuration optimized for mixed workloads.

WRITE_OPTIMIZED

public static final PredefinedMemoryConfiguration WRITE_OPTIMIZED

Memory configuration optimized for updates. This mode is suitable for write heavy applications where reads are infrequent and/or do not require much memory.

BULK_LOAD

public static final PredefinedMemoryConfiguration BULK_LOAD

Memory configuration optimized for bulk loads. This mode is suitable for bulk loading very large amounts of data (many billions of triples). After bulk loading is complete this mode should be changed back to another mode.

Method Detail

values

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

Returns:

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

valueOf

public static PredefinedMemoryConfiguration valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getMemory

public long getMemory(MemoryConfiguration.NativeComponent component)

Description copied from interface: MemoryConfiguration

Returns the maximum amount of native memory in bytes that can be for the given component.

Specified by:

getMemory in interface MemoryConfiguration

Parameters:

component - a component that uses native memory

Returns:

the maximum amount of native memory in bytes that can be for the given component.

getMemory

public long getMemory(MemoryConfiguration.HeapComponent component)

Description copied from interface: MemoryConfiguration

Returns the maximum amount of heap memory in bytes that can be for the given component.

Specified by:

getMemory in interface MemoryConfiguration

Parameters:

component - a component that uses heap memory

Returns:

the maximum amount of heap memory in bytes that can be for the given component.

withAvailableMemory

public MemoryConfiguration withAvailableMemory(long nativeMem,
                                               long heapMem)

Returns a new configuration object that applies the percentages defined in this instance to the given available memory amounts.

Parameters:

nativeMem - available native memory in bytes

heapMem - available heap memory in bytes

Returns:

new configuration with actual memory values for each component