ImmortalMemory (aicas JamaicaVM API)

java.lang.Object
- javax.realtime.MemoryArea
- - javax.realtime.PerennialMemory
  - - javax.realtime.ImmortalMemory

```
public final class ImmortalMemory
extends PerennialMemory
```
Jamaica Real-Time Specification for Java class ImmortalMemory.
ImmortalMemory is accessible by all schedulable objects (including NoHeapRealtimeThread and no-heap AbstractAsyncEventHandlers) and normal Java threads.
The memory of objects allocated in ImmortalMemory will never be reclaimed and finalize methods of objects allocated in ImmortalMemory will never be executed.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`enter()` Associates this memory area with the current schedulable for the duration of the execution of the `run()` method of the instance of `Runnable` given in the constructor.
`boolean`	`enter(BooleanSupplier logic)` Same as `MemoryArea.enter(Runnable)` except that the executed method is called `getAsBoolean()` and a boolean is returned.
`double`	`enter(DoubleSupplier logic)` Same as `MemoryArea.enter(Runnable)` except that the executed method is called `getAsDouble()` and a double is returned.
`int`	`enter(IntSupplier logic)` Same as `MemoryArea.enter(Runnable)` except that the executed method is called `getAsInt()` and an int is returned.
`long`	`enter(LongSupplier logic)` Same as `MemoryArea.enter(Runnable)` except that the executed method is called `getAsLong()` and a long is returned.
`void`	`enter(Runnable logic)` Associates this memory area with the current schedulable for the duration of the execution of the `run()` method of the given `Runnable`.
`<T> T`	`enter(Supplier<T> logic)` Same as `MemoryArea.enter(Runnable)` except that the executed method is called `get()` and an object is returned.
`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 ImmortalMemory`	`instance()` instance returns the single instance of ImmortalMemory in the system.

Methods inherited from class javax.realtime.MemoryArea
getMemoryArea, mayHoldReferenceTo, mayHoldReferenceTo, memoryConsumed, memoryRemaining, 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 ImmortalMemory instance()
```
    instance returns the single instance of ImmortalMemory in the system.
    
    Returns:
    
    the single instance of immortal memory.
  - enter
```
public void enter()
```
    Description copied from class: MemoryArea
    
    Associates this memory area with the current schedulable for the duration of the execution of the run() method of the instance of Runnable given in the constructor. During this period of execution, this memory area becomes the default allocation context until another default allocation context is selected (using enter, or MemoryArea.executeInArea(java.lang.Runnable)) or the enter method exits.
    
    Overrides:
    
    enter in class MemoryArea
  - enter
```
public void enter(Runnable logic)
```
    Description copied from class: MemoryArea
    
    Associates this memory area with the current schedulable for the duration of the execution of the run() method of the given Runnable. During this period of execution, this memory area becomes the default allocation context until another default allocation context is selected (using enter, or MemoryArea.executeInArea(java.lang.Runnable)) or the enter method exits.
    
    Overrides:
    
    enter in class MemoryArea
    
    Parameters:
    
    logic - The Runnable object whose run() method should be invoked.
  - enter
```
public boolean enter(BooleanSupplier logic)
```
    Description copied from class: MemoryArea
    
    Same as MemoryArea.enter(Runnable) except that the executed method is called getAsBoolean() and a boolean is returned.
    
    Overrides:
    
    enter in class MemoryArea
    
    Parameters:
    
    logic - The object whose getAsboolean() method is to be executed.
    
    Returns:
    
    the value return by the getAsBoolean() method.
  - enter
```
public double enter(DoubleSupplier logic)
```
    Description copied from class: MemoryArea
    
    Same as MemoryArea.enter(Runnable) except that the executed method is called getAsDouble() and a double is returned.
    
    Overrides:
    
    enter in class MemoryArea
    
    Parameters:
    
    logic - The object whose getAsDouble() method is to be executed.
    
    Returns:
    
    the value return by the getAsDouble() method.
  - enter
```
public int enter(IntSupplier logic)
```
    Description copied from class: MemoryArea
    
    Same as MemoryArea.enter(Runnable) except that the executed method is called getAsInt() and an int is returned.
    
    Overrides:
    
    enter in class MemoryArea
    
    Parameters:
    
    logic - The object whose getAsInt() method is to be executed.
    
    Returns:
    
    the value return by the getAsInt() method.
  - enter
```
public long enter(LongSupplier logic)
```
    Description copied from class: MemoryArea
    
    Same as MemoryArea.enter(Runnable) except that the executed method is called getAsLong() and a long is returned.
    
    Overrides:
    
    enter in class MemoryArea
    
    Parameters:
    
    logic - The object whose getAsLong() method is to be executed.
    
    Returns:
    
    the value return by the getAsLong() method.
  - enter
```
public <T> T enter(Supplier<T> logic)
```
    Description copied from class: MemoryArea
    
    Same as MemoryArea.enter(Runnable) except that the executed method is called get() and an object is returned. The The get() method must ensure that the returned object is allocated outside the area, when the area is not a PerennialMemory.
    
    Overrides:
    
    enter in class MemoryArea
    
    Parameters:
    
    logic - The object whose get() method is to be executed.
    
    Returns:
    
    the value return by the get() method.
  - 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.

Class ImmortalMemory

Method Summary

Methods inherited from class javax.realtime.MemoryArea

Methods inherited from class java.lang.Object

Method Detail

instance

enter

enter

enter

enter

enter

enter

enter

executeInArea

executeInArea

executeInArea

executeInArea

executeInArea

executeInArea