com.jogamp.newt.util
Interface EDTUtil

public interface EDTUtil

EDT stands for Event Dispatch Thread.

EDTUtil comprises the functionality of:

• Periodically issuing an event dispatch command on the EDT.
• Ability to enqueue tasks, executed on the EDT.
• Controlling the EDT, ie start and stop in a sane manner.

The EDT pattern is a common tool to comply with todays windowing toolkits, where the common denominator in regards to multithreading is to:

• Create a Window on one thread
• Modify the Window within the same thread
• Handle incoming events from within the same thread

Note: This is not true on MacOSX, where all these actions have to be performed by a unique, so called main thread.

Field Summary

static long

defaultEDTPollPeriod

Method Summary

long	getPollPeriod()
void	invoke(boolean wait, Runnable task) Append task to the EDT task queue.
void	invokeStop(Runnable finalTask) Append the final task to the EDT task queue, signals EDT to stop and wait until stopped.
boolean	isCurrentThreadEDT()
boolean	isRunning()
void	reset() Create a new EDT.
void	setPollPeriod(long ms)
void	start() Start the EDT
void	waitUntilIdle() Wait until the EDT task queue is empty.
void	waitUntilStopped() Wait until EDT task is stopped.

Field Detail

defaultEDTPollPeriod

static final long defaultEDTPollPeriod

See Also:

Constant Field Values

Method Detail

getPollPeriod

long getPollPeriod()

Returns:

poll period in milliseconds

setPollPeriod

void setPollPeriod(long ms)

Parameters:

ms - poll period in milliseconds

reset

void reset()

Create a new EDT. One should invoke reset()
after invokeStop(..) in case another start() or invoke(..) is expected.

See Also:

start(), invoke(boolean, java.lang.Runnable), invokeStop(java.lang.Runnable)

start

void start()

Start the EDT

isCurrentThreadEDT

boolean isCurrentThreadEDT()

Returns:

True if the current thread is the EDT thread

isRunning

boolean isRunning()

Returns:

True if EDT is running

invokeStop

void invokeStop(Runnable finalTask)

Append the final task to the EDT task queue, signals EDT to stop and wait until stopped.
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.
• reset() may follow immediately, ie creating a new EDT

invoke

void invoke(boolean wait,
            Runnable task)

Append task to the EDT task queue.
Wait until execution is finished if wait == true.
Shall start the thread if not running.
Can be issued from within EDT, ie from within an enqueued task.

Throws:

RuntimeException - in case EDT is stopped and not reset()

waitUntilIdle

void waitUntilIdle()

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

waitUntilStopped

void waitUntilStopped()

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