KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > openide > util > AsyncGUIJob


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19 package org.openide.util;
20
21
22 /** Service provider interface (SPI) for executing of time consuming task which
23  * results are visible in UI.
24  *
25  * Typical usage is post-initialization of UI components or various long lasting
26  * operations like network accessing invoked directly or indirectly by user
27  * from UI.
28  *
29  * Note that it's often desirable to provide cancel support, at least for
30  * longer lasting jobs. See {@link org.openide.util.Cancellable} support.
31  * Keep in mind that methods {@link #construct} and
32  * {@link org.openide.util.Cancellable#cancel} can be called concurrently and
33  * require proper synchronization as such.
34  *
35  * @author Dafe Simonek
36  *
37  * @see org.openide.util.Utilities#attachInitJob
38  * @since 3.36
39  */
40 public interface AsyncGUIJob {
41     /** Worker method, can be called in any thread but event dispatch thread.
42      * Implement your time consuming work here.
43      * Always called and completed before {@link #finished} method.
44      */
45     public void construct();
46
47     /** Method to update UI using given data constructed in {@link #construct}
48      * method. Always called in event dispatch thread, after {@link #construct}
49      * method completed its execution.
50      */
51     public void finished();
52 }
53
Popular Tags