javax.realtime

Class ForEachTerminationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

javax.realtime.StaticRuntimeException

javax.realtime.ForEachTerminationException

All Implemented Interfaces:

Serializable, StaticThrowable<ForEachTerminationException>

public class ForEachTerminationException
extends StaticRuntimeException
implements StaticThrowable<ForEachTerminationException>

An exception to throw when a visitor should terminate early. It is for use with the forEach method in collection classes. Since it is a StaticThrowable, it can be used without creating garbage.

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
static ForEachTerminationException	get() Gets the static instance of this class and initializes its stack trace.
ForEachTerminationException	getSingleton() For the case of legacy code that creates an RTSJ exception explicity, this provides a means of obtaining its singleton version.

Methods inherited from class javax.realtime.StaticRuntimeException

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

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

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, init, init, init, init, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, writeReplace

Method Detail

get

public static ForEachTerminationException get()

Gets the static instance of this class and initializes its stack trace.

Returns:

the static singleton of this class.

getSingleton

public ForEachTerminationException 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<ForEachTerminationException>

Returns:

the singleton version of this exception.