javax.realtime
Class HeapMemory

java.lang.Object
  javax.realtime.MemoryArea
      javax.realtime.HeapMemory

public final class HeapMemory

extends MemoryArea

The HeapMemory class is a singleton object that allows logic within other scoped memory to allocate objects in the Java heap.

Author:

Angelo Corsaro

Field Summary

Fields inherited from class javax.realtime.MemoryArea

logic, parent, sizeInBytes

Method Summary

protected void	fini()
protected void	init()
static HeapMemory	instance() Returns a reference to the singleton HeapMemory space.
long	memoryConsumed() An exact count, in bytes, of the all of the memory currently used by the system for the allocated objects.
long	memoryRemaining() An approximation to the total amount of memory currently available for future allocated objects, measured in bytes.

Methods inherited from class javax.realtime.MemoryArea

enter, enter, executeInArea, finalize, getMemoryArea, guardedRun, newArray, newInstance, newInstance, size

Methods inherited from class java.lang.Object

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

Method Detail

memoryConsumed

public long memoryConsumed()

An exact count, in bytes, of the all of the memory currently used by the system for the allocated objects.

Specified by:

memoryConsumed in class MemoryArea

Returns:

The amount of memory consumed in bytes.

memoryRemaining

public long memoryRemaining()

An approximation to the total amount of memory currently available for future allocated objects, measured in bytes.

Specified by:

memoryRemaining in class MemoryArea

Returns:

The amount of remaining memory in bytes.

instance

public static HeapMemory instance()

Returns a reference to the singleton HeapMemory space.

Returns:

The singleton HeapMemory object.

init

protected void init()

Specified by:

init in class MemoryArea

fini

protected void fini()

Specified by:

fini in class MemoryArea