001: /*BEGIN_COPYRIGHT_BLOCK
002: *
003: * Copyright (c) 2001-2007, JavaPLT group at Rice University (javaplt@rice.edu)
004: * All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions are met:
008: * * Redistributions of source code must retain the above copyright
009: * notice, this list of conditions and the following disclaimer.
010: * * Redistributions in binary form must reproduce the above copyright
011: * notice, this list of conditions and the following disclaimer in the
012: * documentation and/or other materials provided with the distribution.
013: * * Neither the names of DrJava, the JavaPLT group, Rice University, nor the
014: * names of its contributors may be used to endorse or promote products
015: * derived from this software without specific prior written permission.
016: *
017: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
018: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
019: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
020: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
021: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
022: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
023: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
024: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
025: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
026: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
027: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
028: *
029: * This software is Open Source Initiative approved Open Source Software.
030: * Open Source Initative Approved is a trademark of the Open Source Initiative.
031: *
032: * This file is part of DrJava. Download the current version of this project
033: * from http://www.drjava.org/ or http://sourceforge.net/projects/drjava/
034: *
035: * END_COPYRIGHT_BLOCK*/
036:
037: package edu.rice.cs.util.swing;
038:
039: /**
040: * @author jlugo
041: *
042: */
043: public class AsyncCompletionArgs<R> {
044:
045: private R _result;
046:
047: private Exception _caughtException;
048:
049: private boolean _cancelRequested;
050:
051: public AsyncCompletionArgs(R result, boolean cancelRequested) {
052: this (result, null, cancelRequested);
053: }
054:
055: public AsyncCompletionArgs(R result, Exception caughtException,
056: boolean wasCanceled) {
057: _result = result;
058: _caughtException = caughtException;
059: _cancelRequested = wasCanceled;
060: }
061:
062: /**
063: * Returns the result of the asynchronous computation performed by the
064: * <code>AsyncTask</code>. If the task threw an exception, this value will
065: * be null. The exception can be obtained by calling
066: * <code>getCaughtException</code>
067: *
068: * @return The resulting data produced by <code>AsyncTask.runAsync</code>
069: */
070: public R getResult() {
071: return _result;
072: }
073:
074: /**
075: * Returns the exception thrown from within the asynchronous task if an
076: * exception was thrown. If no exception was thrown and the task completed
077: * successfully, this value will be null.
078: *
079: * @return The exception that was caught when running
080: * <code>AsyncTask.runAsync</code> or <code>null</code> if no
081: * exception was thrown.
082: */
083: public Exception getCaughtException() {
084: return _caughtException;
085: }
086:
087: /**
088: * If an exception was thrown during the execution of the AsyncTask, calling
089: * this method will cause the exception to be thrown again in the thread that
090: * calls this method. If no exception was thrown, this method does nothing.
091: *
092: * @throws Exception
093: * If an exception was thrown from within the asynchronous task.
094: */
095: public void throwCaughtException() throws Exception {
096: if (_caughtException != null) {
097: throw _caughtException;
098: }
099: }
100:
101: /**
102: * Returns whether the user requested that the operation be canceled before
103: * completing. The task itself is responsible for terminating its own
104: * execution and thus may have successfully completed.
105: *
106: * @return Whether the user requested for the task to be canceled was
107: */
108: public boolean cancelRequested() {
109: return _cancelRequested;
110: }
111: }
|