Interface CustomParameterBinder

public interface CustomParameterBinder

Enables PreparedStatement parameter binding customization via PreparedStatementBinder.

Since:

3.0.0

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CustomParameterBinder.BindingResult	Result of a custom parameter binding attempt.

Method Summary

Modifier and Type	Method	Description
@NonNull Boolean	appliesTo(@NonNull TargetType targetType)	Specifies which types this custom binder should handle.
@NonNull CustomParameterBinder.BindingResult	bind(@NonNull StatementContext<?> statementContext, @NonNull PreparedStatement preparedStatement, @NonNull Integer parameterIndex, @NonNull Object parameter)	Performs custom binding of a PreparedStatement value given a value and its index when appliesTo(TargetType) is true.
default @NonNull CustomParameterBinder.BindingResult	bindNull(@NonNull StatementContext<?> statementContext, @NonNull PreparedStatement preparedStatement, @NonNull Integer parameterIndex, @NonNull TargetType targetType, @NonNull Integer sqlType)	Performs custom binding of a null value given its index and targetType.

Method Details

bind

@NonNull CustomParameterBinder.BindingResult bind(@NonNull StatementContext<?> statementContext,
 @NonNull PreparedStatement preparedStatement,
 @NonNull Integer parameterIndex,
 @NonNull Object parameter)
                                           throws SQLException

Performs custom binding of a PreparedStatement value given a value and its index when appliesTo(TargetType) is true.

This function is only invoked when parameter is non-null.

Parameters:

statementContext - current SQL context

preparedStatement - the prepared statement to bind to

parameterIndex - 1-based parameter index at which to perform the binding

parameter - the parameter to bind at the specified index

Returns:

CustomParameterBinder.BindingResult.handled() if the custom binding was performed, or CustomParameterBinder.BindingResult.fallback() to fall back to default PreparedStatementBinder behavior

Throws:

SQLException - if an error occurs during binding

bindNull

default @NonNull CustomParameterBinder.BindingResult bindNull(@NonNull StatementContext<?> statementContext,
 @NonNull PreparedStatement preparedStatement,
 @NonNull Integer parameterIndex,
 @NonNull TargetType targetType,
 @NonNull Integer sqlType)
                                                       throws SQLException

Performs custom binding of a null value given its index and targetType.

This function is only invoked for TypedParameter values that are null.

Parameters:

statementContext - current SQL context

preparedStatement - the prepared statement to bind to

parameterIndex - 1-based parameter index at which to perform the binding

targetType - explicit target type from TypedParameter

sqlType - JDBC SQL type hint (may be Types.NULL)

Returns:

CustomParameterBinder.BindingResult.handled() if the custom binding was performed, or CustomParameterBinder.BindingResult.fallback() to fall back to default behavior

Throws:

SQLException - if an error occurs during binding

appliesTo

@NonNull Boolean appliesTo(@NonNull TargetType targetType)

Specifies which types this custom binder should handle.

For example, if this binder should apply when binding MyCustomType, this method could return targetType.matchesClass(MyCustomType.class).

For parameterized types like List<UUID>, this method could return targetType.matchesParameterizedType(List.class, UUID.class).

Parameters:

targetType - the target type to evaluate - should this custom binder handle it or not?

Returns:

true if this binder should handle the type, false otherwise.