* Assertions are configured in lambda consumer of {@link SoftAssertions} object on each check. * The checks are executed periodically with check interval delay configured with {@link AsyncAssert#withCheckInterval} method. * After exceeding timeout {@link AssertionError} will be thrown with failures from last assertion check. - * - *
+ *
+ * Example usage:
+ *
{@code
* awaitAtMostOneSecond().untilAssertions(async -> {
* async.assertThat(getValue()).isEqualTo(expected);
* async.assertThat(isDone()).isTrue();
* });
- * * In multi-thread applications, the mutex object can be used to notify the other thread about state change. * For asynchronous assertion, the mutex object can be used to reduce the wait time between checks with {@link Object#notifyAll()} call. + *
+ * Example usage: + *
{@code
+ * // given
+ * var condition = new AtomicBoolean();
+ * var waitMutex = new Object();
+ * var executor = Executors.newSingleThreadExecutor();
+ *
+ * // when
+ * executor.execute(() -> {
+ * // ... asynchronous logic
+ * condition.set(true);
+ * // notify after done
+ * synchronized (waitMutex) {
+ * waitMutex.notifyAll();
+ * }
+ * });
+ *
+ * // then
+ * awaitAtMostOneSecond()
+ * .usingWaitMutex(waitMutex)
+ * .untilAssertions(async -> {
+ * async.assertThat(condition).isTrue();
+ * });
+ * }
*
* @param waitMutex mutex object
* @return new {@link AsyncAssert} using given wait mutex
@@ -45,6 +72,15 @@ public interface AsyncAssert
/**
* Configures the interval to be waited between assertions checks.
* The interval must be greater than zero and lower than timeout.
+ * + * Example usage: + *
{@code
+ * awaitAtMostOneSecond()
+ * .withCheckInterval(Duration.ofMillis(500))
+ * .untilAssertions(async -> {
+ * async.assertThat(condition).isTrue();
+ * });
+ * }
*
* @param checkInterval check interval
* @return new {@link AsyncAssert} with set check interval
@@ -54,6 +90,15 @@ public interface AsyncAssert
/**
* Configures the interval to be waited between assertions checks.
* The interval must be greater than zero and lower than timeout.
+ * + * Example usage: + *
{@code
+ * awaitAtMostOneSecond()
+ * .withCheckInterval(500, TimeUnit.MILLISECONDS)
+ * .untilAssertions(async -> {
+ * async.assertThat(condition).isTrue();
+ * });
+ * }
*
* @param checkInterval check interval
* @param timeUnit the time unit of the check interval
diff --git a/src/main/java/com/webfleet/assertj/AsyncAssertions.java b/src/main/java/com/webfleet/assertj/AsyncAssertions.java
index b40754d..1b70dc8 100644
--- a/src/main/java/com/webfleet/assertj/AsyncAssertions.java
+++ b/src/main/java/com/webfleet/assertj/AsyncAssertions.java
@@ -9,20 +9,21 @@
/**
- * Entry point for asynchronous assertions.
+ * Entry point for building asynchronous assertions.
*/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public final class AsyncAssertions
{
/**
- * Returns evaluator of asynchronous assertions with given timeout.
- * See {@link AsyncAssert} for more details.
- *
- *
+ * Builds asynchronous assertion with given timeout.
+ *
+ * Example usage:
+ *
{@code
* awaitAtMost(Duration.ofSeconds(5)).untilAssertions(async -> {
* async.assertThat(getValue()).isEqualTo(expected);
* });
- *
+ * Builds asynchronous assertion with given timeout value and time unit.
+ *
+ * Example usage:
+ *
{@code
* awaitAtMost(5, SECONDS).untilAssertions(async -> {
* async.assertThat(getValue()).isEqualTo(expected);
* });
- *
+ * Builds asynchronous assertion with 1 second timeout.
+ *
+ * Example usage:
+ *
{@code
* awaitAtMostOneSecond().untilAssertions(async -> {
* async.assertThat(getValue()).isEqualTo(expected);
* });
- *
+ * Builds asynchronous assertion with 2 seconds timeout.
+ *
+ * Example usage:
+ *
{@code
* awaitAtMostTwoSeconds().untilAssertions(async -> {
* async.assertThat(getValue()).isEqualTo(expected);
* });
- *
+ * Builds asynchronous assertion with 5 seconds timeout.
+ *
+ * Example usage:
+ *
{@code
* awaitAtMostFiveSeconds().untilAssertions(async -> {
* async.assertThat(getValue()).isEqualTo(expected);
* });
- *
+ * Builds asynchronous assertion with 15 seconds timeout.
+ *
+ * Example usage:
+ *
{@code
* awaitAtMostFifteenSeconds().untilAssertions(async -> {
* async.assertThat(getValue()).isEqualTo(expected);
* });
- *
+ * Builds asynchronous assertion with 30 seconds timeout.
+ *
+ * Example usage:
+ *
{@code
* awaitAtMostThirtySeconds().untilAssertions(async -> {
* async.assertThat(getValue()).isEqualTo(expected);
* });
- *