Modifier and Type	Class and Description
public static class	InterruptSource.Thread `java.lang.Thread` specialization implementing `InterruptSource` to track `java.lang.Thread#interrupt()` calls.
public static class	InterruptSource.Util

Modifier and Type	Method and Description
public void	clearInterruptSource() Clears source and count of `java.lang.Thread#interrupt()` calls, if any.
public int	getInterruptCounter(final boolean if true, issues `clearInterruptSource()` clear) Returns the count of `java.lang.Thread#interrupt()` calls.
public Throwable	getInterruptSource(final boolean if true, issues `clearInterruptSource()` clear) Returns the source of the last `interrupt()` call.

clearInterruptSource	back to summary
public void clearInterruptSource() Clears source and count of `java.lang.Thread#interrupt()` calls, if any.

getInterruptCounter	back to summary
public int getInterruptCounter(final boolean clear) Returns the count of `java.lang.Thread#interrupt()` calls. Parameters clear:boolean if true, issues `clearInterruptSource()`

getInterruptSource	back to summary
public Throwable getInterruptSource(final boolean clear) Returns the source of the last `interrupt()` call. Parameters clear:boolean if true, issues `clearInterruptSource()`

com.jogamp.common.util back to summary

public Class InterruptSource.Thread

Class Inheritance

extends Thread
implements InterruptSource

java.lang.Object
java.lang.Thread
com.jogamp.common.util.InterruptSource.Thread

All Implemented Interfaces

com.jogamp.common.util.InterruptSource

java.lang.Thread specialization implementing InterruptSource to track java.lang.Thread#interrupt() calls.

Since: 2.3.2

Field Summary

Modifier and Type	Field and Description
pack-priv volatile int	interruptCounter
pack-priv volatile Throwable	interruptSource
pack-priv final Object	sync

Inherited from java.lang.Thread:: MAX_PRIORITY MIN_PRIORITY NORM_PRIORITY

Constructor Summary

Access	Constructor and Description
public	Thread() See `Thread#Thread(` for details.
public	Thread(final ThreadGroup explicit `ThreadGroup`, may be `null` tg, final Runnable explicit `Runnable`, may be `null` target) See `Thread#Thread(ThreadGroup, Runnable)` for details.
public	Thread(final ThreadGroup explicit `ThreadGroup`, may be `null` tg, final Runnable explicit `Runnable`, may be `null` target, final String explicit name of thread, must not be `null` name) See `Thread#Thread(ThreadGroup, Runnable, String)` for details.

Method Summary

Modifier and Type	Method and Description
public final void	clearInterruptSource() Implements com.jogamp.common.util.InterruptSource.clearInterruptSource. Clears source and count of `java.lang.Thread#interrupt()` calls, if any.
public static InterruptSource.Thread	create(final ThreadGroup explicit `ThreadGroup`, may be `null` tg, final Runnable explicit `Runnable`, may be `null` target, final String explicit name of thread, may be `null` name) Depending on whether `name` is null, either `Thread(ThreadGroup, Runnable, String)` or `Thread(ThreadGroup, Runnable)` is being utilized.
public final int	getInterruptCounter(final boolean if true, issues `clearInterruptSource()` clear) Implements com.jogamp.common.util.InterruptSource.getInterruptCounter. Returns the count of `java.lang.Thread#interrupt()` calls.
public final Throwable	getInterruptSource(final boolean if true, issues `clearInterruptSource()` clear) Implements com.jogamp.common.util.InterruptSource.getInterruptSource. Returns the source of the last `interrupt()` call.
public final void	interrupt() Overrides java.lang.Thread.interrupt. Interrupts this thread.

Field Detail

interruptCounter	back to summary
pack-priv volatile int interruptCounter

interruptSource	back to summary
pack-priv volatile Throwable interruptSource

sync	back to summary
pack-priv final Object sync

Constructor Detail

Thread	back to summary
public Thread() See `Thread#Thread(` for details.

Thread back to summary

Thread	back to summary
public Thread(final ThreadGroup tg, final Runnable target) See `Thread#Thread(ThreadGroup, Runnable)` for details. Parameters tg:ThreadGroup explicit `ThreadGroup`, may be `null` target:Runnable explicit `Runnable`, may be `null`

public Thread(final ThreadGroup tg, final Runnable target)

See Thread#Thread(ThreadGroup, Runnable) for details.

Parameters

tg:ThreadGroup: explicit ThreadGroup, may be null
target:Runnable: explicit Runnable, may be null

Thread back to summary

Thread	back to summary
public Thread(final ThreadGroup tg, final Runnable target, final String name) See `Thread#Thread(ThreadGroup, Runnable, String)` for details. Parameters tg:ThreadGroup explicit `ThreadGroup`, may be `null` target:Runnable explicit `Runnable`, may be `null` name:String explicit name of thread, must not be `null`

public Thread(final ThreadGroup tg, final Runnable target, final String name)

See Thread#Thread(ThreadGroup, Runnable, String) for details.

Parameters

tg:ThreadGroup: explicit ThreadGroup, may be null
target:Runnable: explicit Runnable, may be null
name:String: explicit name of thread, must not be null

Method Detail

clearInterruptSource back to summary

clearInterruptSource	back to summary
public final void clearInterruptSource() Implements com.jogamp.common.util.InterruptSource.clearInterruptSource. Doc from com.jogamp.common.util.InterruptSource.clearInterruptSource. Clears source and count of `java.lang.Thread#interrupt()` calls, if any. Annotations @Override

public final void clearInterruptSource()

Implements com.jogamp.common.util.InterruptSource.clearInterruptSource.

Doc from com.jogamp.common.util.InterruptSource.clearInterruptSource.

Clears source and count of java.lang.Thread#interrupt() calls, if any.

Annotations

@Override

create back to summary

create	back to summary
public static InterruptSource.Thread create(final ThreadGroup tg, final Runnable target, final String name) Depending on whether `name` is null, either `Thread(ThreadGroup, Runnable, String)` or `Thread(ThreadGroup, Runnable)` is being utilized. Parameters tg:ThreadGroup explicit `ThreadGroup`, may be `null` target:Runnable explicit `Runnable`, may be `null` name:String explicit name of thread, may be `null`

public static InterruptSource.Thread create(final ThreadGroup tg, final Runnable target, final String name)

Depending on whether name is null, either Thread(ThreadGroup, Runnable, String) or Thread(ThreadGroup, Runnable) is being utilized.

Parameters

tg:ThreadGroup: explicit ThreadGroup, may be null
target:Runnable: explicit Runnable, may be null
name:String: explicit name of thread, may be null

getInterruptCounter back to summary

getInterruptCounter	back to summary
public final int getInterruptCounter(final boolean clear) Implements com.jogamp.common.util.InterruptSource.getInterruptCounter. Doc from com.jogamp.common.util.InterruptSource.getInterruptCounter. Returns the count of `java.lang.Thread#interrupt()` calls. Parameters clear:boolean if true, issues `clearInterruptSource()` Annotations @Override

public final int getInterruptCounter(final boolean clear)

Implements com.jogamp.common.util.InterruptSource.getInterruptCounter.

Doc from com.jogamp.common.util.InterruptSource.getInterruptCounter.

Returns the count of java.lang.Thread#interrupt() calls.

Parameters

clear:boolean: if true, issues clearInterruptSource()

Annotations

@Override

getInterruptSource back to summary

getInterruptSource	back to summary
public final Throwable getInterruptSource(final boolean clear) Implements com.jogamp.common.util.InterruptSource.getInterruptSource. Doc from com.jogamp.common.util.InterruptSource.getInterruptSource. Returns the source of the last `interrupt()` call. Parameters clear:boolean if true, issues `clearInterruptSource()` Annotations @Override

public final Throwable getInterruptSource(final boolean clear)

Implements com.jogamp.common.util.InterruptSource.getInterruptSource.

Doc from com.jogamp.common.util.InterruptSource.getInterruptSource.

Returns the source of the last interrupt() call.

Parameters

clear:boolean: if true, issues clearInterruptSource()

Annotations

@Override

interrupt back to summary

interrupt	back to summary
public final void interrupt() Overrides java.lang.Thread.interrupt. Doc from java.lang.Thread.interrupt. Interrupts this thread. Unless the current thread is interrupting itself, which is always permitted, the `checkAccess` method of this thread is invoked, which may cause a `SecurityException` to be thrown. If this thread is blocked in an invocation of the `wait()`, `wait(long)`, or `wait(long, int)` methods of the `Object` class, or of the `join()`, `join(long)`, `join(long, int)`, `sleep(long)`, or `sleep(long, int)` methods of this class, then its interrupt status will be cleared and it will receive an `InterruptedException`. If this thread is blocked in an I/O operation upon an `InterruptibleChannel` then the channel will be closed, the thread's interrupt status will be set, and the thread will receive a `java.nio.channels.ClosedByInterruptException`. If this thread is blocked in a `java.nio.channels.Selector` then the thread's interrupt status will be set and it will return immediately from the selection operation, possibly with a non-zero value, just as if the selector's `wakeup` method were invoked. If none of the previous conditions hold then this thread's interrupt status will be set. Interrupting a thread that is not alive need not have any effect. Annotations @Override

public final void interrupt()

Overrides java.lang.Thread.interrupt.

Doc from java.lang.Thread.interrupt.

Interrupts this thread.

Unless the current thread is interrupting itself, which is always permitted, the checkAccess method of this thread is invoked, which may cause a SecurityException to be thrown.

If this thread is blocked in an invocation of the wait(), wait(long), or wait(long, int) methods of the Object class, or of the join(), join(long), join(long, int), sleep(long), or sleep(long, int) methods of this class, then its interrupt status will be cleared and it will receive an InterruptedException.

If this thread is blocked in an I/O operation upon an InterruptibleChannel then the channel will be closed, the thread's interrupt status will be set, and the thread will receive a java.nio.channels.ClosedByInterruptException.

If this thread is blocked in a java.nio.channels.Selector then the thread's interrupt status will be set and it will return immediately from the selection operation, possibly with a non-zero value, just as if the selector's wakeup method were invoked.

If none of the previous conditions hold then this thread's interrupt status will be set.

Interrupting a thread that is not alive need not have any effect.

Annotations

@Override

public Interface InterruptSource

Nested and Inner Type Summary

Method Summary

Method Detail

public Class InterruptSource.Thread

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class InterruptSource.Util

Constructor Summary

Method Summary

Constructor Detail

Method Detail

Modifier and Type	Method and Description
public static InterruptSource	currentThread() Casts current `java.lang.Thread` to `InterruptSource` if applicable, otherwise returns `null`.
public static InterruptSource	get(final Thread t) Casts given `java.lang.Thread` to `InterruptSource` if applicable, otherwise returns `null`.