org.jdbi.v3.core.extension

Class Extensions

java.lang.Object

org.jdbi.v3.core.extension.Extensions

All Implemented Interfaces:

JdbiConfig<Extensions>

public class Extensions
extends Object
implements JdbiConfig<Extensions>

Configuration class for defining Jdbi extensions via ExtensionFactory instances.

Constructor Summary

Constructors

Constructor and Description
Extensions() Create an empty ExtensionFactory configuration.

Method Summary

Modifier and Type	Method and Description
Extensions	createCopy() Returns a copy of this configuration object.
<F extends ExtensionFactory> Optional<F>	findFactory(Class<F> factoryType) Find the registered factory of the given type, if any
<E> Optional<E>	findFor(Class<E> extensionType, HandleSupplier handle) Create an extension instance if we have a factory that understands the extension type which has access to a Handle through a HandleSupplier.
boolean	hasExtensionFor(Class<?> extensionType)
Extensions	register(ExtensionFactory factory) Register an extension factory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jdbi.v3.core.config.JdbiConfig

setRegistry

Constructor Detail

Extensions

public Extensions()

Create an empty ExtensionFactory configuration.

Method Detail

createCopy

public Extensions createCopy()

Description copied from interface: JdbiConfig

Returns a copy of this configuration object. Changes to the copy should not modify the original, and vice-versa.

Specified by:

createCopy in interface JdbiConfig<Extensions>

Returns:

a copy of this configuration object.

findFactory

public <F extends ExtensionFactory> Optional<F> findFactory(Class<F> factoryType)

Find the registered factory of the given type, if any

Type Parameters:

F - the factory type to find

Parameters:

factoryType - the factory's type to find

Returns:

the found factory, if any

findFor

public <E> Optional<E> findFor(Class<E> extensionType,
                               HandleSupplier handle)

Create an extension instance if we have a factory that understands the extension type which has access to a Handle through a HandleSupplier.

Type Parameters:

E - the extension type to create

Parameters:

extensionType - the extension type to create

handle - the handle supplier

Returns:

an attached extension instance if a factory is found

hasExtensionFor

public boolean hasExtensionFor(Class<?> extensionType)

Parameters:

extensionType - the type to query

Returns:

true if a registered extension handles the type

register

public Extensions register(ExtensionFactory factory)

Register an extension factory.

Parameters:

factory - the factory to register

Returns:

this