javax.realtime

Class HeapMemory

java.lang.Object

javax.realtime.MemoryArea

javax.realtime.PerennialMemory

javax.realtime.HeapMemory

public final class HeapMemory
extends PerennialMemory

Jamaica Real-Time Specification for Java class HeapMemory.

Heap memory represents the default allocation context for Java applications.

Method Summary

Modifier and Type	Method and Description
boolean	executeInArea(BooleanSupplier logic) Executes the getAsBoolean() method from the logic parameter using this memory area as the current allocation context.
double	executeInArea(DoubleSupplier logic) Executes the getAsDouble() method from the logic parameter using this memory area as the current allocation context.
int	executeInArea(IntSupplier logic) Executes the getAsInt() method from the logic parameter using this memory area as the current allocation context.
long	executeInArea(LongSupplier logic) Executes the getAsLong() method from the logic parameter using this memory area as the current allocation context.
void	executeInArea(Runnable logic) Executes the run() method from the logic parameter using this memory area as the current allocation context.
<T> T	executeInArea(Supplier<T> logic) Executes the get() method from the logic parameter using this memory area as the current allocation context.
static HeapMemory	instance() instance returns the single instance of HeapMemory in the system.
long	memoryConsumed() memoryConsumed returns the number of bytes of memory of this memory area that have been consumed.
long	memoryRemaining() memoryRemaining returns the number of available bytes left in this memory area.

Methods inherited from class javax.realtime.MemoryArea

enter, enter, enter, enter, enter, enter, enter, getMemoryArea, mayHoldReferenceTo, mayHoldReferenceTo, newArray, newArrayInArea, newInstance, newInstance, size

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

instance

public static HeapMemory instance()

instance returns the single instance of HeapMemory in the system.

Returns:

the single instance of heap memory.

memoryRemaining

public long memoryRemaining()

memoryRemaining returns the number of available bytes left in this memory area. This may be an estimation of the amount of available memory. In JamaicaVM, memoryRemaining for HeapMemory is the total heap memory minus memoryConsumed().

Overrides:

memoryRemaining in class MemoryArea

Returns:

the number of free bytes in this memory area.

memoryConsumed

public long memoryConsumed()

memoryConsumed returns the number of bytes of memory of this memory area that have been consumed. For memory areas that are freed explicitly by the user (e.g. by exiting a scoped memory area), the result is exact. For other memory areas (that may be under the control of the garbage collector), the result may be an estimation. In JamaicaVM, the memoryConsumed() for HeapMemory is the amount of allocated (i.e. non-free) memory. It is an upper bound for the amount of reachable memory.

Overrides:

memoryConsumed in class MemoryArea

Returns:

number of bytes consumed from this memory area.

executeInArea

public void executeInArea(Runnable logic)

Description copied from class: MemoryArea

Executes the run() method from the logic parameter using this memory area as the current allocation context. The effect of executeInArea on the scope stack is specified in the subclasses of MemoryArea.

Overrides:

executeInArea in class MemoryArea

Parameters:

logic - The logic whose run() method is to be executed.

executeInArea

public boolean executeInArea(BooleanSupplier logic)

Description copied from class: MemoryArea

Executes the getAsBoolean() method from the logic parameter using this memory area as the current allocation context. The effect of executeInArea on the scope stack is specified in the subclasses of MemoryArea.

Overrides:

executeInArea in class MemoryArea

Parameters:

logic - The logic whose getAsBoolean() method is to be executed.

Returns:

the value return by the getAsBoolean() method.

executeInArea

public double executeInArea(DoubleSupplier logic)

Description copied from class: MemoryArea

Executes the getAsDouble() method from the logic parameter using this memory area as the current allocation context. The effect of executeInArea on the scope stack is specified in the subclasses of MemoryArea.

Overrides:

executeInArea in class MemoryArea

Parameters:

logic - The logic whose getAsDouble() method is to be executed.

Returns:

the value return by the getAsDouble() method.

executeInArea

public int executeInArea(IntSupplier logic)

Description copied from class: MemoryArea

Executes the getAsInt() method from the logic parameter using this memory area as the current allocation context. The effect of executeInArea on the scope stack is specified in the subclasses of MemoryArea.

Overrides:

executeInArea in class MemoryArea

Parameters:

logic - The logic whose getAsInt() method is to be executed.

Returns:

the value return by the getAsInt() method.

executeInArea

public long executeInArea(LongSupplier logic)

Description copied from class: MemoryArea

Executes the getAsLong() method from the logic parameter using this memory area as the current allocation context. The effect of executeInArea on the scope stack is specified in the subclasses of MemoryArea.

Overrides:

executeInArea in class MemoryArea

Parameters:

logic - The logic whose getAsLong() method is to be executed.

Returns:

the value return by the getAsLong() method.

executeInArea

public <T> T executeInArea(Supplier<T> logic)

Description copied from class: MemoryArea

Executes the get() method from the logic parameter using this memory area as the current allocation context. The effect of executeInArea on the scope stack is specified in the subclasses of MemoryArea.

Overrides:

executeInArea in class MemoryArea

Parameters:

logic - The logic whose get() method is to be executed.

Returns:

the value return by the get() method.