Interface SecondaryLoop
-
public interface SecondaryLoopA helper interface to run the nested event loop.Objects that implement this interface are created with the
EventQueue.createSecondaryLoop()method. The interface provides two methods,enter()andexit(), which can be used to start and stop the event loop.When the
enter()method is called, the current thread is blocked until the loop is terminated by theexit()method. Also, a new event loop is started on the event dispatch thread, which may or may not be the current thread. The loop can be terminated on any thread by calling itsexit()method. After the loop is terminated, theSecondaryLoopobject can be reused to run a new nested event loop.A typical use case of applying this interface is AWT and Swing modal dialogs. When a modal dialog is shown on the event dispatch thread, it enters a new secondary loop. Later, when the dialog is hidden or disposed, it exits the loop, and the thread continues its execution.
The following example illustrates a simple use case of secondary loops:
SecondaryLoop loop; JButton jButton = new JButton("Button"); jButton.addActionListener(new ActionListener() {@Overridepublic void actionPerformed(ActionEvent e) { Toolkit tk = Toolkit.getDefaultToolkit(); EventQueue eq = tk.getSystemEventQueue(); loop = eq.createSecondaryLoop(); // Spawn a new thread to do the work Thread worker = new WorkerThread(); worker.start(); // Enter the loop to block the current event // handler, but leave UI responsive if (!loop.enter()) { // Report an error } } }); class WorkerThread extends Thread {@Overridepublic void run() { // Perform calculations doSomethingUseful(); // Exit the loop loop.exit(); } }- Since:
- 1.7
- See Also:
-
Dialog.show(),EventQueue.createSecondaryLoop(),Toolkit.getSystemEventQueue()
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description booleanenter()Blocks the execution of the current thread and enters a new secondary event loop on the event dispatch thread.booleanexit()Unblocks the execution of the thread blocked by theenter()method and exits the secondary loop.
-
-
-
Method Detail
enter
boolean enter()
Blocks the execution of the current thread and enters a new secondary event loop on the event dispatch thread.This method can be called by any thread including the event dispatch thread. This thread will be blocked until the
exit()method is called or the loop is terminated. A new secondary loop will be created on the event dispatch thread for dispatching events in either case.This method can only start one new event loop at a time per object. If a secondary event loop has already been started by this object and is currently still running, this method returns
falseto indicate that it was not successful in starting a new event loop. Otherwise, this method blocks the calling thread and later returnstruewhen the new event loop is terminated. At such time, this object can again be used to start another new event loop.- Returns:
-
trueafter termination of the secondary loop, if the secondary loop was started by this call,falseotherwise
exit
boolean exit()
Unblocks the execution of the thread blocked by theenter()method and exits the secondary loop.This method resumes the thread that called the
enter()method and exits the secondary loop that was created when theenter()method was invoked.Note that if any other secondary loop is started while this loop is running, the blocked thread will not resume execution until the nested loop is terminated.
If this secondary loop has not been started with the
enter()method, or this secondary loop has already finished with theexit()method, this method returnsfalse, otherwisetrueis returned.- Returns:
-
trueif this loop was previously started and has not yet been finished with theexit()method,falseotherwise
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
