javax.ejb.AsyncResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javax.ejb-api Show documentation
Project GlassFish Enterprise JavaBean API
The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2006-2018 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://oss.oracle.com/licenses/CDDL+GPL-1.1
 * or LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package javax.ejb;

import java.io.Serializable;
import java.util.concurrent.*;

/**
  * Wraps the result of an asynchronous method call as a Future
  * object, preserving compatability with the business interface signature.
  * 
  * The value specified in the constructor will be retrieved by the container
  * and made available to the client.
  * 
  * Note that this object is not passed to the client.  It is
  * merely a convenience for providing the result value to the container.
  * Therefore, none of its instance methods should be called by the 
  * application.
  *
  * @since EJB 3.1
  */

public final class AsyncResult implements Future {

    private final V resultValue;

    /**
     * Creates a AsyncResult instance to wrap the result of an
     * asynchronous method call
     *
     * @param result the result of an asynchronous method call to be made
     * available to the client
     */
    public AsyncResult(V result) {
        resultValue = result;
    }

    /**
     * This method should not be called.  See Class-level comments.
     */
    @Override
    public boolean cancel(boolean mayInterruptIfRunning) {
        throw new java.lang.IllegalStateException
	    ("Object does not represent an acutal Future");
    }

    /**
     * This method should not be called.  See Class-level comments.
     */
    @Override
    public boolean isCancelled() {
        throw new java.lang.IllegalStateException
	    ("Object does not represent an acutal Future");
    }

    /**
     * This method should not be called.  See Class-level comments.
     */
    @Override
    public boolean isDone() {
        throw new java.lang.IllegalStateException
	    ("Object does not represent an acutal Future");
    }

    /**
     * This method should not be called.  See Class-level comments.
     */
    @Override
    public V get() throws InterruptedException, ExecutionException {
	    return resultValue;
    }

    /**
     * This method should not be called.  See Class-level comments.
     */
    @Override
    public V get(long timeout, TimeUnit unit) 
	throws InterruptedException, ExecutionException, TimeoutException {
	throw new java.lang.IllegalStateException
	    ("Object does not represent an acutal Future");
    }

}