KickJava   Java API By Example, From Geeks To Geeks.

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


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 adding cancel support to various jobs.
23  *
24  * Note that {@link #cancel} method will be typically called concurrently to
25  * other methods of job or operation in question, so proper synchronization
26  * is needed.
27  *
28  * @author Dafe Simonek
29  *
30  * @since 3.36
31  */
32 public interface Cancellable {
33     /** Cancel processing of the job. Called not more then once for specific job.
34      *
35      * @return true if the job was succesfully cancelled, false if job
36      * can't be cancelled for some reason
37      */
38     public boolean cancel();
39 }
40
Popular Tags