/*
 * Copyright (C) 2009 The Guava Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.glassfish.jersey.internal.guava;

A ListenableFuture whose result may be set by a set(Object) or setException(Throwable) call. It may also be cancelled. 
Author:
Sven Mawson
Since:
9.0 (in 1.0 as ValueFuture)/**
 * A {@link ListenableFuture} whose result may be set by a {@link #set(Object)}
 * or {@link #setException(Throwable)} call. It may also be cancelled.
 *
 * @author Sven Mawson
 * @since 9.0 (in 1.0 as {@code ValueFuture})
 */
public final class SettableFuture<V> extends AbstractFuture<V> {

    
Explicit private constructor, use the create factory method to create instances of SettableFuture. /**
     * Explicit private constructor, use the {@link #create} factory method to
     * create instances of {@code SettableFuture}.
     */
    private SettableFuture() {
    }

    
Creates a new SettableFuture in the default state. /**
     * Creates a new {@code SettableFuture} in the default state.
     */
    public static <V> SettableFuture<V> create() {
        return new SettableFuture<V>();
    }

    
Sets the value of this future. This method will return true if the value was successfully set, or false if the future has already been set or cancelled. 
Params:
value – the value the future should hold.
Returns:
true if the value was successfully set./**
     * Sets the value of this future.  This method will return {@code true} if
     * the value was successfully set, or {@code false} if the future has already
     * been set or cancelled.
     *
     * @param value the value the future should hold.
     * @return true if the value was successfully set.
     */
    @Override
    public boolean set(V value) {
        return super.set(value);
    }

    
Sets the future to having failed with the given exception. This exception will be wrapped in an ExecutionException and thrown from the 
get methods. This method will return true if the exception was successfully set, or false if the future has already been set or cancelled. 
Params:
throwable – the exception the future should hold.
Returns:
true if the exception was successfully set./**
     * Sets the future to having failed with the given exception. This exception
     * will be wrapped in an {@code ExecutionException} and thrown from the {@code
     * get} methods. This method will return {@code true} if the exception was
     * successfully set, or {@code false} if the future has already been set or
     * cancelled.
     *
     * @param throwable the exception the future should hold.
     * @return true if the exception was successfully set.
     */
    @Override
    public boolean setException(Throwable throwable) {
        return super.setException(throwable);
    }
}