javax.realtime

Class StaticOutOfMemoryError

java.lang.Object

java.lang.Throwable

java.lang.Error

java.lang.VirtualMachineError

java.lang.OutOfMemoryError

javax.realtime.StaticOutOfMemoryError

All Implemented Interfaces:

java.io.Serializable, StaticThrowable<StaticOutOfMemoryError>

public class StaticOutOfMemoryError
extends java.lang.OutOfMemoryError
implements StaticThrowable<StaticOutOfMemoryError>

A version of OutOfMemoryError that does not require allocation. It should be thrown from all RTSJ memory subclasses except HeapMemory. It is up to the implementation as to whether HeapMemory throws this exception or its parent.

Since:

RTSJ 2.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface javax.realtime.StaticThrowable

StaticThrowable.Hidden

Method Summary

Modifier and Type	Method and Description
java.lang.Throwable	fillInStackTrace() Calls into the virtual machine to capture the current stack trace in task's local memory.
static StaticOutOfMemoryError	get() Gets the preallocated version of this Throwable.
java.lang.Throwable	getCause() getCause returns the cause of this exception or null when no cause was set.
java.lang.String	getLocalizedMessage() Subclasses may override this message to get an error message that is localized to the default locale.
java.lang.String	getMessage() get the message describing the problem from task's local memory.
StaticOutOfMemoryError	getSingleton() For the case of legacy code that creates an RTSJ exception explicity, this provides a means of obtaining its singleton version.
java.lang.StackTraceElement[]	getStackTrace() Get the stack trace created by fillInStackTrace for this Throwable as an array of StackTraceElements.
java.lang.Throwable	initCause(java.lang.Throwable causingThrowable) Initializes the cause to the given Throwable is task's local memory.
void	printStackTrace() Print stack trace of this Throwable to System.err.
void	printStackTrace(java.io.PrintStream stream) Print the stack trace of this Throwable to the given stream.
void	printStackTrace(java.io.PrintWriter writer) Print the stack trace of this Throwable to the given PrintWriter.
void	setStackTrace(java.lang.StackTraceElement[] new_stackTrace) This method allows overriding the stack trace that was filled during construction of this object.

Methods inherited from class java.lang.Throwable

addSuppressed, getSuppressed, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.realtime.StaticThrowable

init, init, init, init, isStatic, writeReplace

Method Detail

get

public static StaticOutOfMemoryError get()

Gets the preallocated version of this Throwable. Allocation is done in memory that acts like ImmortalMemory. The message and cause are cleared and the stack trace is filled out.

Returns:

the preallocated exception.

getMessage

public java.lang.String getMessage()

Description copied from interface: StaticThrowable

get the message describing the problem from task's local memory.

Specified by:

getMessage in interface StaticThrowable<StaticOutOfMemoryError>

Overrides:

getMessage in class java.lang.Throwable

Returns:

the message given to the constructor or null when no message was set.

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Description copied from interface: StaticThrowable

Subclasses may override this message to get an error message that is localized to the default locale.

By default it returns getMessage().

Specified by:

getLocalizedMessage in interface StaticThrowable<StaticOutOfMemoryError>

Overrides:

getLocalizedMessage in class java.lang.Throwable

Returns:

the value of getMessage().

initCause

public java.lang.Throwable initCause(java.lang.Throwable causingThrowable)

Description copied from interface: StaticThrowable

Initializes the cause to the given Throwable is task's local memory.

Specified by:

initCause in interface StaticThrowable<StaticOutOfMemoryError>

Overrides:

initCause in class java.lang.Throwable

Parameters:

causingThrowable - the reason why this Throwable gets Thrown.

Returns:

the reference to this Throwable.

getCause

public java.lang.Throwable getCause()

Description copied from interface: StaticThrowable

getCause returns the cause of this exception or null when no cause was set. The cause is another exception that was caught before this exception was created.

Specified by:

getCause in interface StaticThrowable<StaticOutOfMemoryError>

Overrides:

getCause in class java.lang.Throwable

Returns:

The cause or null.

fillInStackTrace

public java.lang.Throwable fillInStackTrace()

Description copied from interface: StaticThrowable

Calls into the virtual machine to capture the current stack trace in task's local memory.

Specified by:

fillInStackTrace in interface StaticThrowable<StaticOutOfMemoryError>

Overrides:

fillInStackTrace in class java.lang.Throwable

Returns:

a reference to this Throwable.

setStackTrace

public void setStackTrace(java.lang.StackTraceElement[] new_stackTrace)
                   throws java.lang.NullPointerException

Description copied from interface: StaticThrowable

This method allows overriding the stack trace that was filled during construction of this object. It is intended to be used in a serialization context when the stack trace of a remote exception should be treated like a local.

Specified by:

setStackTrace in interface StaticThrowable<StaticOutOfMemoryError>

Overrides:

setStackTrace in class java.lang.Throwable

Parameters:

new_stackTrace - the stack trace to replace be used.

Throws:

java.lang.NullPointerException - when new_stackTrace or any element of new_stackTrace is null.

getStackTrace

public java.lang.StackTraceElement[] getStackTrace()

Description copied from interface: StaticThrowable

Get the stack trace created by fillInStackTrace for this Throwable as an array of StackTraceElements.

The stack trace does not need to contain entries for all methods that are actually on the call stack, the virtual machine may decide to skip some stack trace entries. Even an empty array is a valid result of this function.

Repeated calls of this function without intervening calls to fillInStackTrace will return the same result.

When memory areas of the RTSJ are used (see MemoryArea), and this Throwable was allocated in a different memory area than the current allocation context, the resulting stack trace will be allocated in either the same memory area this was allocated in or the current memory area, depending on which is the least deeply nested, thereby creating objects that are assignment compatible with both areas.

Specified by:

getStackTrace in interface StaticThrowable<StaticOutOfMemoryError>

Overrides:

getStackTrace in class java.lang.Throwable

Returns:

array representing the stack trace, never null.

printStackTrace

public void printStackTrace()

Description copied from interface: StaticThrowable

Print stack trace of this Throwable to System.err.

The printed stack trace contains the result of toString() as the first line followed by one line for each stack trace element that contains the name of the method or constructor, optionally followed by the source file name and source file line number when available.

Specified by:

printStackTrace in interface StaticThrowable<StaticOutOfMemoryError>

Overrides:

printStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintStream stream)

Description copied from interface: StaticThrowable

Print the stack trace of this Throwable to the given stream.

The printed stack trace contains the result of toString() as the first line followed by one line for each stack trace element that contains the name of the method or constructor, optionally followed by the source file name and source file line number when available.

Specified by:

printStackTrace in interface StaticThrowable<StaticOutOfMemoryError>

Overrides:

printStackTrace in class java.lang.Throwable

Parameters:

stream - the stream to print to.

printStackTrace

public void printStackTrace(java.io.PrintWriter writer)

Description copied from interface: StaticThrowable

Print the stack trace of this Throwable to the given PrintWriter.

The printed stack trace contains the result of toString() as the first line followed by one line for each stack trace element that contains the name of the method or constructor, optionally followed by the source file name and source file line number when available.

Specified by:

printStackTrace in interface StaticThrowable<StaticOutOfMemoryError>

Overrides:

printStackTrace in class java.lang.Throwable

Parameters:

writer - the PrintWriter to write to.

getSingleton

public StaticOutOfMemoryError getSingleton()

Description copied from interface: StaticThrowable

For the case of legacy code that creates an RTSJ exception explicity, this provides a means of obtaining its singleton version.

Specified by:

getSingleton in interface StaticThrowable<StaticOutOfMemoryError>

Returns:

the singleton version of this exception.