Modifier and Type	Class and Description
pack-priv class	DefaultEDTUtil.NEDT

Modifier and Type	Field and Description
public static final boolean	DEBUG
private final Runnable	dispatchMessages
private DefaultEDTUtil.NEDT	edt
private final Object	edtLock
private final String	name
private static Runnable	nullTask
private static long	pollPeriod
private int	start_iter
private static final Object	TASK_ATTACHMENT_STOP Used to implement `invokeStop(boolean, Runnable)`.
private static final Object	TASK_ATTACHMENT_TEST_ERROR Used to provoke an exception on the EDT while waiting / blocking.
private ThreadGroup	threadGroup

Access	Constructor and Description
public	DefaultEDTUtil(final ThreadGroup tg, final String name, final Runnable dispatchMessages)

Method Summary

Modifier and Type	Method and Description
public final long	getPollPeriod() Implements com.jogamp.newt.util.EDTUtil.getPollPeriod.
public final boolean	invoke(final boolean wait, final Runnable task) Implements com.jogamp.newt.util.EDTUtil.invoke. Appends task to the EDT task queue if current thread is not EDT, otherwise execute task immediately.
public final boolean	invokeAndWaitError(final Runnable task)
private final boolean	invokeImpl(boolean wait, Runnable task, final boolean stop, final boolean provokeError)
public final boolean	invokeStop(final boolean wait, final Runnable task) Implements com.jogamp.newt.util.EDTUtil.invokeStop. Append the final task to the EDT task queue, signals EDT to stop.
public final boolean	isCurrentThreadEDT() Implements com.jogamp.newt.util.EDTUtil.isCurrentThreadEDT. Returns true if the current thread is the event dispatch thread (EDT).
public final boolean	isCurrentThreadEDTorNEDT() Implements com.jogamp.newt.util.EDTUtil.isCurrentThreadEDTorNEDT. Returns `true` if either `isCurrentThreadEDT()` or `isCurrentThreadNEDT()` is `true`, otherwise `false`.
public final boolean	isCurrentThreadNEDT() Implements com.jogamp.newt.util.EDTUtil.isCurrentThreadNEDT. Returns true if the current thread is the internal NEWT event dequeue thread (NEDT).
public final boolean	isRunning() Implements com.jogamp.newt.util.EDTUtil.isRunning.
public final void	setPollPeriod(final long poll period in milliseconds ms) Implements com.jogamp.newt.util.EDTUtil.setPollPeriod.
public final void	start() Implements com.jogamp.newt.util.EDTUtil.start. Starts the EDT after it's creation or after `stopping`.
private final void	startImpl()
public final boolean	waitUntilIdle() Implements com.jogamp.newt.util.EDTUtil.waitUntilIdle. Wait until the EDT task queue is empty.
public final boolean	waitUntilStopped() Implements com.jogamp.newt.util.EDTUtil.waitUntilStopped. Wait until EDT task is stopped.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DEBUG	back to summary
public static final boolean DEBUG

dispatchMessages	back to summary
private final Runnable dispatchMessages

edt	back to summary
private DefaultEDTUtil.NEDT edt

edtLock	back to summary
private final Object edtLock

name	back to summary
private final String name

nullTask	back to summary
private static Runnable nullTask

pollPeriod	back to summary
private static long pollPeriod

start_iter	back to summary
private int start_iter

TASK_ATTACHMENT_STOP	back to summary
private static final Object TASK_ATTACHMENT_STOP Used to implement `invokeStop(boolean, Runnable)`.

TASK_ATTACHMENT_TEST_ERROR	back to summary
private static final Object TASK_ATTACHMENT_TEST_ERROR Used to provoke an exception on the EDT while waiting / blocking. Merely exists to test code.

threadGroup	back to summary
private ThreadGroup threadGroup

Constructor Detail

DefaultEDTUtil	back to summary
public DefaultEDTUtil(final ThreadGroup tg, final String name, final Runnable dispatchMessages)

Method Detail

getPollPeriod	back to summary
public final long getPollPeriod() Implements com.jogamp.newt.util.EDTUtil.getPollPeriod. Returns:long Doc from com.jogamp.newt.util.EDTUtil.getPollPeriod. poll period in milliseconds Annotations @Override

getPollPeriod

back to summary

public final long getPollPeriod()

Implements com.jogamp.newt.util.EDTUtil.getPollPeriod.

Returns:long

Doc from com.jogamp.newt.util.EDTUtil.getPollPeriod.

poll period in milliseconds

Annotations

@Override

invoke back to summary

invoke	back to summary
public final boolean invoke(final boolean wait, final Runnable task) Implements com.jogamp.newt.util.EDTUtil.invoke. Doc from com.jogamp.newt.util.EDTUtil.invoke. Appends task to the EDT task queue if current thread is not EDT, otherwise execute task immediately. Wait until execution is finished if `wait == true`. Can be issued from within EDT, ie from within an enqueued task. Returns:boolean true if `task` has been executed or queued for later execution, otherwise false Annotations @Override

public final boolean invoke(final boolean wait, final Runnable task)

Implements com.jogamp.newt.util.EDTUtil.invoke.

Doc from com.jogamp.newt.util.EDTUtil.invoke.

Appends task to the EDT task queue if current thread is not EDT, otherwise execute task immediately.

Wait until execution is finished if wait == true.

Can be issued from within EDT, ie from within an enqueued task.

Returns:boolean

true if task has been executed or queued for later execution, otherwise false

Annotations

@Override

invokeAndWaitError	back to summary
public final boolean invokeAndWaitError(final Runnable task)

invokeImpl	back to summary
private final boolean invokeImpl(boolean wait, Runnable task, final boolean stop, final boolean provokeError)

invokeStop back to summary

invokeStop	back to summary
public final boolean invokeStop(final boolean wait, final Runnable task) Implements com.jogamp.newt.util.EDTUtil.invokeStop. Doc from com.jogamp.newt.util.EDTUtil.invokeStop. Append the final task to the EDT task queue, signals EDT to stop. If `wait` is `true` methods blocks until EDT is stopped. `task` maybe `null` Due to the nature of this method: All previous queued tasks will be finished. No new tasks are allowed, an Exception is thrown. Can be issued from within EDT, ie from within an enqueued task. `start()` may follow immediately, ie creating a new EDT Returns:boolean true if `task` has been executed or queued for later execution, otherwise false Annotations @Override

public final boolean invokeStop(final boolean wait, final Runnable task)

Implements com.jogamp.newt.util.EDTUtil.invokeStop.

Doc from com.jogamp.newt.util.EDTUtil.invokeStop.

Append the final task to the EDT task queue, signals EDT to stop.

If wait is true methods blocks until EDT is stopped.

task maybe null
Due to the nature of this method:

All previous queued tasks will be finished.
No new tasks are allowed, an Exception is thrown.
Can be issued from within EDT, ie from within an enqueued task.
start() may follow immediately, ie creating a new EDT

Returns:boolean

true if task has been executed or queued for later execution, otherwise false

Annotations

@Override

isCurrentThreadEDT back to summary

isCurrentThreadEDT	back to summary
public final boolean isCurrentThreadEDT() Implements com.jogamp.newt.util.EDTUtil.isCurrentThreadEDT. Doc from com.jogamp.newt.util.EDTUtil.isCurrentThreadEDT. Returns true if the current thread is the event dispatch thread (EDT). The EDT is the platform specific thread dispatching toolkit-events and executing toolkit-tasks enqueued via `invoke(boolean, Runnable)`. Usually it is the same thread as used to dequeue informal `NEWTEvent`s (NEDT), see `isCurrentThreadNEDT()`, however, this may differ, e.g. SWT and AWT implementation. Annotations @Override

public final boolean isCurrentThreadEDT()

Implements com.jogamp.newt.util.EDTUtil.isCurrentThreadEDT.

Doc from com.jogamp.newt.util.EDTUtil.isCurrentThreadEDT.

Returns true if the current thread is the event dispatch thread (EDT).

The EDT is the platform specific thread dispatching toolkit-events and executing toolkit-tasks enqueued via invoke(boolean, Runnable).

Usually it is the same thread as used to dequeue informal NEWTEvents (NEDT), see isCurrentThreadNEDT(), however, this may differ, e.g. SWT and AWT implementation.

Annotations

@Override

isCurrentThreadEDTorNEDT back to summary

isCurrentThreadEDTorNEDT	back to summary
public final boolean isCurrentThreadEDTorNEDT() Implements com.jogamp.newt.util.EDTUtil.isCurrentThreadEDTorNEDT. Doc from com.jogamp.newt.util.EDTUtil.isCurrentThreadEDTorNEDT. Returns `true` if either `isCurrentThreadEDT()` or `isCurrentThreadNEDT()` is `true`, otherwise `false`. Annotations @Override

public final boolean isCurrentThreadEDTorNEDT()

Implements com.jogamp.newt.util.EDTUtil.isCurrentThreadEDTorNEDT.

Doc from com.jogamp.newt.util.EDTUtil.isCurrentThreadEDTorNEDT.

Returns true if either isCurrentThreadEDT() or isCurrentThreadNEDT() is true, otherwise false.

Annotations

@Override

isCurrentThreadNEDT back to summary

isCurrentThreadNEDT	back to summary
public final boolean isCurrentThreadNEDT() Implements com.jogamp.newt.util.EDTUtil.isCurrentThreadNEDT. Doc from com.jogamp.newt.util.EDTUtil.isCurrentThreadNEDT. Returns true if the current thread is the internal NEWT event dequeue thread (NEDT). The NEDT is the NEWT thread used to dequeue informal `NEWTEvent`s enqueued internally via `DisplayImpl#enqueueEvent(boolean, NEWTEvent)`. Usually it is the same thread as the EDT, see `isCurrentThreadEDT()`, however, this may differ, e.g. SWT and AWT implementation. Annotations @Override

public final boolean isCurrentThreadNEDT()

Implements com.jogamp.newt.util.EDTUtil.isCurrentThreadNEDT.

Doc from com.jogamp.newt.util.EDTUtil.isCurrentThreadNEDT.

Returns true if the current thread is the internal NEWT event dequeue thread (NEDT).

The NEDT is the NEWT thread used to dequeue informal NEWTEvents enqueued internally via DisplayImpl#enqueueEvent(boolean, NEWTEvent).

Usually it is the same thread as the EDT, see isCurrentThreadEDT(), however, this may differ, e.g. SWT and AWT implementation.

Annotations

@Override

isRunning	back to summary
public final boolean isRunning() Implements com.jogamp.newt.util.EDTUtil.isRunning. Returns:boolean Doc from com.jogamp.newt.util.EDTUtil.isRunning. True if EDT is running and not subject to be stopped. Annotations @Override

isRunning

back to summary

public final boolean isRunning()

Implements com.jogamp.newt.util.EDTUtil.isRunning.

Returns:boolean

Doc from com.jogamp.newt.util.EDTUtil.isRunning.

True if EDT is running and not subject to be stopped.

Annotations

@Override

setPollPeriod	back to summary
public final void setPollPeriod(final long ms) Implements com.jogamp.newt.util.EDTUtil.setPollPeriod. Parameters ms:long Doc from com.jogamp.newt.util.EDTUtil.setPollPeriod. poll period in milliseconds Annotations @Override

setPollPeriod

back to summary

public final void setPollPeriod(final long ms)

Implements com.jogamp.newt.util.EDTUtil.setPollPeriod.

Parameters

ms:long

Doc from com.jogamp.newt.util.EDTUtil.setPollPeriod.

poll period in milliseconds

Annotations

@Override

start back to summary

start	back to summary
public final void start() throws IllegalStateException Implements com.jogamp.newt.util.EDTUtil.start. Doc from com.jogamp.newt.util.EDTUtil.start. Starts the EDT after it's creation or after `stopping`. If the EDT is running, it must be `stopped` first and the caller should wait `until it's stopped`. Annotations @Override Exceptions IllegalStateException: if EDT is running and not subject to be stopped, i.e. `isRunning()` returns true

public final void start() throws IllegalStateException

Implements com.jogamp.newt.util.EDTUtil.start.

Doc from com.jogamp.newt.util.EDTUtil.start.

Starts the EDT after it's creation or after stopping.

If the EDT is running, it must be stopped first and the caller should wait until it's stopped.

Annotations

@Override

Exceptions

IllegalStateException:: if EDT is running and not subject to be stopped, i.e. isRunning() returns true

startImpl	back to summary
private final void startImpl()

waitUntilIdle	back to summary
public final boolean waitUntilIdle() Implements com.jogamp.newt.util.EDTUtil.waitUntilIdle. Doc from com.jogamp.newt.util.EDTUtil.waitUntilIdle. Wait until the EDT task queue is empty. The last task may still be in execution when this method returns. Returns:boolean true if waited for idle, otherwise false, i.e. in case of current thread is EDT or NEDT Annotations @Override

waitUntilIdle

back to summary

public final boolean waitUntilIdle()

Implements com.jogamp.newt.util.EDTUtil.waitUntilIdle.

Doc from com.jogamp.newt.util.EDTUtil.waitUntilIdle.

Wait until the EDT task queue is empty.
The last task may still be in execution when this method returns.

Returns:boolean

true if waited for idle, otherwise false, i.e. in case of current thread is EDT or NEDT

Annotations

@Override

waitUntilStopped back to summary

waitUntilStopped	back to summary
public final boolean waitUntilStopped() Implements com.jogamp.newt.util.EDTUtil.waitUntilStopped. Doc from com.jogamp.newt.util.EDTUtil.waitUntilStopped. Wait until EDT task is stopped. No `stop` action is performed, `invokeStop(boolean, java.lang.Runnable)` should be used before. If caller thread is EDT or NEDT, this call will not block. Returns:boolean true if stopped, otherwise false, i.e. in case of current thread is EDT or NEDT Annotations @Override

public final boolean waitUntilStopped()

Implements com.jogamp.newt.util.EDTUtil.waitUntilStopped.

Doc from com.jogamp.newt.util.EDTUtil.waitUntilStopped.

Wait until EDT task is stopped.
No stop action is performed, invokeStop(boolean, java.lang.Runnable) should be used before.

If caller thread is EDT or NEDT, this call will not block.

Returns:boolean

true if stopped, otherwise false, i.e. in case of current thread is EDT or NEDT

Annotations

@Override

jogamp.newt back to summary

pack-priv Class DefaultEDTUtil.NEDT

Class Inheritance

extends Thread

java.lang.Object
java.lang.Thread
com.jogamp.common.util.InterruptSource.Thread
jogamp.newt.DefaultEDTUtil.NEDT

Field Summary

Modifier and Type	Field and Description
pack-priv volatile boolean	isRunning
pack-priv volatile boolean	shouldStop
pack-priv final ArrayList<RunnableTask>	tasks

Constructor Summary

Access	Constructor and Description
public	NEDT(final ThreadGroup tg, final String name)

Method Summary

Modifier and Type	Method and Description
public final boolean	isRunning()
public final void	run() Overrides java.lang.Thread.run. Implements java.lang.Runnable.run. Utilizing locking only on tasks and its execution, not for event dispatching.
public final void	start() Overrides java.lang.Thread.start. Schedules this thread to begin execution.
private final void	validateNoRecursiveLocksHold()

Inherited from com.jogamp.common.util.InterruptSource.Thread:: clearInterruptSource create getInterruptCounter getInterruptSource interrupt

Field Detail

isRunning	back to summary
pack-priv volatile boolean isRunning

shouldStop	back to summary
pack-priv volatile boolean shouldStop

tasks	back to summary
pack-priv final ArrayList<RunnableTask> tasks

Constructor Detail

NEDT	back to summary
public NEDT(final ThreadGroup tg, final String name)

Method Detail

isRunning	back to summary
public final boolean isRunning()

run	back to summary
public final void run() Overrides java.lang.Thread.run. Implements java.lang.Runnable.run. Utilizing locking only on tasks and its execution, not for event dispatching. Annotations @Override

run

back to summary

public final void run()

Overrides java.lang.Thread.run.

Implements java.lang.Runnable.run.

Utilizing locking only on tasks and its execution, not for event dispatching.

Annotations

@Override

start	back to summary
public final void start() throws IllegalThreadStateException Overrides java.lang.Thread.start. Doc from java.lang.Thread.start. Schedules this thread to begin execution. The thread will execute independently of the current thread. A thread can be started at most once. In particular, a thread can not be restarted after it has terminated. Annotations @Override Exceptions IllegalThreadStateException: if the thread was already started

start

back to summary

public final void start() throws IllegalThreadStateException

Overrides java.lang.Thread.start.

Doc from java.lang.Thread.start.

Schedules this thread to begin execution. The thread will execute independently of the current thread.

A thread can be started at most once. In particular, a thread can not be restarted after it has terminated.

Annotations

@Override

Exceptions

IllegalThreadStateException:: if the thread was already started

validateNoRecursiveLocksHold	back to summary
private final void validateNoRecursiveLocksHold()

public Class DefaultEDTUtil

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class DefaultEDTUtil.NEDT

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail