KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > aspects > asynch > Future


1 /*
2   * JBoss, Home of Professional Open Source
3   * Copyright 2005, JBoss Inc., and individual contributors as indicated
4   * by the @authors tag. See the copyright.txt in the distribution for a
5   * full listing of individual contributors.
6   *
7   * This is free software; you can redistribute it and/or modify it
8   * under the terms of the GNU Lesser General Public License as
9   * published by the Free Software Foundation; either version 2.1 of
10   * the License, or (at your option) any later version.
11   *
12   * This software is distributed in the hope that it will be useful,
13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15   * Lesser General Public License for more details.
16   *
17   * You should have received a copy of the GNU Lesser General Public
18   * License along with this software; if not, write to the Free
19   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21   */
22 package org.jboss.aspects.asynch;
23
24 import java.lang.reflect.InvocationTargetException JavaDoc;
25
26 /**
27  * Comment
28  *
29  * @author <a HREF="mailto:bill@jboss.org">Bill Burke</a>
30  * @version $Revision: 37406 $
31  */
32 public interface Future
33 {
34    /**
35     * get result, throws Exception of method or InterruptedException
36     */
37    public Object JavaDoc get() throws InterruptedException JavaDoc, InvocationTargetException JavaDoc;
38
39    /**
40     * get result, throws Exception of method or InterruptedException
41     */
42    public Object JavaDoc get(long milliseconds) throws TimeoutException, InterruptedException JavaDoc, InvocationTargetException JavaDoc;
43
44    /**
45     * is the method call done?
46     */
47    public boolean isDone();
48
49    /**
50     * Release this future so that it can be garbaged collected remotely
51     * This is only useful for remote asynchronous.
52     * This is import to call especially for remote otherwise the remote
53     * future on the server will never get garbaged collected.
54     * AsynchProvider will call release if it is holding a Future already
55     * within its threadlocal when a new one is set on it.
56     */
57    public void release();
58 }
59
Popular Tags