JOGL 2.3.2 · com.jogamp.newt.util.EDTUtil

Modifier and Type	Field and Description
public static final long	defaultEDTPollPeriod

Method Summary

Modifier and Type	Method and Description
public long	Returns: poll period in milliseconds getPollPeriod()
public boolean	Returns: true if `task` has been executed or queued for later execution, otherwise false invoke(boolean wait, Runnable task) Appends task to the EDT task queue if current thread is not EDT, otherwise execute task immediately.
public boolean	Returns: true if `task` has been executed or queued for later execution, otherwise false invokeStop(boolean wait, Runnable finalTask) Append the final task to the EDT task queue, signals EDT to stop.
public boolean	isCurrentThreadEDT() Returns true if the current thread is the event dispatch thread (EDT).
public boolean	isCurrentThreadEDTorNEDT() Returns `true` if either `isCurrentThreadEDT()` or `isCurrentThreadNEDT()` is `true`, otherwise `false`.
public boolean	isCurrentThreadNEDT() Returns true if the current thread is the internal NEWT event dequeue thread (NEDT).
public boolean	Returns: True if EDT is running and not subject to be stopped. isRunning()
public void	setPollPeriod(long poll period in milliseconds ms)
public void	start() Starts the EDT after it's creation or after `stopping`.
public boolean	Returns: true if waited for idle, otherwise false, i.e. in case of current thread is EDT or NEDT waitUntilIdle() Wait until the EDT task queue is empty.
public boolean	Returns: true if stopped, otherwise false, i.e. in case of current thread is EDT or NEDT waitUntilStopped() Wait until EDT task is stopped.

defaultEDTPollPeriod	back to summary
public static final long defaultEDTPollPeriod

Method Detail

getPollPeriod	back to summary
public long getPollPeriod() Returns:long poll period in milliseconds

invoke back to summary

invoke	back to summary
public boolean invoke(boolean wait, Runnable task) 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

public boolean invoke(boolean wait, Runnable task)

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

invokeStop back to summary

invokeStop	back to summary
public boolean invokeStop(boolean wait, Runnable finalTask) 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

public boolean invokeStop(boolean wait, Runnable finalTask)

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

isCurrentThreadEDT back to summary

isCurrentThreadEDT	back to summary
public boolean 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.

public boolean 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.

isCurrentThreadEDTorNEDT	back to summary
public boolean isCurrentThreadEDTorNEDT() Returns `true` if either `isCurrentThreadEDT()` or `isCurrentThreadNEDT()` is `true`, otherwise `false`.

isCurrentThreadNEDT back to summary

isCurrentThreadNEDT	back to summary
public boolean 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.

public boolean 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.

isRunning	back to summary
public boolean isRunning() Returns:boolean True if EDT is running and not subject to be stopped.

setPollPeriod	back to summary
public void setPollPeriod(long ms) Parameters ms:long poll period in milliseconds

start back to summary

start	back to summary
public void start() throws IllegalStateException 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`. Exceptions IllegalStateException: if EDT is running and not subject to be stopped, i.e. `isRunning()` returns true RuntimeException: if EDT could not be started See Also `invokeStop(boolean, java.lang.Runnable)`, `waitUntilStopped()`

public void start() throws IllegalStateException

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.

Exceptions

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

waitUntilIdle	back to summary
public boolean 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

waitUntilIdle

back to summary

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

waitUntilStopped back to summary

waitUntilStopped	back to summary
public boolean 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

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

public Interface EDTUtil

Field Summary

Method Summary

Field Detail

Method Detail