Enum Class AutoConfigureTestDatabase.Replace

java.lang.Object

java.lang.Enum<AutoConfigureTestDatabase.Replace>

org.springframework.boot.jdbc.test.autoconfigure.AutoConfigureTestDatabase.Replace

All Implemented Interfaces:

Serializable, Comparable<AutoConfigureTestDatabase.Replace>, Constable

Enclosing class:

AutoConfigureTestDatabase

public static enum AutoConfigureTestDatabase.Replace
extends Enum<AutoConfigureTestDatabase.Replace>

What the test database can replace.

Since:

4.0.0

Author:

Phillip Webb

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANY	Replace the DataSource bean whether it was auto-configured or manually defined.
AUTO_CONFIGURED	Only replace the DataSource if it was auto-configured.
NON_TEST	Replace the DataSource bean unless it is auto-configured and connecting to a test database.
NONE	Don't replace the application default DataSource.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NON_TEST

public static final AutoConfigureTestDatabase.Replace NON_TEST

Replace the DataSource bean unless it is auto-configured and connecting to a test database. The following types of connections are considered test databases:

• Any bean definition that includes ContainerImageMetadata (including @ServiceConnection annotated Testcontainers databases, and connections created using Docker Compose)
• Any connection configured using a spring.datasource.url backed by a @DynamicPropertySource
• Any connection configured using a spring.datasource.url with the Testcontainers JDBC syntax

ANY

public static final AutoConfigureTestDatabase.Replace ANY

Replace the DataSource bean whether it was auto-configured or manually defined.

AUTO_CONFIGURED

public static final AutoConfigureTestDatabase.Replace AUTO_CONFIGURED

Only replace the DataSource if it was auto-configured.

NONE

public static final AutoConfigureTestDatabase.Replace NONE

Don't replace the application default DataSource.

Method Details

values

public static AutoConfigureTestDatabase.Replace[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static AutoConfigureTestDatabase.Replace valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null