javax.realtime

Class StaticThrowableStorage

java.lang.Object

java.lang.Throwable

javax.realtime.StaticThrowableStorage

All Implemented Interfaces:

java.io.Serializable

public class StaticThrowableStorage
extends java.lang.Throwable

Provides the methods for managing the thread local memory used for storing the data needed by preallocated throwables, i.e., exceptions and errors which implement StaticThrowable. This call is visible so that an application can extend an existing conventional Java throwable and still implement StaticThrowable; its methods can be implemented using the methods defined in this class. An application defined throwable that does not need to extend an existing conventional Java throwable should extend one of StaticCheckedException, StaticRuntimeException, or StaticError instead.

Since:

RTSJ 2.0

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
java.lang.Throwable	fillInStackTrace() Captures the current thread's stack trace and saves it in thread local storage.
java.lang.Throwable	getCause() Gets the cause from thread local storage that was saved by the last preallocated exception thrown.
static StaticThrowableStorage	getCurrent() A means of obtaining the storage object for the current task and throwable.
StaticThrowable<?>	getLastThrown() Determine for what throwable the data is valid;
java.lang.String	getLocalizedMessage()
java.lang.String	getMessage() Gets the message from thread local storage that was saved by the last preallocated exception thrown.
java.lang.StackTraceElement[]	getStackTrace() Gets the stack trace from thread local storage that was saved by the last preallocated exception thrown.
java.lang.Throwable	initCause(java.lang.Throwable cause) Saves the message in thread local storage for later retrieval.
static StaticThrowableStorage	initCurrent(StaticThrowable<?> throwable) Obtaining the storage object for the current task and initialize it.
StaticThrowableStorage	initMessage(java.lang.String message) Saves the message in thread local storage for later retrieval.
void	printStackTrace()
void	printStackTrace(java.io.PrintStream stream)
void	printStackTrace(java.io.PrintWriter writer)
void	setStackTrace(java.lang.StackTraceElement[] stackTrace)
StaticThrowable	transfer() Transfer the contents of a StaticThrowableStorage to the current thread context.

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

Method Detail

getCurrent

public static StaticThrowableStorage getCurrent()

A means of obtaining the storage object for the current task and throwable.

Returns:

the storage object for the current task.

initCurrent

public static StaticThrowableStorage initCurrent(StaticThrowable<?> throwable)

Obtaining the storage object for the current task and initialize it.

Returns:

the storage object for the current task.

getLastThrown

public StaticThrowable<?> getLastThrown()

Determine for what throwable the data is valid;

Returns:

the current context for the throwable data stored in this object.

fillInStackTrace

public java.lang.Throwable fillInStackTrace()

Captures the current thread's stack trace and saves it in thread local storage. Only the part of the stack trace that fits in the preallocated buffer is stored. This method should be called by a preallocated exception to implement its method of the same name.

Overrides:

fillInStackTrace in class java.lang.Throwable

Returns:

this NYI: UNDER DEVELOPMENT: JAM-5543 Implementation Under Construction --- this should be done on the native side to avoid allocation.

getMessage

public java.lang.String getMessage()

Gets the message from thread local storage that was saved by the last preallocated exception thrown. This method should be called by a preallocated exception to implement its method of the same name.

Overrides:

getMessage in class java.lang.Throwable

Returns:

the message.

initMessage

public StaticThrowableStorage initMessage(java.lang.String message)

Saves the message in thread local storage for later retrieval. Only the part of the message that fits in the preallocated buffer is stored. This method should be called by a preallocated exception to implement its method of the same name.

Parameters:

message - The description to save.

Returns:

this

getCause

public java.lang.Throwable getCause()

Gets the cause from thread local storage that was saved by the last preallocated exception thrown. The actual exception of cause is not saved, but just a reference to its type. This returns a newly allocated exception without any valid content, i.e., no valid stack trace. This method should be called by a preallocated exception to implement its method of the same name.

Overrides:

getCause in class java.lang.Throwable

Returns:

the throwable that caused the condition or null when none was set.

initCause

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

Saves the message in thread local storage for later retrieval. Only a reference to the exception class is stored. The rest of its information is lost. This method should be called by a preallocated exception to implement its method of the same name.

Overrides:

initCause in class java.lang.Throwable

Parameters:

cause - In the case of cascading throwables, the exception or error that was the original cause.

Returns:

this

getStackTrace

public java.lang.StackTraceElement[] getStackTrace()

Gets the stack trace from thread local storage that was saved by the last preallocated exception thrown. This method should be called by a preallocated exception to implement its method of the same name.

Overrides:

getStackTrace in class java.lang.Throwable

Returns:

an array of the elements of the stack trace.

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Overrides:

getLocalizedMessage in class java.lang.Throwable

transfer

public StaticThrowable transfer()

Transfer the contents of a StaticThrowableStorage to the current thread context.

Returns:

the throwable from the old context.

setStackTrace

public void setStackTrace(java.lang.StackTraceElement[] stackTrace)

Overrides:

setStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace()

Overrides:

printStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintStream stream)

Overrides:

printStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintWriter writer)

Overrides:

printStackTrace in class java.lang.Throwable