bundles/org.eclipse.osgi.util/src/org/osgi/util/promise/FailedPromiseImpl.java

/*
 * Copyright (c) OSGi Alliance (2017). 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 org.osgi.util.promise;

import static java.util.Objects.requireNonNull;

import java.lang.reflect.InvocationTargetException;

/**
 * Failed Promise implementation.
 * <p>
 * This class is not used directly by clients. Clients should use
 * {@link PromiseFactory#failed(Throwable)} to create a failed {@link Promise}.
 * 
 * @param <T> The result type associated with the Promise.
 * @since 1.1
 * @ThreadSafe
 * @author $Id$
 */
final class FailedPromiseImpl<T> extends PromiseImpl<T> {
	/**
	 * The failure of this failed Promise.
	 */
	private final Throwable	fail;

	/**
	 * Initialize this failed Promise.
	 * 
	 * @param fail The failure of this failed Promise. Must not be {@code null}.
	 * @param factory The factory to use for callbacks and scheduled operations.
	 */
	FailedPromiseImpl(Throwable fail, PromiseFactory factory) {
		super(factory);
		this.fail = requireNonNull(fail);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public boolean isDone() {
		return true;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public T getValue() throws InvocationTargetException {
		throw new InvocationTargetException(fail);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public Throwable getFailure() {
		return fail;
	}

	/**
	 * Return a holder of the result of this PromiseImpl.
	 */
	@Override
	Result<T> collect() {
		return new Result<T>(fail);
	}

	@Override
	public String toString() {
		return super.toString() + "[failed: " + fail + "]";
	}
}