org.osgi.util.promise.Promises Maven / Gradle / Ivy
/*
* Copyright (c) OSGi Alliance (2014, 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 org.osgi.util.promise.PromiseFactory.defaultFactory;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
/**
* Static helper methods for {@link Promise}s.
*
* These methods return Promises which use the default callback executor and
* default scheduled executor. See {@link PromiseFactory} for similar methods
* which use executors other than the default executors.
*
* @ThreadSafe
* @see PromiseFactory
* @author $Id: 650a2b0e2fc5151df647982518f76d6e4519979c $
*/
public class Promises {
private Promises() {
// disallow object creation
}
/**
* Returns a new Promise that has been resolved with the specified value.
*
* @param The value type associated with the returned Promise.
* @param value The value of the resolved Promise.
* @return A new Promise which uses the default callback executor and
* default scheduled executor that has been resolved with the
* specified value.
* @see PromiseFactory#resolved(Object)
*/
public static Promise resolved(T value) {
return defaultFactory.resolved(value);
}
/**
* Returns a new Promise that has been resolved with the specified failure.
*
* @param The value type associated with the returned Promise.
* @param failure The failure of the resolved Promise. Must not be
* {@code null}.
* @return A new Promise which uses the default callback executor and
* default scheduled executor that has been resolved with the
* specified failure.
* @see PromiseFactory#failed(Throwable)
*/
public static Promise failed(Throwable failure) {
return defaultFactory.failed(failure);
}
/**
* Returns a new Promise that is a latch on the resolution of the specified
* Promises.
*
* The returned Promise acts as a gate and must be resolved after all of the
* specified Promises are resolved.
*
* @param The value type of the List value associated with the returned
* Promise.
* @param A subtype of the value type of the List value associated with
* the returned Promise.
* @param promises The Promises which must be resolved before the returned
* Promise must be resolved. Must not be {@code null} and all of
* the elements in the collection must not be {@code null}.
* @return A Promise which uses the default callback executor and default
* scheduled executor that is resolved only when all the specified
* Promises are resolved. The returned Promise must be successfully
* resolved with a List of the values in the order of the specified
* Promises if all the specified Promises are successfully resolved.
* The List in the returned Promise is the property of the caller
* and is modifiable. The returned Promise must be resolved with a
* failure of {@link FailedPromisesException} if any of the
* specified Promises are resolved with a failure. The failure
* {@link FailedPromisesException} must contain all of the specified
* Promises which resolved with a failure.
* @see PromiseFactory#all(Collection)
*/
public static Promise> all(
Collection> promises) {
return defaultFactory.all(promises);
}
/**
* Returns a new Promise that is a latch on the resolution of the specified
* Promises.
*
* The new Promise acts as a gate and must be resolved after all of the
* specified Promises are resolved.
*
* @param The value type associated with the specified Promises.
* @param promises The Promises which must be resolved before the returned
* Promise must be resolved. Must not be {@code null} and all of
* the arguments must not be {@code null}.
* @return A Promise which uses the default callback executor and scheduled
* executor that is resolved only when all the specified Promises
* are resolved. The returned Promise must be successfully resolved
* with a List of the values in the order of the specified Promises
* if all the specified Promises are successfully resolved. The List
* in the returned Promise is the property of the caller and is
* modifiable. The returned Promise must be resolved with a failure
* of {@link FailedPromisesException} if any of the specified
* Promises are resolved with a failure. The failure
* {@link FailedPromisesException} must contain all of the specified
* Promises which resolved with a failure.
* @see PromiseFactory#all(Collection)
*/
@SafeVarargs
public static Promise> all(Promise... promises) {
@SuppressWarnings("unchecked")
List> list = Arrays.asList((Promise[]) promises);
return defaultFactory.all(list);
}
}