org.testcontainers.containers.wait.strategy

Enum WaitAllStrategy.Mode

java.lang.Object

java.lang.Enum<WaitAllStrategy.Mode>

org.testcontainers.containers.wait.strategy.WaitAllStrategy.Mode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<WaitAllStrategy.Mode>

Enclosing class:

WaitAllStrategy

public static enum WaitAllStrategy.Mode
extends java.lang.Enum<WaitAllStrategy.Mode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
WITH_INDIVIDUAL_TIMEOUTS_ONLY Using this mode triggers the following behaviour: The outer timeout is disabled and the outer enclosing strategy waits for all inner strategies according to their timeout.
WITH_MAXIMUM_OUTER_TIMEOUT This is the original mode of this strategy: The inner strategies wait with their preconfigured timeout individually and the wait all strategy kills them, if the outer limit is reached.
WITH_OUTER_TIMEOUT This is the default mode: The timeout of the strategy is applied to each individual strategy, so that the container waits maximum for WaitAllStrategy.timeout.

Method Summary

Modifier and Type	Method and Description
static WaitAllStrategy.Mode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static WaitAllStrategy.Mode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WITH_OUTER_TIMEOUT

public static final WaitAllStrategy.Mode WITH_OUTER_TIMEOUT

This is the default mode: The timeout of the strategy is applied to each individual strategy, so that the container waits maximum for WaitAllStrategy.timeout.

WITH_INDIVIDUAL_TIMEOUTS_ONLY

public static final WaitAllStrategy.Mode WITH_INDIVIDUAL_TIMEOUTS_ONLY

Using this mode triggers the following behaviour: The outer timeout is disabled and the outer enclosing strategy waits for all inner strategies according to their timeout. Once set, it disables WaitAllStrategy.withStartupTimeout(java.time.Duration) method, as it would overwrite inner timeouts.

WITH_MAXIMUM_OUTER_TIMEOUT

public static final WaitAllStrategy.Mode WITH_MAXIMUM_OUTER_TIMEOUT

This is the original mode of this strategy: The inner strategies wait with their preconfigured timeout individually and the wait all strategy kills them, if the outer limit is reached.

Method Detail

values

public static WaitAllStrategy.Mode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (WaitAllStrategy.Mode c : WaitAllStrategy.Mode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static WaitAllStrategy.Mode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null