org.openide.util.Cancellable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org-openide-util Show documentation

The newest version!

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.openide.util;


/** Service provider interface (SPI) for adding cancel support to various jobs.
 *
 * Note that {@link #cancel} method will be typically called concurrently to
 * other methods of job or operation in question, so proper synchronization
 * is needed.
 *
 * @author Dafe Simonek
 *
 * @since 3.36
 */
public interface Cancellable {
    /** Cancel processing of the job. Called not more then once for specific job.
     *
     * @return true if the job was succesfully cancelled, false if job
     *         can't be cancelled for some reason
     */
    public boolean cancel();
}