Home | History | Annotate | Download | only in media 
      1 /*
      2  * Copyright (C) 2009 The Android Open Source Project
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  *      http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 
     17 package com.cooliris.media;
     18 
     19 import java.util.concurrent.ExecutionException;
     20 
     21 /**
     22  * The interface for all the tasks that could be canceled.
     23  */
     24 public interface Cancelable<T> {
     25     /*
     26      * Requests this <code>Cancelable</code> to be canceled. This function will
     27      * return <code>true</code> if and only if the task is originally running
     28      * and now begin requested for cancel.
     29      *
     30      * If subclass need to do more things to cancel the task. It can override
     31      * the code like this: <pre>
     32      *
     33      * @Override public boolean requestCancel() { if (super.requestCancel()) {
     34      * // do necessary work to cancel the task return true; } return false; }
     35      * </pre>
     36      */
     37     public boolean requestCancel();
     38 
     39     public void await() throws InterruptedException;
     40 
     41     /**
     42      * Gets the results of this <code>Cancelable</code> task.
     43      *
     44      * @throws ExecutionException
     45      *             if exception is thrown during the execution of the task
     46      */
     47     public T get() throws InterruptedException, ExecutionException;
     48 }