Skip to content

Commit f7a7f7b

Browse files
committed
Deferred.toCompletableFuture renamed to asCompletableFuture
1 parent 38b5ea1 commit f7a7f7b

File tree

3 files changed

+15
-5
lines changed

3 files changed

+15
-5
lines changed

kotlinx-coroutines-jdk8/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Extension functions:
1313
| **Name** | **Description**
1414
| -------- | ---------------
1515
| [CompletableFuture.await][java.util.concurrent.CompletableFuture.await] | Awaits for completion of the future
16-
| [Deferred.toCompletableFuture][kotlinx.coroutines.experimental.Deferred.toCompletableFuture] | Converts a deferred value to the future
16+
| [Deferred.asCompletableFuture][kotlinx.coroutines.experimental.Deferred.asCompletableFuture] | Converts a deferred value to the future
1717

1818
# Package kotlinx.coroutines.experimental.future
1919

@@ -29,5 +29,5 @@ Additional libraries for JDK8 [CompletableFuture][java.util.concurrent.Completab
2929
[future]: https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-jdk8/kotlinx.coroutines.experimental.future/future.html
3030
[java.util.concurrent.CompletableFuture]: https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-jdk8/kotlinx.coroutines.experimental.future/java.util.concurrent.-completable-future/index.html
3131
[java.util.concurrent.CompletableFuture.await]: https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-jdk8/kotlinx.coroutines.experimental.future/java.util.concurrent.-completable-future/await.html
32-
[kotlinx.coroutines.experimental.Deferred.toCompletableFuture]: https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-jdk8/kotlinx.coroutines.experimental.future/kotlinx.coroutines.experimental.-deferred/to-completable-future.html
32+
[kotlinx.coroutines.experimental.Deferred.asCompletableFuture]: https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-jdk8/kotlinx.coroutines.experimental.future/kotlinx.coroutines.experimental.-deferred/as-completable-future.html
3333
<!--- END -->

kotlinx-coroutines-jdk8/src/main/kotlin/kotlinx/coroutines/experimental/future/Future.kt

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,21 @@ public fun <T> future(context: CoroutineContext = CommonPool, block: suspend ()
4444
return future
4545
}
4646

47+
48+
/**
49+
* Converts this deferred value to the instance of [CompletableFuture].
50+
* The deferred value is cancelled when the resulting future is cancelled or otherwise completed.
51+
* @suppress: **Deprecated**: Renamed to [asCompletableFuture]
52+
*/
53+
@Deprecated("Renamed to `asCompletableFuture`",
54+
replaceWith = ReplaceWith("asCompletableFuture()"))
55+
public fun <T> Deferred<T>.toCompletableFuture(): CompletableFuture<T> = asCompletableFuture()
56+
4757
/**
4858
* Converts this deferred value to the instance of [CompletableFuture].
4959
* The deferred value is cancelled when the resulting future is cancelled or otherwise completed.
5060
*/
51-
public fun <T> Deferred<T>.toCompletableFuture(): CompletableFuture<T> {
61+
public fun <T> Deferred<T>.asCompletableFuture(): CompletableFuture<T> {
5262
val future = CompletableFuture<T>()
5363
future.whenComplete { _, exception -> cancel(exception) }
5464
invokeOnCompletion {

kotlinx-coroutines-jdk8/src/test/kotlin/examples/ToFuture-example.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ package examples
1919
import kotlinx.coroutines.experimental.CommonPool
2020
import kotlinx.coroutines.experimental.async
2121
import kotlinx.coroutines.experimental.delay
22-
import kotlinx.coroutines.experimental.future.toCompletableFuture
22+
import kotlinx.coroutines.experimental.future.asCompletableFuture
2323
import java.util.concurrent.TimeUnit
2424

2525
fun main(args: Array<String>) {
@@ -30,6 +30,6 @@ fun main(args: Array<String>) {
3030
log("Done...")
3131
42
3232
}
33-
val future = deferred.toCompletableFuture()
33+
val future = deferred.asCompletableFuture()
3434
log("Got ${future.get()}")
3535
}

0 commit comments

Comments
 (0)