|
|||||||||||||||||||
Source file | Conditionals | Statements | Methods | TOTAL | |||||||||||||||
AsyncCompletionArgs.java | 0% | 0% | 0% | 0% |
|
1 | /*BEGIN_COPYRIGHT_BLOCK | |
2 | * | |
3 | * Copyright (c) 2001-2010, JavaPLT group at Rice University (drjava@rice.edu) | |
4 | * All rights reserved. | |
5 | * | |
6 | * Redistribution and use in source and binary forms, with or without | |
7 | * modification, are permitted provided that the following conditions are met: | |
8 | * * Redistributions of source code must retain the above copyright | |
9 | * notice, this list of conditions and the following disclaimer. | |
10 | * * Redistributions in binary form must reproduce the above copyright | |
11 | * notice, this list of conditions and the following disclaimer in the | |
12 | * documentation and/or other materials provided with the distribution. | |
13 | * * Neither the names of DrJava, the JavaPLT group, Rice University, nor the | |
14 | * names of its contributors may be used to endorse or promote products | |
15 | * derived from this software without specific prior written permission. | |
16 | * | |
17 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
18 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
19 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
20 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR | |
21 | * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, | |
22 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, | |
23 | * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
24 | * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
25 | * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
26 | * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
27 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
28 | * | |
29 | * This software is Open Source Initiative approved Open Source Software. | |
30 | * Open Source Initative Approved is a trademark of the Open Source Initiative. | |
31 | * | |
32 | * This file is part of DrJava. Download the current version of this project | |
33 | * from http://www.drjava.org/ or http://sourceforge.net/projects/drjava/ | |
34 | * | |
35 | * END_COPYRIGHT_BLOCK*/ | |
36 | ||
37 | package edu.rice.cs.util.swing; | |
38 | ||
39 | /** | |
40 | * @author jlugo | |
41 | * | |
42 | */ | |
43 | public class AsyncCompletionArgs<R> { | |
44 | ||
45 | private R _result; | |
46 | ||
47 | private Exception _caughtException; | |
48 | ||
49 | private boolean _cancelRequested; | |
50 | ||
51 | 0 | public AsyncCompletionArgs(R result, boolean cancelRequested) { |
52 | 0 | this(result, null, cancelRequested); |
53 | } | |
54 | ||
55 | 0 | public AsyncCompletionArgs(R result, Exception caughtException, boolean wasCanceled) { |
56 | 0 | _result = result; |
57 | 0 | _caughtException = caughtException; |
58 | 0 | _cancelRequested = wasCanceled; |
59 | } | |
60 | ||
61 | /** Returns the result of the asynchronous computation performed by the | |
62 | * <code>AsyncTask</code>. If the task threw an exception, this value will | |
63 | * be null. The exception can be obtained by calling | |
64 | * <code>getCaughtException</code> | |
65 | * | |
66 | * @return The resulting data produced by <code>AsyncTask.runAsync</code> | |
67 | */ | |
68 | 0 | public R getResult() { |
69 | 0 | return _result; |
70 | } | |
71 | ||
72 | /** Returns the exception thrown from within the asynchronous task if an exception was thrown. If no exception was | |
73 | * thrown and the task completed successfully, this value will be null. | |
74 | * @return The exception that was caught when running <code>AsyncTask.runAsync</code> or <code>null</code> if no | |
75 | * exception was thrown. | |
76 | */ | |
77 | 0 | public Exception getCaughtException() { |
78 | 0 | return _caughtException; |
79 | } | |
80 | ||
81 | /** If an exception was thrown during the execution of the AsyncTask, calling | |
82 | * this method will cause the exception to be thrown again in the thread that | |
83 | * calls this method. If no exception was thrown, this method does nothing. | |
84 | * @throws Exception if an exception was thrown from within the asynchronous task. | |
85 | */ | |
86 | 0 | public void throwCaughtException() throws Exception { |
87 | 0 | if (_caughtException != null) { |
88 | 0 | throw _caughtException; |
89 | } | |
90 | } | |
91 | ||
92 | /** Returns whether the user requested cancellation of the operation before completion. The task itself is responsible | |
93 | * for terminating its own execution and thus may have successfully completed. | |
94 | * @return Whether the user requested for the task to be canceled was | |
95 | */ | |
96 | 0 | public boolean cancelRequested() { |
97 | 0 | return _cancelRequested; |
98 | } | |
99 | } |
|