Skip to content

Commit 5d6e24e

Browse files
Improve Awaitable docs (#473)
1 parent 3947ccb commit 5d6e24e

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

sdk-api/src/main/java/dev/restate/sdk/Awaitable.java

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ public final Awaitable<T> withTimeout(Duration timeout) {
8585
* Map the success result of this {@link Awaitable}.
8686
*
8787
* @param mapper the mapper to execute if this {@link Awaitable} completes with success. The
88-
* mapper can throw a {@link TerminalException}, thus failing the resulting operation.
88+
* mapper can throw a {@link TerminalException}, thus failing the resulting {@link Awaitable}.
8989
* @return a new {@link Awaitable} with the mapped result, when completed
9090
*/
9191
public final <U> Awaitable<U> map(ThrowingFunction<T, U> mapper) {
@@ -111,9 +111,11 @@ public final <U> Awaitable<U> map(ThrowingFunction<T, U> mapper) {
111111
* Map both the success and the failure result of this {@link Awaitable}.
112112
*
113113
* @param successMapper the mapper to execute if this {@link Awaitable} completes with success.
114-
* The mapper can throw a {@link TerminalException}, thus failing the resulting operation.
114+
* The mapper can throw a {@link TerminalException}, thus failing the resulting {@link
115+
* Awaitable}.
115116
* @param failureMapper the mapper to execute if this {@link Awaitable} completes with failure.
116-
* The mapper can throw a {@link TerminalException}, thus failing the resulting operation.
117+
* The mapper can throw a {@link TerminalException}, thus failing the resulting {@link
118+
* Awaitable}.
117119
* @return a new {@link Awaitable} with the mapped result, when completed
118120
*/
119121
public final <U> Awaitable<U> map(
@@ -147,10 +149,11 @@ public final <U> Awaitable<U> map(
147149
}
148150

149151
/**
150-
* Map both the failure result of this {@link Awaitable}.
152+
* Map the failure result of this {@link Awaitable}.
151153
*
152154
* @param failureMapper the mapper to execute if this {@link Awaitable} completes with failure.
153-
* The mapper can throw a {@link TerminalException}, thus failing the resulting operation.
155+
* The mapper can throw a {@link TerminalException}, thus failing the resulting {@link
156+
* Awaitable}.
154157
* @return a new {@link Awaitable} with the mapped result, when completed
155158
*/
156159
public final Awaitable<T> mapFailure(ThrowingFunction<TerminalException, T> failureMapper) {

0 commit comments

Comments
 (0)