Package org.springframework.boot.r2dbc

Enum Class EmbeddedDatabaseConnection

java.lang.Object

java.lang.Enum<EmbeddedDatabaseConnection>

org.springframework.boot.r2dbc.EmbeddedDatabaseConnection

All Implemented Interfaces:

Serializable, Comparable<EmbeddedDatabaseConnection>, Constable

public enum EmbeddedDatabaseConnection
extends Enum<EmbeddedDatabaseConnection>

Connection details for embedded databases compatible with R2DBC.

Since:

2.5.0

Author:

Mark Paluch, Stephane Nicoll

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
H2	H2 Database Connection.
NONE	No Connection.

Method Summary

Modifier and Type	Method	Description
static EmbeddedDatabaseConnection	get(ClassLoader classLoader)	Returns the most suitable EmbeddedDatabaseConnection for the given class loader.
String	getDriverClassName()	Returns the driver class name.
String	getUrl(String databaseName)	Returns the R2DBC URL for the connection using the specified databaseName.
static boolean	isEmbedded(io.r2dbc.spi.ConnectionFactory connectionFactory)	Convenience method to determine if a given connection factory represents an embedded database type.
static EmbeddedDatabaseConnection	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EmbeddedDatabaseConnection[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final EmbeddedDatabaseConnection NONE

No Connection.

H2

public static final EmbeddedDatabaseConnection H2

H2 Database Connection.

Method Details

values

public static EmbeddedDatabaseConnection[] 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 EmbeddedDatabaseConnection 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

getDriverClassName

public String getDriverClassName()

Returns the driver class name.

Returns:

the driver class name

getUrl

public String getUrl(String databaseName)

Returns the R2DBC URL for the connection using the specified databaseName.

Parameters:

databaseName - the name of the database

Returns:

the connection URL

get

public static EmbeddedDatabaseConnection get(ClassLoader classLoader)

Returns the most suitable EmbeddedDatabaseConnection for the given class loader.

Parameters:

classLoader - the class loader used to check for classes

Returns:

an EmbeddedDatabaseConnection or NONE.

isEmbedded

public static boolean isEmbedded(io.r2dbc.spi.ConnectionFactory connectionFactory)

Convenience method to determine if a given connection factory represents an embedded database type.

Parameters:

connectionFactory - the connection factory to interrogate

Returns:

true if the connection factory represents an embedded database

Since:

2.5.1