Package 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, ArgumentFactory.Preparable

Direct Known Subclasses:

BlobInputStreamArgumentFactory, CharSequenceArgumentFactory, ClobReaderArgumentFactory, DateTimeArgumentFactory, DurationArgumentFactory, HStoreArgumentFactory, InetArgumentFactory, JavaTimeZoneIdArgumentFactory, JsonArgumentFactory, MacAddrArgumentFactory, NVarcharArgumentFactory, PeriodArgumentFactory, PGobjectArgumentFactory, TypedEnumArgumentFactory, URLArgumentFactory

public abstract class AbstractArgumentFactory<T>
extends java.lang.Object
implements ArgumentFactory.Preparable

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);
     }
 }
 

Don't forget to override Object.toString() in your Argument instances if you want to be able to log their values with an SqlLogger.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static interface	AbstractArgumentFactory.ArgumentPredicate

Nested classes/interfaces inherited from interface org.jdbi.v3.core.argument.ArgumentFactory

ArgumentFactory.Preparable

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.reflect.Type	argumentType
private AbstractArgumentFactory.ArgumentPredicate	isInstance
private int	sqlType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
java.util.Optional<Argument>	build(java.lang.reflect.Type type, java.lang.Object value, ConfigRegistry config)	Returns an Argument for the given value if the factory supports it; empty otherwise.
protected abstract Argument	build(T value, ConfigRegistry config)	Produce an argument object for the given value.
private Argument	innerBuild(java.lang.reflect.Type type, java.lang.Object value, ConfigRegistry config)
java.util.Optional<java.util.function.Function<java.lang.Object,Argument>>	prepare(java.lang.reflect.Type type, ConfigRegistry config)
java.util.Collection<java.lang.reflect.Type>	prePreparedTypes()

Methods inherited from class java.lang.Object

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

Field Detail

sqlType

private final int sqlType

isInstance

private final AbstractArgumentFactory.ArgumentPredicate isInstance

argumentType

private final java.lang.reflect.Type argumentType

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

prepare

public java.util.Optional<java.util.function.Function<java.lang.Object,Argument>> prepare(java.lang.reflect.Type type,
                                                                                                ConfigRegistry config)

Specified by:

prepare in interface ArgumentFactory.Preparable

prePreparedTypes

public java.util.Collection<java.lang.reflect.Type> prePreparedTypes()

Specified by:

prePreparedTypes in interface ArgumentFactory.Preparable

build

public final java.util.Optional<Argument> build(java.lang.reflect.Type type,
                                                java.lang.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

Specified by:

build in interface ArgumentFactory.Preparable

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)

innerBuild

private Argument innerBuild(java.lang.reflect.Type type,
                            java.lang.Object value,
                            ConfigRegistry config)

build

protected abstract Argument build(T value,
                                  ConfigRegistry config)

Produce an argument object for the given value. When the implementation class has accepted a given type, it must then produce an argument instance or throw an exception.

Parameters:

value - the value to convert to an argument

config - the config registry

Returns:

An Argument for the given value. Must not be null!