org.openide.util.AsyncGUIJob Maven / Gradle / Ivy
The newest version!
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common
* Development and Distribution License("CDDL") (collectively, the
* "License"). You may not use this file except in compliance with the
* License. You can obtain a copy of the License at
* http://www.netbeans.org/cddl-gplv2.html
* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
* specific language governing permissions and limitations under the
* License. When distributing the software, include this License Header
* Notice in each file and include the License file at
* nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the
* License Header, with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Contributor(s):
*
* The Original Software is NetBeans. The Initial Developer of the Original
* Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
* Microsystems, Inc. All Rights Reserved.
*
* If you wish your version of this file to be governed by only the CDDL
* or only the GPL Version 2, indicate your decision by adding
* "[Contributor] elects to include this software in this distribution
* under the [CDDL or GPL Version 2] license." If you do not indicate a
* single choice of license, a recipient has the option to distribute
* your version of this file under either the CDDL, the GPL Version 2 or
* to extend the choice of license to its licensees as provided above.
* However, if you add GPL Version 2 code and therefore, elected the GPL
* Version 2 license, then the option applies only if the new code is
* made subject to such option by the copyright holder.
*/
package org.openide.util;
/** Service provider interface (SPI) for executing of time consuming task which
* results are visible in UI.
*
* Typical usage is post-initialization of UI components or various long lasting
* operations like network accessing invoked directly or indirectly by user
* from UI.
*
* Note that it's often desirable to provide cancel support, at least for
* longer lasting jobs. See {@link org.openide.util.Cancellable} support.
* Keep in mind that methods {@link #construct} and
* {@link org.openide.util.Cancellable#cancel} can be called concurrently and
* require proper synchronization as such.
*
* @author Dafe Simonek
*
* @see org.openide.util.Utilities#attachInitJob
* @since 3.36
*/
public interface AsyncGUIJob {
/** Worker method, can be called in any thread but event dispatch thread.
* Implement your time consuming work here.
* Always called and completed before {@link #finished} method.
*/
public void construct();
/** Method to update UI using given data constructed in {@link #construct}
* method. Always called in event dispatch thread, after {@link #construct}
* method completed its execution.
*/
public void finished();
}