org.jdbi.v3.core.argument

Class AbstractArgumentFactory<T>

java.lang.Object

org.jdbi.v3.core.argument.AbstractArgumentFactory<T>

Type Parameters:

T - the type of argument supported by this factory.

All Implemented Interfaces:

ArgumentFactory

Direct Known Subclasses:

JavaTimeZoneIdArgumentFactory

public abstract class AbstractArgumentFactory<T>
extends Object
implements ArgumentFactory

An ArgumentFactory base class for arguments of type T. For values of type T, factories produces arguments from the build(Object, ConfigRegistry) method. For null values with a known expected type of T, produces null arguments for the sqlType passed to the constructor.

 class ValueType {
     String value;
 }

 class ValueTypeArgumentFactory extends AbstractArgumentFactory<ValueType> {
     ValueTypeArgumentFactory() {
         super(Types.VARCHAR);
     }

     @Override
     protected Argument build(ValueType valueType, ConfigRegistry config) {
         return (pos, stmt, ctx) -> stmt.setString(pos, valueType.value);
     }
 }
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractArgumentFactory(int sqlType) Constructs an ArgumentFactory for type T.

Method Summary

Modifier and Type	Method and Description
protected abstract Argument	build(T value, ConfigRegistry config) Produce an argument object for the given value.
Optional<Argument>	build(Type type, Object value, ConfigRegistry config) Returns an Argument for the given value if the factory supports it; empty otherwise.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractArgumentFactory

protected AbstractArgumentFactory(int sqlType)

Constructs an ArgumentFactory for type T.

Parameters:

sqlType - the Types constant to use when the argument value is null.

Method Detail

build

protected abstract Argument build(T value,
                                  ConfigRegistry config)

Produce an argument object for the given value.

Parameters:

value - the value to convert to an argument

config - the config registry

Returns:

an Argument for the given value.

build

public final Optional<Argument> build(Type type,
                                      Object value,
                                      ConfigRegistry config)

Description copied from interface: ArgumentFactory

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

Specified by:

build in interface ArgumentFactory

Parameters:

type - the known 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(Type, Object), Arguments.findFor(Type, Object)