org.jdbi.v3.core.argument

Interface QualifiedArgumentFactory

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
 @Beta
public interface QualifiedArgumentFactory

Inspect a value with optional static qualified type information and produce an Argument that binds the value to a prepared statement.

Make sure to override Object.toString() in your Argument instances if you want to be able to log their values with an SqlLogger.

Note that null is handled specially in a few cases, and a few Jdbi features assume you'll return an instance of NullArgument when you intend to bind null.

Method Summary

Modifier and Type	Method and Description
static QualifiedArgumentFactory	adapt(ArgumentFactory factory) Adapts an ArgumentFactory into a QualifiedArgumentFactory.
Optional<Argument>	build(QualifiedType<?> type, Object value, ConfigRegistry config) Returns an Argument for the given value if the factory supports it; empty otherwise.

Method Detail

adapt

static QualifiedArgumentFactory adapt(ArgumentFactory factory)

Adapts an ArgumentFactory into a QualifiedArgumentFactory. The returned factory only matches qualified types with zero qualifiers.

Parameters:

factory - the factory to adapt

build

Optional<Argument> build(QualifiedType<?> type,
                         Object value,
                         ConfigRegistry config)

Returns an Argument for the given value if the factory supports it; empty otherwise.

Parameters:

type - the known qualified type of value. Depending on the situation this may be a full generic signature e.g. ParameterizedType, a Class, or Object.class if no type information is known.

value - the value to convert into an Argument

config - the config registry, for composition

Returns:

an argument for the given value if this factory supports it, or Optional.empty() otherwise.

See Also:

StatementContext.findArgumentFor(QualifiedType, Object), Arguments.findFor(QualifiedType, Object), QualifiedType