com.oracle.bedrock.deferred

Class Eventually

java.lang.Object

com.oracle.bedrock.deferred.Eventually

public class Eventually
extends Object

Commonly used "assertThat" methods for the purposes of asserting conditions concerning the state of Deferred values.

To customize assertion behavior and timeouts, this class allows extensive use of Options. For example, the following Options may be used to customize timeout constraints when asserting Deferred values; Timeout, MaximumRetryDelay, Initial InitialDelay and RetryFrequency.

Copyright (c) 2013. All Rights Reserved. Oracle Corporation.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.

Author:

Brian Oliver

See Also:

Repetitively, Concurrently

Constructor Summary

Constructors

Constructor and Description
Eventually()

Method Summary

Modifier and Type	Method and Description
static <T> void	assertThat(JavaApplication application, RemoteCallable<T> callable, org.hamcrest.Matcher<? super T> matcher) Asserts that the specified RemoteCallable submitted to the JavaApplication will eventually match the specified matcher using the specified Options.
static <T> void	assertThat(JavaApplication application, RemoteCallable<T> callable, org.hamcrest.Matcher<? super T> matcher, com.oracle.bedrock.Option... options) Asserts that the specified RemoteCallable submitted to the JavaApplication will eventually satisfy the specified matcher using the provided Options.
static <T> void	assertThat(String message, com.oracle.bedrock.deferred.Deferred<T> deferred, org.hamcrest.Matcher<? super T> matcher, com.oracle.bedrock.Option... options) Asserts that a Deferred value, when it becomes available, will eventually satisfy the specified Matcher within the bounds of the provided Options.
static <T> void	assertThat(String message, T value, org.hamcrest.Matcher<? super T> matcher) Asserts that a value will eventually satisfy the specified Matcher.
static <T> void	assertThat(String message, T value, org.hamcrest.Matcher<? super T> matcher, com.oracle.bedrock.Option... options) Asserts that a value will eventually satisfy the specified Matcher using the provided Options.
static <T> void	assertThat(T value, org.hamcrest.Matcher<? super T> matcher, com.oracle.bedrock.Option... options) Asserts that a value will eventually satisfy the specified Matcher using the specified Options.
static com.oracle.bedrock.deferred.options.InitialDelay	delayedBy(long duration, TimeUnit units) Obtains a InitialDelay for the specified values.
static com.oracle.bedrock.options.Timeout	within(long duration, TimeUnit units) Obtains a Timeout with the specified duration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Eventually

public Eventually()

Method Detail

assertThat

public static <T> void assertThat(T value,
                                  org.hamcrest.Matcher<? super T> matcher,
                                  com.oracle.bedrock.Option... options)
                           throws AssertionError

Asserts that a value will eventually satisfy the specified Matcher using the specified Options.

Should the value be the result of a call to DeferredHelper.invoking(Deferred) the result is unwrapped into a Deferred that is then used for the assert.

Type Parameters:

T - the type of the value

Parameters:

value - the value

matcher - the Matcher for the value

options - the Options for the assertion

Throws:

AssertionError - if the assertion fails

assertThat

public static <T> void assertThat(String message,
                                  T value,
                                  org.hamcrest.Matcher<? super T> matcher)
                           throws AssertionError

Asserts that a value will eventually satisfy the specified Matcher.

Should the value be the result of a call to DeferredHelper.invoking(Deferred) the result is unwrapped into a Deferred that is then used for the assert.

Type Parameters:

T - the type of the value

Parameters:

message - the message for the AssertionError (null ok)

value - the value

matcher - the Matcher for the value

Throws:

AssertionError - if the assertion fails

assertThat

public static <T> void assertThat(String message,
                                  T value,
                                  org.hamcrest.Matcher<? super T> matcher,
                                  com.oracle.bedrock.Option... options)
                           throws AssertionError

Asserts that a value will eventually satisfy the specified Matcher using the provided Options.

Should the value be the result of a call to DeferredHelper.invoking(Deferred) the result is unwrapped into a Deferred that is then used for the assert.

Type Parameters:

T - the type of the value

Parameters:

message - the message for the AssertionError (null ok)

value - the value

matcher - the Matcher for the value

options - the Options

Throws:

AssertionError - if the assertion fails

assertThat

public static <T> void assertThat(String message,
                                  com.oracle.bedrock.deferred.Deferred<T> deferred,
                                  org.hamcrest.Matcher<? super T> matcher,
                                  com.oracle.bedrock.Option... options)
                           throws AssertionError

Asserts that a Deferred value, when it becomes available, will eventually satisfy the specified Matcher within the bounds of the provided Options.

Type Parameters:

T - the type of the value

Parameters:

message - the message for the AssertionError (null ok)

deferred - the Deferred value

matcher - the Matcher for the value

options - the Options

Throws:

AssertionError - if the assertion fails

assertThat

public static <T> void assertThat(JavaApplication application,
                                  RemoteCallable<T> callable,
                                  org.hamcrest.Matcher<? super T> matcher)
                           throws AssertionError

Asserts that the specified RemoteCallable submitted to the JavaApplication will eventually match the specified matcher using the specified Options.

Type Parameters:

T - the type of the value

Parameters:

application - the JavaApplication to which the RemoteCallable will be submitted

callable - the RemoteCallable

matcher - the Matcher representing the desire condition to match

Throws:

AssertionError - if the assertion fails

assertThat

public static <T> void assertThat(JavaApplication application,
                                  RemoteCallable<T> callable,
                                  org.hamcrest.Matcher<? super T> matcher,
                                  com.oracle.bedrock.Option... options)
                           throws AssertionError

Asserts that the specified RemoteCallable submitted to the JavaApplication will eventually satisfy the specified matcher using the provided Options.

Type Parameters:

T - the type of the value

Parameters:

application - the JavaApplication to which the RemoteCallable will be submitted

callable - the RemoteCallable

matcher - the Matcher representing the desire condition to match

options - the Options

Throws:

AssertionError - if the assertion fails

within

public static com.oracle.bedrock.options.Timeout within(long duration,
                                                        TimeUnit units)

Obtains a Timeout with the specified duration.

Parameters:

duration - the duration

units - the duration units

Returns:

a Timeout

delayedBy

public static com.oracle.bedrock.deferred.options.InitialDelay delayedBy(long duration,
                                                                         TimeUnit units)

Obtains a InitialDelay for the specified values.

Parameters:

duration - the delay duration

units - the delay duration units

Returns:

a InitialDelay