GlueGen v2.6.0-rc-20250712
GlueGen, Native Binding Generator for Java™ (public API).
com.jogamp.common.util.SourcedInterruptedException Class Reference

InterruptedException, which may include the source, see getInterruptSource(). More...

Inheritance diagram for com.jogamp.common.util.SourcedInterruptedException:
Collaboration diagram for com.jogamp.common.util.SourcedInterruptedException:

Public Member Functions

 SourcedInterruptedException (final String message, final InterruptedException cause, final Throwable interruptSource)
 
 SourcedInterruptedException (final InterruptedException cause, final Throwable interruptSource)
 
final Throwable getInterruptSource ()
 Returns the source of the Thread#interrupt() call if known, otherwise null is returned. More...
 
InterruptedException getCause ()
 Returns the propagated InterruptedException, i.e. More...
 
String toString ()
 
final void printCauseStack (final PrintStream s, final String causeStr, final int causeIdx, final int stackDepth)
 Prints this Throwable as a cause to the output PrintStream s, not iterating over all inner causes! More...
 
final void printStackTrace (final PrintStream s, final int causeDepth, final int stackDepth)
 Custom printStackTrace method, similar to Throwable#printStackTrace(PrintStream, int, int). More...
 
void printCauseStack (final PrintStream s, final String causeStr, final int causeIdx, final int stackDepth)
 Prints this Throwable as a cause to the output PrintStream s, not iterating over all inner causes! More...
 
void printStackTrace (final PrintStream s, final int causeDepth, final int stackDepth)
 Custom printStackTrace method, similar to Throwable#printStackTrace(PrintStream, int, int). More...
 

Static Public Member Functions

static InterruptedException wrap (final InterruptedException ie)
 Wraps the given InterruptedException into a SourcedInterruptedException if it is not yet of the desired type and if the current thread if a InterruptSource, i.e. More...
 
static InterruptedException wrap (final InterruptedException ie, final InterruptSource source)
 Wraps the given InterruptedException into a SourcedInterruptedException if it is not yet of the same type and if source is not null. More...
 

Detailed Description

InterruptedException, which may include the source, see getInterruptSource().

This exception may be created directly where getCause() returns null, or by propagating an existing InterruptedException as returned by getCause().

Since
2.3.2

Definition at line 45 of file SourcedInterruptedException.java.

Constructor & Destructor Documentation

◆ SourcedInterruptedException() [1/2]

com.jogamp.common.util.SourcedInterruptedException.SourcedInterruptedException ( final String  message,
final InterruptedException  cause,
final Throwable  interruptSource 
)
Parameters
messagemandatory message of this exception
causeoptional propagated cause
interruptSourceoptional propagated source of Thread#interrupt() call

Definition at line 93 of file SourcedInterruptedException.java.

◆ SourcedInterruptedException() [2/2]

com.jogamp.common.util.SourcedInterruptedException.SourcedInterruptedException ( final InterruptedException  cause,
final Throwable  interruptSource 
)
Parameters
causemandatory propagated cause
interruptSourceoptional propagated source of Thread#interrupt() call

Definition at line 105 of file SourcedInterruptedException.java.

Member Function Documentation

◆ getCause()

InterruptedException com.jogamp.common.util.SourcedInterruptedException.getCause ( )

Returns the propagated InterruptedException, i.e.

the cause of this exception, or null if not applicable.

Definition at line 127 of file SourcedInterruptedException.java.

◆ getInterruptSource()

final Throwable com.jogamp.common.util.SourcedInterruptedException.getInterruptSource ( )

Returns the source of the Thread#interrupt() call if known, otherwise null is returned.

Definition at line 115 of file SourcedInterruptedException.java.

◆ printCauseStack()

final void com.jogamp.common.util.SourcedInterruptedException.printCauseStack ( final PrintStream  s,
final String  causeStr,
final int  causeIdx,
final int  stackDepth 
)

Prints this Throwable as a cause to the output PrintStream s, not iterating over all inner causes!

Parameters
soutput stream
causeStrthe cause title
causeIdxthe cause index over all causes known by caller
stackDepththe maximum depth for stack entries, or -1 for all
Since
2.3.2

Implements com.jogamp.common.ExceptionUtils.CustomStackTrace.

Definition at line 148 of file SourcedInterruptedException.java.

Here is the call graph for this function:

◆ printStackTrace()

final void com.jogamp.common.util.SourcedInterruptedException.printStackTrace ( final PrintStream  s,
final int  causeDepth,
final int  stackDepth 
)

Custom printStackTrace method, similar to Throwable#printStackTrace(PrintStream, int, int).

Parameters
soutput stream
causeDepththe maximum depth for causes, or -1 for all
stackDepththe maximum depth for stack entries, or -1 for all

Implements com.jogamp.common.ExceptionUtils.CustomStackTrace.

Definition at line 158 of file SourcedInterruptedException.java.

Here is the call graph for this function:

◆ toString()

String com.jogamp.common.util.SourcedInterruptedException.toString ( )

Definition at line 132 of file SourcedInterruptedException.java.

◆ wrap() [1/2]

static InterruptedException com.jogamp.common.util.SourcedInterruptedException.wrap ( final InterruptedException  ie)
static

Wraps the given InterruptedException into a SourcedInterruptedException if it is not yet of the desired type and if the current thread if a InterruptSource, i.e.

the source is known.

Otherwise the given InterruptedException instance is returned.

In case method is creating a new wrapping instance, InterruptSource#clearInterruptSource() is being issued.

Parameters
iethe to be wrapped InterruptedException

Definition at line 62 of file SourcedInterruptedException.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ wrap() [2/2]

static InterruptedException com.jogamp.common.util.SourcedInterruptedException.wrap ( final InterruptedException  ie,
final InterruptSource  source 
)
static

Wraps the given InterruptedException into a SourcedInterruptedException if it is not yet of the same type and if source is not null.

Otherwise the given InterruptedException instance is returned.

In case method is creating a new wrapping instance, InterruptSource#clearInterruptSource() is being issued.

Parameters
iethe to be wrapped InterruptedException
sourcethe InterruptSource

Definition at line 80 of file SourcedInterruptedException.java.

Here is the call graph for this function:

The documentation for this class was generated from the following file: