blob: aeca09b75937ef6b9890a77f6c85b16db7b0b486 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
/****************************************************************************
* Copyright (c) 2007 Composent, Inc. and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Composent, Inc. - initial API and implementation
*****************************************************************************/
package org.eclipse.ecf.core.util;
import java.lang.reflect.InvocationTargetException;
/**
*
*/
public interface IAsyncResult {
/**
* Get the underlying result. Block until result is available.
*
* @return Object that is result
* @throws InterruptedException
* thrown if waiting is interrupted
* @throws InvocationTargetException
* thrown if exception was thrown by execution
*/
public abstract Object get() throws InterruptedException, InvocationTargetException;
/**
* Get the underlying result with limited wait time. Behaves similarly to
* {@link #wait()}, but only waits msecs (ms) before throwing
* TimeoutException
*
* @param msecs
* to wait before timing out
* @return Object that is result
* @throws TimeoutException
* thrown if msecs elapse before a result is available
* @throws InterruptedException
* thrown if waiting is interrupted
* @throws InvocationTargetException
* thrown if exception was thrown by execution
*/
public abstract Object get(long msecs) throws TimeoutException, InterruptedException, InvocationTargetException;
/**
* Get the InvocationTargetException that occured during invocation. If
* null, no exception was thrown
*
* @return InvocationTargetException if an exception occurred (available via
* {@link InvocationTargetException#getCause()}. Null if no
* exception has occurred
*/
public abstract InvocationTargetException getException();
/**
* @return true if result has been set or exception has occurred, false if
* not.
*/
public abstract boolean isReady();
/**
* @return Object result that has been set or null if has not been set
*/
public abstract Object peek();
/**
* Clear this AsyncResult. Clears both the result Object and the
* InvocationTargetException (if set)
*/
public abstract void clear();
}
|
