org.springframework.boot.jdbc

Enum EmbeddedDatabaseConnection

java.lang.Object

java.lang.Enum<EmbeddedDatabaseConnection>

org.springframework.boot.jdbc.EmbeddedDatabaseConnection

All Implemented Interfaces:

Serializable, Comparable<EmbeddedDatabaseConnection>

public enum EmbeddedDatabaseConnection
extends Enum<EmbeddedDatabaseConnection>

Connection details for embedded databases.

Since:

1.0.0

Author:

Phillip Webb, Dave Syer, Stephane Nicoll, Nidhi Desai

See Also:

get(ClassLoader)

Enum Constant Summary

Enum Constants

Enum Constant and Description
DERBY Derby Database Connection.
H2 H2 Database Connection.
HSQL Deprecated. since 2.4.0 for removal in 2.6.0 in favor of HSQLDB.
HSQLDB HSQL Database Connection.
NONE No Connection.

Method Summary

Modifier and Type	Method and Description
static EmbeddedDatabaseConnection	get(ClassLoader classLoader) Returns the most suitable EmbeddedDatabaseConnection for the given class loader.
String	getDriverClassName() Returns the driver class name.
EmbeddedDatabaseType	getType() Returns the EmbeddedDatabaseType for the connection.
String	getUrl(String databaseName) Returns the URL for the connection using the specified databaseName.
static boolean	isEmbedded(DataSource dataSource) Convenience method to determine if a given data source represents an embedded database type.
static boolean	isEmbedded(String driverClass) Deprecated. since 2.4.0 for removal in 2.6.0 in favor of isEmbedded(String, String)
static boolean	isEmbedded(String driverClass, String url) Convenience method to determine if a given driver class name and url represent an embedded database type.
static EmbeddedDatabaseConnection	valueOf(String name) Returns the enum constant of this type with the specified name.
static EmbeddedDatabaseConnection[]	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

NONE

public static final EmbeddedDatabaseConnection NONE

No Connection.

H2

public static final EmbeddedDatabaseConnection H2

H2 Database Connection.

DERBY

public static final EmbeddedDatabaseConnection DERBY

Derby Database Connection.

HSQL

@Deprecated
public static final EmbeddedDatabaseConnection HSQL

Deprecated. since 2.4.0 for removal in 2.6.0 in favor of HSQLDB.

HSQL Database Connection.

HSQLDB

public static final EmbeddedDatabaseConnection HSQLDB

HSQL Database Connection.

Since:

2.4.0

Method Detail

values

public static EmbeddedDatabaseConnection[] 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 (EmbeddedDatabaseConnection c : EmbeddedDatabaseConnection.values())
    System.out.println(c);

Returns:

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

valueOf

public static EmbeddedDatabaseConnection valueOf(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:

IllegalArgumentException - if this enum type 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

getType

public EmbeddedDatabaseType getType()

Returns the EmbeddedDatabaseType for the connection.

Returns:

the database type

getUrl

public String getUrl(String databaseName)

Returns the URL for the connection using the specified databaseName.

Parameters:

databaseName - the name of the database

Returns:

the connection URL

isEmbedded

@Deprecated
public static boolean isEmbedded(String driverClass)

Deprecated. since 2.4.0 for removal in 2.6.0 in favor of isEmbedded(String, String)

Convenience method to determine if a given driver class name represents an embedded database type.

Parameters:

driverClass - the driver class

Returns:

true if the driver class is one of the embedded types

isEmbedded

public static boolean isEmbedded(String driverClass,
                                 String url)

Convenience method to determine if a given driver class name and url represent an embedded database type.

Parameters:

driverClass - the driver class

url - the jdbc url (can be null)

Returns:

true if the driver class and url refer to an embedded database

Since:

2.4.0

isEmbedded

public static boolean isEmbedded(DataSource dataSource)

Convenience method to determine if a given data source represents an embedded database type.

Parameters:

dataSource - the data source to interrogate

Returns:

true if the data source is one of the embedded types

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.