Class ExtensionMetadata.Builder

java.lang.Object

org.jdbi.v3.core.extension.ExtensionMetadata.Builder

Enclosing class:

ExtensionMetadata

public static final class ExtensionMetadata.Builder
extends Object

Builder class for the ExtensionMetadata object. See ExtensionMetadata.builder(Class).

Since:

3.38.0

Method Summary

Modifier and Type	Method	Description
ExtensionMetadata.Builder	addConfigCustomizerFactory(ConfigCustomizerFactory configCustomizerFactory)	Adds an ConfigCustomizerFactory that will be used to find configuration customizers when the build()} method is called.
ExtensionMetadata.Builder	addExtensionHandlerCustomizer(ExtensionHandlerCustomizer extensionHandlerCustomizer)	Adds an ExtensionHandlerCustomizer that will be used to customize extension handlers when the build()} method is called.
ExtensionMetadata.Builder	addExtensionHandlerFactory(ExtensionHandlerFactory extensionHandlerFactory)	Adds an ExtensionHandlerFactory that will be used to find extension handlers when the build()} method is called.
ExtensionMetadata.Builder	addInstanceConfigCustomizer(ConfigCustomizer configCustomizer)	Add an instance specific configuration customizer.
ExtensionMetadata.Builder	addMethodConfigCustomizer(Method method, ConfigCustomizer configCustomizer)	Add a method specific configuration customizer.
ExtensionMetadata.Builder	addMethodHandler(Method method, ExtensionHandler handler)	Adds a new extension handler for a method.
ExtensionMetadata	build()	Creates a new ExtensionMetadata object.
Class<?>	getExtensionType()	Returns the extension type from the builder.
ExtensionMetadata.Builder	setExtensionTypeMethods(Collection<Method> methods)	Sets the methods of the extension type that need extension handlers.

Methods inherited from class Object

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

Method Details

setExtensionTypeMethods

@Alpha
public ExtensionMetadata.Builder setExtensionTypeMethods(Collection<Method> methods)

Sets the methods of the extension type that need extension handlers. By default, the builder discovers these methods through reflection when build() is called. Code that already holds the methods of the extension type, such as code created by the Jdbi generator, can supply them here so that no reflective discovery takes place. This matters for GraalVM native image, where an unregistered type reports no methods.

Parameters:

methods - The methods of the extension type

Returns:

The builder instance

Since:

3.55.0

addExtensionHandlerFactory

public ExtensionMetadata.Builder addExtensionHandlerFactory(ExtensionHandlerFactory extensionHandlerFactory)

Adds an ExtensionHandlerFactory that will be used to find extension handlers when the build()} method is called.

Parameters:

extensionHandlerFactory - An ExtensionHandlerFactory instance

Returns:

The builder instance

addExtensionHandlerCustomizer

public ExtensionMetadata.Builder addExtensionHandlerCustomizer(ExtensionHandlerCustomizer extensionHandlerCustomizer)

Adds an ExtensionHandlerCustomizer that will be used to customize extension handlers when the build()} method is called.

Parameters:

extensionHandlerCustomizer - An ExtensionHandlerCustomizer instance

Returns:

The builder instance

addConfigCustomizerFactory

public ExtensionMetadata.Builder addConfigCustomizerFactory(ConfigCustomizerFactory configCustomizerFactory)

Adds an ConfigCustomizerFactory that will be used to find configuration customizers when the build()} method is called.

Parameters:

configCustomizerFactory - An ConfigCustomizerFactory instance

Returns:

The builder instance

addInstanceConfigCustomizer

public ExtensionMetadata.Builder addInstanceConfigCustomizer(ConfigCustomizer configCustomizer)

Add an instance specific configuration customizer. This customizer will be applied to all methods on the extension type.

Parameters:

configCustomizer - A ConfigCustomizer

Returns:

The builder instance

addMethodConfigCustomizer

public ExtensionMetadata.Builder addMethodConfigCustomizer(Method method,
 ConfigCustomizer configCustomizer)

Add a method specific configuration customizer. This customizer will be applied only to the method given here.

Parameters:

method - A method object

configCustomizer - A ConfigCustomizer

Returns:

The builder instance

addMethodHandler

public ExtensionMetadata.Builder addMethodHandler(Method method,
 ExtensionHandler handler)

Adds a new extension handler for a method.

Parameters:

method - The method for which an extension handler should be registered.

handler - An ExtensionHandler instance

Returns:

The builder instance

getExtensionType

public Class<?> getExtensionType()

Returns the extension type from the builder.

Returns:

The extension type

build

public ExtensionMetadata build()

Creates a new ExtensionMetadata object.

Returns:

A ExtensionMetadata object