Class JdbiCollectors

java.lang.Object

org.jdbi.v3.core.collector.JdbiCollectors

All Implemented Interfaces:

JdbiConfig<JdbiCollectors>

public class JdbiCollectors
extends Object
implements JdbiConfig<JdbiCollectors>

Registry of collector factories. Contains a set of collector factories, registered by the application.

Constructor Summary

Constructors

Constructor	Description
JdbiCollectors()

Method Summary

Modifier and Type	Method	Description
JdbiCollectors	createCopy()	Returns a copy of this configuration object.
Optional<Type>	findElementTypeFor(Type containerType)	Returns the element type for the given container type.
Optional<Collector<?,?,?>>	findFor(Type containerType)	Obtain a collector for the given type.
JdbiCollectors	register(CollectorFactory factory)	Register a new CollectorFactory.
JdbiCollectors	registerCollector(Type collectionType, Collector<?,?,?> collector)	Register a new Collector for the given type.

Methods inherited from class Object

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

Methods inherited from interface JdbiConfig

setRegistry

Modifier and Type	Method	Description
default void	setRegistry(ConfigRegistry registry)	The registry will inject itself into the configuration object.

Constructor Details

JdbiCollectors

public JdbiCollectors()

Method Details

register

public JdbiCollectors register(CollectorFactory factory)

Register a new CollectorFactory.

Parameters:

factory - A collector factory

Returns:

this

registerCollector

public JdbiCollectors registerCollector(Type collectionType,
 Collector<?,?,?> collector)

Register a new Collector for the given type.

Parameters:

collectionType - The type that this collector will return

collector - A Collector implementation

Returns:

this

Since:

3.38.0

See Also:

• Configurable.registerCollector(CollectorFactory)

findFor

public Optional<Collector<?,?,?>> findFor(Type containerType)

Obtain a collector for the given type.

Parameters:

containerType - the container type.

Returns:

a Collector for the given container type, or empty null if no collector is registered for the given type.

findElementTypeFor

public Optional<Type> findElementTypeFor(Type containerType)

Returns the element type for the given container type.

Parameters:

containerType - the container type.

Returns:

the element type for the given container type, if available.

createCopy

public JdbiCollectors 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<JdbiCollectors>

Returns:

a copy of this configuration object.