Package org.jdbi.v3.core.extension

Class ExtensionFactoryDelegate

java.lang.Object

org.jdbi.v3.core.extension.ExtensionFactoryDelegate

All Implemented Interfaces:

ExtensionFactory

final class ExtensionFactoryDelegate
extends Object
implements ExtensionFactory

Nested Class Summary

Nested classes/interfaces inherited from interface org.jdbi.v3.core.extension.ExtensionFactory

ExtensionFactory.FactoryFlag

Field Summary

Fields

Modifier and Type	Field	Description
private final ExtensionFactory	delegatedFactory

Constructor Summary

Constructors

Constructor	Description
ExtensionFactoryDelegate(ExtensionFactory delegatedFactory)

Method Summary

Modifier and Type	Method	Description
boolean	accepts(Class<?> extensionType)	Returns true if the factory can process the given extension type.
<E> E	attach(Class<E> extensionType, HandleSupplier handleSupplier)	Attaches an extension type.
void	buildExtensionMetadata(ExtensionMetadata.Builder builder)	Receives the ExtensionMetadata.Builder when the ExtensionMetadata object for this extension is created.
private Optional<Method>	checkMethodPresent(Class<?> extensionType, Class<?> klass, String methodName, Class<?>... parameterTypes)	returns Optional.empty() if the method exists in the extension type, otherwise a fallback method.
Collection<ConfigCustomizerFactory>	getConfigCustomizerFactories(ConfigRegistry config)	Returns a collection of ConfigCustomizerFactory objects.
(package private) ExtensionFactory	getDelegatedFactory()
Collection<ExtensionHandlerCustomizer>	getExtensionHandlerCustomizers(ConfigRegistry config)	Returns a collection of ExtensionHandlerCustomizer objects.
Collection<ExtensionHandlerFactory>	getExtensionHandlerFactories(ConfigRegistry config)	Returns a collection of ExtensionHandlerFactory objects.
Set<ExtensionFactory.FactoryFlag>	getFactoryFlags()	Returns a set of ExtensionFactory.FactoryFlags that describe the extension factory.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

delegatedFactory

private final ExtensionFactory delegatedFactory

Constructor Details

ExtensionFactoryDelegate

ExtensionFactoryDelegate(ExtensionFactory delegatedFactory)

Method Details

accepts

public boolean accepts(Class<?> extensionType)

Description copied from interface: ExtensionFactory

Returns true if the factory can process the given extension type.

Specified by:

accepts in interface ExtensionFactory

Parameters:

extensionType - the extension type

Returns:

whether the factory can produce an extension of the given type

getDelegatedFactory

ExtensionFactory getDelegatedFactory()

getExtensionHandlerFactories

public Collection<ExtensionHandlerFactory> getExtensionHandlerFactories(ConfigRegistry config)

Description copied from interface: ExtensionFactory

Returns a collection of ExtensionHandlerFactory objects. These factories are used in addition to the factories that have been registered with Extensions.registerHandlerFactory(org.jdbi.v3.core.extension.ExtensionHandlerFactory).
Handler factories returned here can customize the behavior of the Extension factory itself.

Specified by:

getExtensionHandlerFactories in interface ExtensionFactory

Parameters:

config - A Configuration registry object that can be used to look up additional information

Returns:

A collection of ExtensionHandlerFactory objects. Can be empty, must not be null

getExtensionHandlerCustomizers

public Collection<ExtensionHandlerCustomizer> getExtensionHandlerCustomizers(ConfigRegistry config)

Description copied from interface: ExtensionFactory

Returns a collection of ExtensionHandlerCustomizer objects. These customizers are used in addition to the customizers that have been registered with Extensions.registerHandlerCustomizer(org.jdbi.v3.core.extension.ExtensionHandlerCustomizer).
Handler customizers returned here can customize the behavior of the Handlers returned by the handler factories.

Specified by:

getExtensionHandlerCustomizers in interface ExtensionFactory

Parameters:

config - A Configuration registry object that can be used to look up additional information

Returns:

A collection of ExtensionHandlerCustomizer objects. Can be empty, must not be null

getConfigCustomizerFactories

public Collection<ConfigCustomizerFactory> getConfigCustomizerFactories(ConfigRegistry config)

Description copied from interface: ExtensionFactory

Returns a collection of ConfigCustomizerFactory objects.
Each factory is called once for every type that is attached by the factory and once for each method in the type. They can return ConfigCustomizer instances that will affect the specific configuration for each method and extension type.

Specified by:

getConfigCustomizerFactories in interface ExtensionFactory

Parameters:

config - A Configuration registry object that can be used to look up additional information

Returns:

A collection of ConfigCustomizerFactory objects. Can be empty, must not be null

buildExtensionMetadata

public void buildExtensionMetadata(ExtensionMetadata.Builder builder)

Description copied from interface: ExtensionFactory

Receives the ExtensionMetadata.Builder when the ExtensionMetadata object for this extension is created. The factory can add additional method handlers or specific instance and method customizers as needed.
Code here can call methods on the builder to configure the metadata object.

Specified by:

buildExtensionMetadata in interface ExtensionFactory

Parameters:

builder - The builder object that is used to create the ExtensionMetadata object

getFactoryFlags

public Set<ExtensionFactory.FactoryFlag> getFactoryFlags()

Description copied from interface: ExtensionFactory

Returns a set of ExtensionFactory.FactoryFlags that describe the extension factory.

Specified by:

getFactoryFlags in interface ExtensionFactory

Returns:

A set of ExtensionFactory.FactoryFlag elements. Default is the empty set

attach

public <E> E attach(Class<E> extensionType,
 HandleSupplier handleSupplier)

Description copied from interface: ExtensionFactory

Attaches an extension type. This method is not called if ExtensionFactory.getFactoryFlags() contains ExtensionFactory.FactoryFlag.NON_VIRTUAL_FACTORY.

Specified by:

attach in interface ExtensionFactory

Type Parameters:

E - the extension type

Parameters:

extensionType - The extension type

handleSupplier - Supplies the database handle. This supplier may lazily open a Handle on the first invocation. Extension implementors should take care not to fetch the handle before it is needed, to avoid opening handles unnecessarily

Returns:

An extension of the given type, attached to the given handle

See Also:

• Jdbi.onDemand(Class)

checkMethodPresent

private Optional<Method> checkMethodPresent(Class<?> extensionType,
 Class<?> klass,
 String methodName,
 Class<?>... parameterTypes)

returns Optional.empty() if the method exists in the extension type, otherwise a fallback method.

toString

public String toString()

Overrides:

toString in class Object