Package org.catools.common.extensions.wait.interfaces

Interface CObjectWaiter<O>

All Superinterfaces:

CBaseState<O>, CBaseWaiter<O>

All Known Subinterfaces:

CBooleanWaiter, CCollection<E>, CCollectionExtension<E>, CCollectionWaiter<E>, CDateExtension, CDateWaiter, CFileExtension, CFileWaiter, CIterable<E>, CIterableExtension<E>, CIterableWaiter<E>, CMap<K,V>, CMapExtension<K,V>, CMapWaiter<K,V>, CNumberWaiter<N>, CStringWaiter

All Known Implementing Classes:

CBooleanExtension, CConfigInfoCollection, CDate, CFile, CHashMap, CHolidayCollection, CLinkedMap, CList, CNumberExtension, CObjectExtension, CSet, CStringExtension, CTestData, CTestResults

public interface CObjectWaiter<O>
extends CBaseWaiter<O>

CObjectWaiter is an interface for Object waiter related methods.

Method Summary

Modifier and Type	Method	Description
default boolean	_waiter(java.util.function.Predicate<O> waitMethod, int waitInSeconds, int intervalInMilliSeconds)
default boolean	wait(java.util.function.Predicate<O> predicate)	Wait for CConfigs.TypeExtension.getDefaultWaitInSeconds() number of milliseconds with CConfigs.TypeExtension.getDefaultWaitIntervalInMilliSeconds() interval till predicate returns the true result
default boolean	wait(java.util.function.Predicate<O> predicate, int waitInSeconds)	Wait for defined number of seconds with CConfigs.TypeExtension.getDefaultWaitIntervalInMilliSeconds() interval till predicate returns the true result
default boolean	wait(java.util.function.Predicate<O> predicate, int waitInSeconds, int intervalInMilliSeconds)	Wait for defined number of seconds till predicate returns the true result
default boolean	waitEquals(O expected)	Wait for CConfigs.TypeExtension.getDefaultWaitInSeconds() number of milliseconds with CConfigs.TypeExtension.getDefaultWaitIntervalInMilliSeconds() interval till actual value equals to expected value.
default boolean	waitEquals(O expected, int waitInSeconds)	Wait for defined number of seconds with CConfigs.TypeExtension.getDefaultWaitIntervalInMilliSeconds() interval till actual value equals to expected value.
default boolean	waitEquals(O expected, int waitInSeconds, int intervalInMilliSeconds)	Wait for defined number of seconds till actual value equals to expected value.
default boolean	waitEqualsAny(java.util.List<O> expectedList)	Wait for CConfigs.TypeExtension.getDefaultWaitInSeconds() number of milliseconds until actual value equals to any of the expected values.
default boolean	waitEqualsAny(java.util.List<O> expectedList, int waitInSeconds)	Wait for defined number of seconds until actual value equals to any of the expected values.
default boolean	waitEqualsAny(java.util.List<O> expectedList, int waitInSeconds, int intervalInMilliSeconds)	Wait for defined number of seconds until actual value equals to any of the expected values.
default boolean	waitEqualsNone(java.util.List<O> expectedList)	Wait for CConfigs.TypeExtension.getDefaultWaitInSeconds() number of milliseconds until actual value equals none of the expected values
default boolean	waitEqualsNone(java.util.List<O> expectedList, int waitInSeconds)	Wait for defined number of seconds until actual value equals none of the expected values.
default boolean	waitEqualsNone(java.util.List<O> expectedList, int waitInSeconds, int intervalInMilliSeconds)	Wait for defined number of seconds until actual value equals none of the expected values.
default boolean	waitIsNotNull()	Wait for CConfigs.TypeExtension.getDefaultWaitInSeconds() number of milliseconds with CConfigs.TypeExtension.getDefaultWaitIntervalInMilliSeconds() interval till actual value is NOT null.
default boolean	waitIsNotNull(int waitInSeconds)	Wait for defined number of seconds with CConfigs.TypeExtension.getDefaultWaitIntervalInMilliSeconds() interval till actual value is NOT null.
default boolean	waitIsNotNull(int waitInSeconds, int intervalInMilliSeconds)	Wait for defined number of seconds till actual value is NOT null.
default boolean	waitIsNull()	Wait for CConfigs.TypeExtension.getDefaultWaitInSeconds() number of milliseconds with CConfigs.TypeExtension.getDefaultWaitIntervalInMilliSeconds() interval till actual value is null.
default boolean	waitIsNull(int waitInSeconds)	Wait for defined number of seconds with CConfigs.TypeExtension.getDefaultWaitIntervalInMilliSeconds() interval till actual value is null.
default boolean	waitIsNull(int waitInSeconds, int intervalInMilliSeconds)	Wait for defined number of seconds till actual value is null.
default boolean	waitNotEquals(O expected)	Wait for CConfigs.TypeExtension.getDefaultWaitInSeconds() number of milliseconds with CConfigs.TypeExtension.getDefaultWaitIntervalInMilliSeconds() interval till actual value does not equal to expected value.
default boolean	waitNotEquals(O expected, int waitInSeconds)	Wait for defined number of seconds with CConfigs.TypeExtension.getDefaultWaitIntervalInMilliSeconds() interval till actual value does not equal to expected value.
default boolean	waitNotEquals(O expected, int waitInSeconds, int intervalInMilliSeconds)	Wait for defined number of seconds till actual value does not equal to expected value.

Methods inherited from interface org.catools.common.extensions.states.interfaces.CBaseState

getValue

Methods inherited from interface org.catools.common.extensions.wait.interfaces.CBaseWaiter

getDefaultWaitInSeconds, getDefaultWaitIntervalInMilliSeconds

Method Detail

wait

default boolean wait(java.util.function.Predicate<O> predicate)

Wait for CConfigs.TypeExtension.getDefaultWaitInSeconds() number of milliseconds with CConfigs.TypeExtension.getDefaultWaitIntervalInMilliSeconds() interval till predicate returns the true result

Parameters:

predicate - predicate to test.

Returns:

true if wait operation succeed otherwise return false

wait

default boolean wait(java.util.function.Predicate<O> predicate,
                     int waitInSeconds)

Wait for defined number of seconds with CConfigs.TypeExtension.getDefaultWaitIntervalInMilliSeconds() interval till predicate returns the true result

Parameters:

predicate - predicate to test.

waitInSeconds - maximum wait time.

Returns:

true if wait operation succeed otherwise return false

wait

default boolean wait(java.util.function.Predicate<O> predicate,
                     int waitInSeconds,
                     int intervalInMilliSeconds)

Wait for defined number of seconds till predicate returns the true result

Parameters:

predicate - predicate to test.

waitInSeconds - maximum wait time.

intervalInMilliSeconds - interval between retries in milliseconds

Returns:

true if wait operation succeed otherwise return false

waitIsNull

default boolean waitIsNull()

Wait for CConfigs.TypeExtension.getDefaultWaitInSeconds() number of milliseconds with CConfigs.TypeExtension.getDefaultWaitIntervalInMilliSeconds() interval till actual value is null.

Returns:

true if wait operation succeed otherwise return false

waitIsNull

default boolean waitIsNull(int waitInSeconds)

Wait for defined number of seconds with CConfigs.TypeExtension.getDefaultWaitIntervalInMilliSeconds() interval till actual value is null.

Parameters:

waitInSeconds - maximum wait time

Returns:

true if wait operation succeed otherwise return false

waitIsNull

default boolean waitIsNull(int waitInSeconds,
                           int intervalInMilliSeconds)

Wait for defined number of seconds till actual value is null.

Parameters:

waitInSeconds - maximum wait time

intervalInMilliSeconds - interval between retries in milliseconds

Returns:

true if wait operation succeed otherwise return false

waitIsNotNull

default boolean waitIsNotNull()

Wait for CConfigs.TypeExtension.getDefaultWaitInSeconds() number of milliseconds with CConfigs.TypeExtension.getDefaultWaitIntervalInMilliSeconds() interval till actual value is NOT null.

Returns:

true if wait operation succeed otherwise return false

waitIsNotNull

default boolean waitIsNotNull(int waitInSeconds)

Wait for defined number of seconds with CConfigs.TypeExtension.getDefaultWaitIntervalInMilliSeconds() interval till actual value is NOT null.

Parameters:

waitInSeconds - maximum wait time

Returns:

true if wait operation succeed otherwise return false

waitIsNotNull

default boolean waitIsNotNull(int waitInSeconds,
                              int intervalInMilliSeconds)

Wait for defined number of seconds till actual value is NOT null.

Parameters:

waitInSeconds - maximum wait time

intervalInMilliSeconds - interval between retries in milliseconds

Returns:

true if wait operation succeed otherwise return false

waitEquals

default boolean waitEquals(O expected)

Wait for CConfigs.TypeExtension.getDefaultWaitInSeconds() number of milliseconds with CConfigs.TypeExtension.getDefaultWaitIntervalInMilliSeconds() interval till actual value equals to expected value.

Parameters:

expected - value to compare

Returns:

true if wait operation succeed otherwise return false

waitEquals

default boolean waitEquals(O expected,
                           int waitInSeconds)

Wait for defined number of seconds with CConfigs.TypeExtension.getDefaultWaitIntervalInMilliSeconds() interval till actual value equals to expected value.

Parameters:

expected - value to compare

waitInSeconds - maximum wait time

Returns:

true if wait operation succeed otherwise return false

waitEquals

default boolean waitEquals(O expected,
                           int waitInSeconds,
                           int intervalInMilliSeconds)

Wait for defined number of seconds till actual value equals to expected value.

Parameters:

expected - value to compare

waitInSeconds - maximum wait time

intervalInMilliSeconds - interval between retries in milliseconds

Returns:

true if wait operation succeed otherwise return false

waitNotEquals

default boolean waitNotEquals(O expected)

Wait for CConfigs.TypeExtension.getDefaultWaitInSeconds() number of milliseconds with CConfigs.TypeExtension.getDefaultWaitIntervalInMilliSeconds() interval till actual value does not equal to expected value.

Parameters:

expected - value to compare

Returns:

true if wait operation succeed otherwise return false

waitNotEquals

default boolean waitNotEquals(O expected,
                              int waitInSeconds)

Wait for defined number of seconds with CConfigs.TypeExtension.getDefaultWaitIntervalInMilliSeconds() interval till actual value does not equal to expected value.

Parameters:

expected - value to compare

waitInSeconds - maximum wait time

Returns:

true if wait operation succeed otherwise return false

waitNotEquals

default boolean waitNotEquals(O expected,
                              int waitInSeconds,
                              int intervalInMilliSeconds)

Wait for defined number of seconds till actual value does not equal to expected value.

Parameters:

expected - value to compare

waitInSeconds - maximum wait time

intervalInMilliSeconds - interval between retries in milliseconds

Returns:

true if wait operation succeed otherwise return false

waitEqualsAny

default boolean waitEqualsAny(java.util.List<O> expectedList)

Wait for CConfigs.TypeExtension.getDefaultWaitInSeconds() number of milliseconds until actual value equals to any of the expected values.

Parameters:

expectedList - a list of values, may be null.

Returns:

true if wait operation succeed otherwise return false

waitEqualsAny

default boolean waitEqualsAny(java.util.List<O> expectedList,
                              int waitInSeconds)

Wait for defined number of seconds until actual value equals to any of the expected values.

Parameters:

expectedList - a list of values, may be null.

waitInSeconds - maximum wait time.

Returns:

true if wait operation succeed otherwise return false

waitEqualsAny

default boolean waitEqualsAny(java.util.List<O> expectedList,
                              int waitInSeconds,
                              int intervalInMilliSeconds)

Wait for defined number of seconds until actual value equals to any of the expected values.

Parameters:

expectedList - a list of values, may be null.

waitInSeconds - maximum wait time.

intervalInMilliSeconds - interval between retries in milliseconds

Returns:

true if wait operation succeed otherwise return false

waitEqualsNone

default boolean waitEqualsNone(java.util.List<O> expectedList)

Wait for CConfigs.TypeExtension.getDefaultWaitInSeconds() number of milliseconds until actual value equals none of the expected values

Parameters:

expectedList - a list of values, may be null.

Returns:

true if wait operation succeed otherwise return false

waitEqualsNone

default boolean waitEqualsNone(java.util.List<O> expectedList,
                               int waitInSeconds)

Wait for defined number of seconds until actual value equals none of the expected values.

Parameters:

expectedList - a list of values, may be null.

waitInSeconds - maximum wait time.

Returns:

true if wait operation succeed otherwise return false

waitEqualsNone

default boolean waitEqualsNone(java.util.List<O> expectedList,
                               int waitInSeconds,
                               int intervalInMilliSeconds)

Wait for defined number of seconds until actual value equals none of the expected values.

Parameters:

expectedList - a list of values, may be null.

waitInSeconds - maximum wait time.

intervalInMilliSeconds - interval between retries in milliseconds

Returns:

true if wait operation succeed otherwise return false

_waiter

default boolean _waiter(java.util.function.Predicate<O> waitMethod,
                        int waitInSeconds,
                        int intervalInMilliSeconds)