Package org.jdbi.v3.sqlobject

Class GeneratorSqlObjectFactory

java.lang.Object

org.jdbi.v3.sqlobject.GeneratorSqlObjectFactory

All Implemented Interfaces:

ExtensionFactory, org.jdbi.v3.core.internal.OnDemandExtensions.Factory

public final class GeneratorSqlObjectFactory
extends Object
implements org.jdbi.v3.core.internal.OnDemandExtensions.Factory

Support for generator instances (concrete classes that have been created by the Jdbi generator).

Nested Class Summary

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

ExtensionFactory.FactoryFlag

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)	Attach a sql object from a jdbi generator created class.
void	buildExtensionMetadata(ExtensionMetadata.Builder builder)	Receives the ExtensionMetadata.Builder when the ExtensionMetadata object for this extension is created.
Collection<ConfigCustomizerFactory>	getConfigCustomizerFactories(ConfigRegistry config)	Returns a collection of ConfigCustomizerFactory objects.
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.
Optional<Object>	onDemand(Jdbi jdbi, Class<?> extensionType, Class<?>... extraTypes)

Methods inherited from class java.lang.Object

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

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

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)

Attach a sql object from a jdbi generator created class.

Specified by:

attach in interface ExtensionFactory

Type Parameters:

E - the extension type

Parameters:

extensionType - the type of sql object to create.

handleSupplier - the Handle instance to attach this sql object to.

Returns:

the new sql object bound to this handle.

See Also:

• Jdbi.onDemand(Class)

onDemand

public Optional<Object> onDemand(Jdbi jdbi,
 Class<?> extensionType,
 Class<?>... extraTypes)

Specified by:

onDemand in interface org.jdbi.v3.core.internal.OnDemandExtensions.Factory

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

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

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

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