com.jogamp.common.util.SourcedInterruptedException

All Implemented Interfaces:: ExceptionUtils.CustomStackTrace, Serializable

public class SourcedInterruptedException extends InterruptedException implements ExceptionUtils.CustomStackTrace

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor

Description

SourcedInterruptedException(InterruptedException cause, Throwable interruptSource)

SourcedInterruptedException(String message, InterruptedException cause, Throwable interruptSource)
Method Summary

Modifier and Type

Method

Description

InterruptedException

getCause()

Returns the propagated InterruptedException, i.e.

final Throwable

getInterruptSource()

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

final void

printCauseStack(PrintStream s, String causeStr, int causeIdx, int stackDepth)

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

final void

printStackTrace(PrintStream s, int causeDepth, int stackDepth)

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

String

toString()

static InterruptedException

wrap(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.

static InterruptedException

wrap(InterruptedException ie, InterruptSource source)

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

Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- SourcedInterruptedException
  
  public SourcedInterruptedException(String message, InterruptedException cause, Throwable interruptSource)
  
  Parameters:
  
  message - mandatory message of this exception
  
  cause - optional propagated cause
  
  interruptSource - optional propagated source of Thread.interrupt() call
- SourcedInterruptedException
  
  public SourcedInterruptedException(InterruptedException cause, Throwable interruptSource)
  
  Parameters:
  
  cause - mandatory propagated cause
  
  interruptSource - optional propagated source of Thread.interrupt() call
Method Details
- wrap
  
  public static InterruptedException wrap(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. 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:
  
  ie - the to be wrapped InterruptedException
- wrap
  
  public static InterruptedException wrap(InterruptedException ie, InterruptSource source)
  
  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:
  
  ie - the to be wrapped InterruptedException
  
  source - the InterruptSource
- getInterruptSource
  
  public final Throwable getInterruptSource()
  
  Returns the source of the Thread.interrupt() call if known, otherwise null is returned.
- getCause
  
  public InterruptedException getCause()
  
  Returns the propagated InterruptedException, i.e. the cause of this exception, or null if not applicable.
  
  Overrides:
  
  getCause in class Throwable
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Throwable
- printCauseStack
  
  public final void printCauseStack(PrintStream s, String causeStr, int causeIdx, int stackDepth)
  
  Description copied from interface: ExceptionUtils.CustomStackTrace
  
  Prints this Throwable as a cause to the output PrintStream s, not iterating over all inner causes!
  
  Specified by:
  
  printCauseStack in interface ExceptionUtils.CustomStackTrace
  
  Parameters:
  
  s - output stream
  
  causeStr - the cause title
  
  causeIdx - the cause index over all causes known by caller
  
  stackDepth - the maximum depth for stack entries, or -1 for all
- printStackTrace
  
  public final void printStackTrace(PrintStream s, int causeDepth, int stackDepth)
  
  Description copied from interface: ExceptionUtils.CustomStackTrace
  
  Custom printStackTrace method, similar to Throwable#printStackTrace(PrintStream, int, int).
  
  Specified by:
  
  printStackTrace in interface ExceptionUtils.CustomStackTrace
  
  Parameters:
  
  s - output stream
  
  causeDepth - the maximum depth for causes, or -1 for all
  
  stackDepth - the maximum depth for stack entries, or -1 for all

Class SourcedInterruptedException

Constructor Summary

Method Summary

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Constructor Details

SourcedInterruptedException

SourcedInterruptedException

Method Details

wrap

wrap

getInterruptSource

getCause

toString

printCauseStack

printStackTrace