InternalCompletableFuture.java

/*
 * Copyright (c) 2008-2017, Hazelcast, Inc. All Rights Reserved.
 *
 * 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 com.hazelcast.spi;

import com.hazelcast.core.ICompletableFuture;

/**
 * A {@link com.hazelcast.core.ICompletableFuture} with more functionality like getting
 * the result without needing to deal with checked exceptions.
 *
 * @param <E>
 */
public interface InternalCompletableFuture<E> extends ICompletableFuture<E> {

    /**
     * Waits for this future to complete.
     *
     * @return the result.
     */
    E join();

     /**
     * Completes this future.
     *
     * @param value the value to complete this future with.
     * @return {@code true} if this invocation caused this InternalCompletableFuture to complete, else {@code false}
     */
    boolean complete(Object value);
}