org.jdbi.v3.sqlobject

Enum SqlObjectFactory

java.lang.Object

java.lang.Enum<SqlObjectFactory>

org.jdbi.v3.sqlobject.SqlObjectFactory

All Implemented Interfaces:

Serializable, Comparable<SqlObjectFactory>, ExtensionFactory<SqlObjectConfig>

public enum SqlObjectFactory
extends Enum<SqlObjectFactory>
implements ExtensionFactory<SqlObjectConfig>

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
boolean	accepts(Class<?> extensionType)
<E> E	attach(Class<E> extensionType, SqlObjectConfig config, Supplier<Handle> handle) Create a sql object of the specified type bound to this handle.
SqlObjectConfig	createConfig()
static SqlObjectFactory	valueOf(String name) Returns the enum constant of this type with the specified name.
static SqlObjectFactory[]	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

INSTANCE

public static final SqlObjectFactory INSTANCE

Method Detail

values

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

Returns:

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

valueOf

public static SqlObjectFactory 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

createConfig

public SqlObjectConfig createConfig()

Specified by:

createConfig in interface ExtensionFactory<SqlObjectConfig>

accepts

public boolean accepts(Class<?> extensionType)

Specified by:

accepts in interface ExtensionFactory<SqlObjectConfig>

attach

public <E> E attach(Class<E> extensionType,
                    SqlObjectConfig config,
                    Supplier<Handle> handle)

Create a sql object of the specified type bound to this handle. Any state changes to the handle, or the sql object, such as transaction status, closing it, etc, will apply to both the object and the handle.

Specified by:

attach in interface ExtensionFactory<SqlObjectConfig>

Parameters:

extensionType - the type of sql object to create

handle - the Handle instance to attach ths sql object to

Returns:

the new sql object bound to this handle