diff --git a/core/src/main/java/org/bitcoinj/utils/ListenableCompletableFuture.java b/core/src/main/java/org/bitcoinj/utils/ListenableCompletableFuture.java index 7a24d9c42..3ece229f7 100644 --- a/core/src/main/java/org/bitcoinj/utils/ListenableCompletableFuture.java +++ b/core/src/main/java/org/bitcoinj/utils/ListenableCompletableFuture.java @@ -21,21 +21,25 @@ import java.util.concurrent.CompletableFuture; /** * A {@link CompletableFuture} that is also a {@link com.google.common.util.concurrent.ListenableFuture} for migration - * from Guava {@code ListenableFuture} to {@link CompletableFuture}. + * from Guava {@code ListenableFuture} to {@link CompletableFuture}. This allows clients of bitcoinj to change the type + * of variables receiving {@code Future}s from bitcoinj methods. You must switch from Guava's + * {@link com.google.common.util.concurrent.ListenableFuture} (and related types) to Java 8's {@link CompletableFuture}. + * Release 0.18 of bitcoinj will remove this class, + * and the type of returned futures from bitcoinj, will be changed to {@link CompletableFuture}. + *
+ * WARNING: This class should be considered Deprecated for Removal, as it will be removed in Release 0.18. See above for details.
*/
public class ListenableCompletableFuture
- * When the migration to {@link CompletableFuture} is finished use of this method
- * can be replaced with {@link CompletableFuture#completedFuture(Object)}.
*
* @param value the value
* @param
- * When the migration to {@link CompletableFuture} is finished this can be deprecated
- * and {@link FutureUtils#failedFuture(Throwable)} can be used instead.
*
* @param throwable the exceptions
* @param
- * When the migration to {@link CompletableFuture} is finished usages of this method
- * can simply be removed as the conversion will no longer be required.
* @param future A CompletableFuture that may need to be converted
* @param
- * Note that this is much easier to implement than trying to extend {@link com.google.common.util.concurrent.AbstractFuture}
- * to implement {@code CompletionStage}.
+ * WARNING: This interface should be considered Deprecated for Removal, It will be removed in Release 0.18. See {@link ListenableCompletableFuture} for details.
*/
public interface ListenableCompletionStage