Deprecated API

Contents

• Interfaces
• Classes
• Annotation Types
• Fields
• Methods
• Constructors
• Enum Constants

Deprecated Interfaces

Interface	Description
org.jdbi.v3.core.statement.SqlLoggable	this class is not for end-user use and should not be in the public API.
org.jdbi.v3.core.statement.TimingCollector	Use SqlLogger instead.
org.jdbi.v3.sqlobject.config.Configurer	Use ExtensionConfigurer directly.
org.jdbi.v3.sqlobject.Handler	Use ExtensionHandler directly.
org.jdbi.v3.sqlobject.HandlerDecorator	Use ExtensionHandlerCustomizer directly.
org.jdbi.v3.sqlobject.HandlerFactory	Use ExtensionHandlerFactory instances directly.

Deprecated Classes

Class	Description
org.jdbi.v3.core.argument.BeanPropertyArguments	this should never have been public API
org.jdbi.v3.core.argument.BuiltInArgumentFactory	will be replaced by a plugin
org.jdbi.v3.core.argument.MapArguments	use SqlStatement.bindMap(Map) instead
org.jdbi.v3.core.argument.ObjectFieldArguments	this functionality will remain supported, but this class should not be API
org.jdbi.v3.core.argument.ObjectMethodArguments	this functionality will remain supported, but this class should not be API
org.jdbi.v3.core.collector.BuiltInCollectorFactory	will be replaced by plugin
org.jdbi.v3.core.mapper.BuiltInMapperFactory	will be replaced by an opt-out plugin to give the core no hardwired behavior
org.jdbi.v3.core.mapper.EnumByNameMapperFactory	Use getConfig(Enums.class).setEnumStrategy(BY_NAME) instead.
org.jdbi.v3.core.mapper.EnumByOrdinalMapperFactory	Use getConfig(Enums.class).setEnumStrategy(BY_ORDINAL) instead.
org.jdbi.v3.core.statement.MessageFormatTemplateEngine	MessageFormat formats integers with decimal separators, e.g. 1000 → "1,000". This hindsight realization has led us to discourage its use.
org.jdbi.v3.sqlobject.HandlerDecorators	Use ExtensionHandlerCustomizer instances which are returned directly from the ExtensionFactory.getExtensionHandlerCustomizers(ConfigRegistry).
org.jdbi.v3.sqlobject.Handlers	Use ExtensionHandlerFactory instances that are returned from the ExtensionFactory.getExtensionHandlerFactories(ConfigRegistry) method.

Deprecated Annotation Types

Annotation Type	Description
org.jdbi.v3.sqlobject.config.ConfiguringAnnotation	Use UseExtensionConfigurer.
org.jdbi.v3.sqlobject.DecoratorOrder	Use UseExtensionHandlerCustomizer to mark annotations and ExtensionHandlerCustomizationOrder instead.
org.jdbi.v3.sqlobject.SqlMethodDecoratingAnnotation	Use UseExtensionHandlerCustomizer instead and implement ExtensionHandlerCustomizer for the value.
org.jdbi.v3.sqlobject.SqlOperation	Use UseExtensionHandler and SqlObjectFactory.EXTENSION_ID as the id marker.

Deprecated Fields

Field	Description
org.jdbi.v3.core.statement.TimingCollector.NOP_TIMING_COLLECTOR	Use SqlLogger.NOP_SQL_LOGGER instead.

Deprecated Methods

Method	Description
org.jdbi.v3.core.argument.ArgumentFactory.Preparable.prePreparedTypes()	no longer used
org.jdbi.v3.core.argument.QualifiedArgumentFactory.Preparable.prePreparedTypes()	no longer used
org.jdbi.v3.core.collector.BuiltInCollectorFactory.toMap(Supplier<M>)	Use MapCollectors.toMap(Supplier) instead.
org.jdbi.v3.core.collector.BuiltInCollectorFactory.toOptional()	Use OptionalCollectors.toOptional() instead.
org.jdbi.v3.core.config.Configurable.setTimingCollector(TimingCollector)	use Configurable.setSqlLogger(org.jdbi.v3.core.statement.SqlLogger) instead
org.jdbi.v3.core.Handle.release(String)	Use Handle.releaseSavepoint(String)
org.jdbi.v3.core.Handle.setTransactionIsolation(int)	Use Handle.setTransactionIsolationLevel(TransactionIsolationLevel)
org.jdbi.v3.core.Handle.setTransactionIsolation(TransactionIsolationLevel)	Use Handle.setTransactionIsolationLevel(int)
org.jdbi.v3.core.locator.ClasspathSqlLocator.findSqlOnClasspath(Class<?>, String)	ClasspathSqlLocator.create() an instance instead of using static methods
org.jdbi.v3.core.locator.ClasspathSqlLocator.findSqlOnClasspath(String)	ClasspathSqlLocator.create() an instance instead of using static methods
org.jdbi.v3.core.locator.ClasspathSqlLocator.getResourceOnClasspath(ClassLoader, String)	ClasspathSqlLocator.create() an instance instead of using static methods
org.jdbi.v3.core.locator.ClasspathSqlLocator.getResourceOnClasspath(String)	ClasspathSqlLocator.create() an instance instead of using static methods
org.jdbi.v3.core.mapper.reflect.ReflectionMapperUtil.getColumnNames(ResultSet)	Use ReflectionMapperUtil.getColumnNames(ResultSet, UnaryOperator) and CaseStrategy to control name capitalization
org.jdbi.v3.core.result.ResultIterable.findOnly()	use ResultIterable.one() or ResultIterable.findOne() instead.
org.jdbi.v3.core.statement.Binding.findForName(String, StatementContext)	don't inspect a Binding: keep your own state!
org.jdbi.v3.core.statement.Binding.findForPosition(int)	don't inspect a Binding: keep your own state!
org.jdbi.v3.core.statement.Binding.getNames()	this is expensive to compute, and it's bad practice to inspect a Binding: keep track of your own state!
org.jdbi.v3.core.statement.PreparedBatch.executeAndReturnGeneratedKeys(String...)	Use PreparedBatch.executePreparedBatch(String...) which has the same functionality but also returns the per-batch modified row counts.
org.jdbi.v3.core.statement.SqlStatements.getTimingCollector()	use SqlStatements.getSqlLogger() instead
org.jdbi.v3.core.statement.SqlStatements.setTimingCollector(TimingCollector)	use SqlStatements.setSqlLogger(org.jdbi.v3.core.statement.SqlLogger) instead
org.jdbi.v3.core.statement.TimingCollector.collect(long, StatementContext)	Use SqlLogger.logAfterExecution(org.jdbi.v3.core.statement.StatementContext) instead.
org.jdbi.v3.freemarker.FreemarkerSqlLocator.findTemplate(Class<?>, String)	this static method does not respect configuration, use FreemarkerConfig.createLocator()
org.jdbi.v3.sqlobject.customizer.BindList.EmptyHandling.define(SqlStatement, String)	legacy internal API
org.jdbi.v3.testing.JdbiRule.migrateWithFlyway()	use JdbiRule.withMigration(Migration)
org.jdbi.v3.testing.JdbiRule.migrateWithFlyway(String...)	use JdbiRule.withMigration(Migration)
org.jdbi.v3.testing.junit5.JdbiFlywayMigration.cleanAfter()	The default changed to true so this call actually does nothing.

Deprecated Constructors

Constructor	Description
org.jdbi.v3.core.argument.ObjectArgument(Object, Integer)	use ObjectArgument.of(Object, Integer) factory method for more consistent null handling
org.jdbi.v3.core.mapper.MapMapper(boolean)	use MapMappers.setCaseChange(UnaryOperator) instead.
org.jdbi.v3.freemarker.FreemarkerEngine()	use FreemarkerEngine.instance() for a shared engine instead

Deprecated Enum Constants

Enum Constant	Description
org.jdbi.v3.sqlobject.customizer.BindList.EmptyHandling.NULL	vaguely named in light of new additions, use BindList.EmptyHandling.NULL_STRING instead