KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > rice > cs > util > swing > AsyncCompletionArgs


1 /*BEGIN_COPYRIGHT_BLOCK
2  *
3  * This file is part of DrJava. Download the current version of this project from http://www.drjava.org/
4  * or http://sourceforge.net/projects/drjava/
5  *
6  * DrJava Open Source License
7  *
8  * Copyright (C) 2001-2005 JavaPLT group at Rice University (javaplt@rice.edu). All rights reserved.
9  *
10  * Developed by: Java Programming Languages Team, Rice University, http://www.cs.rice.edu/~javaplt/
11  *
12  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
13  * documentation files (the "Software"), to deal with the Software without restriction, including without limitation
14  * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
15  * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
16  *
17  * - Redistributions of source code must retain the above copyright notice, this list of conditions and the
18  * following disclaimers.
19  * - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
20  * following disclaimers in the documentation and/or other materials provided with the distribution.
21  * - Neither the names of DrJava, the JavaPLT, Rice University, nor the names of its contributors may be used to
22  * endorse or promote products derived from this Software without specific prior written permission.
23  * - Products derived from this software may not be called "DrJava" nor use the term "DrJava" as part of their
24  * names without prior written permission from the JavaPLT group. For permission, write to javaplt@rice.edu.
25  *
26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
27  * THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28  * CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
29  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
30  * WITH THE SOFTWARE.
31  *
32  *END_COPYRIGHT_BLOCK*/
33
34 package edu.rice.cs.util.swing;
35
36 /**
37  * @author jlugo
38  *
39  */
40 public class AsyncCompletionArgs<R> {
41
42     private R _result;
43
44     private Exception JavaDoc _caughtException;
45
46     private boolean _cancelRequested;
47
48     public AsyncCompletionArgs(R result, boolean cancelRequested) {
49         this(result, null, cancelRequested);
50     }
51
52     public AsyncCompletionArgs(R result, Exception JavaDoc caughtException, boolean wasCanceled) {
53         _result = result;
54         _caughtException = caughtException;
55         _cancelRequested = wasCanceled;
56     }
57
58     /**
59      * Returns the result of the asynchronous computation performed by the
60      * <code>AsyncTask</code>. If the task threw an exception, this value will
61      * be null. The exception can be obtained by calling
62      * <code>getCaughtException</code>
63      *
64      * @return The resulting data produced by <code>AsyncTask.runAsync</code>
65      */
66     public R getResult() {
67         return _result;
68     }
69
70     /**
71      * Returns the exception thrown from within the asynchronous task if an
72      * exception was thrown. If no exception was thrown and the task completed
73      * successfully, this value will be null.
74      *
75      * @return The exception that was caught when running
76      * <code>AsyncTask.runAsync</code> or <code>null</code> if no
77      * exception was thrown.
78      */
79     public Exception JavaDoc getCaughtException() {
80         return _caughtException;
81     }
82
83     /**
84      * If an exception was thrown during the execution of the AsyncTask, calling
85      * this method will cause the exception to be thrown again in the thread that
86      * calls this method. If no exception was thrown, this method does nothing.
87      *
88      * @throws Exception
89      * If an exception was thrown from within the asynchronous task.
90      */
91     public void throwCaughtException() throws Exception JavaDoc {
92         if (_caughtException != null) {
93             throw _caughtException;
94         }
95     }
96
97     /**
98      * Returns whether the user requested that the operation be canceled before
99      * completing. The task itself is responsible for terminating its own
100      * execution and thus may have successfully completed.
101      *
102      * @return Whether the user requested for the task to be canceled was
103      */
104     public boolean cancelRequested() {
105         return _cancelRequested;
106     }
107 }
108
Popular Tags