org.jdbi.v3.core.argument

Class Arguments

java.lang.Object

org.jdbi.v3.core.argument.Arguments

All Implemented Interfaces:

JdbiConfig<Arguments>

public class Arguments
extends Object
implements JdbiConfig<Arguments>

A registry for ArgumentFactory instances. When a statement with bound parameters is executed, Jdbi consults the Arguments registry to obtain an Argument instance for each bound parameter (see #findFor(...)). The factories are consulted in reverse order of registration (i.e. last-registered wins).

Constructor Summary

Constructors

Constructor and Description
Arguments()

Method Summary

Modifier and Type	Method and Description
Arguments	createCopy() Returns a copy of this configuration object.
Optional<Argument>	findFor(QualifiedType<?> type, Object value) Obtain an argument for given value in the given context.
Optional<Argument>	findFor(Type type, Object value) Obtain an argument for given value in the given context
Argument	getUntypedNullArgument()
Arguments	register(ArgumentFactory factory) Registers the given argument factory.
void	setRegistry(ConfigRegistry registry) The registry will inject itself into the configuration object.
void	setUntypedNullArgument(Argument untypedNullArgument) Configure the Argument to use when binding a null we don't have a type for.

Methods inherited from class java.lang.Object

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

Constructor Detail

Arguments

public Arguments()

Method Detail

createCopy

public Arguments createCopy()

Description copied from interface: JdbiConfig

Returns a copy of this configuration object. Changes to the copy should not modify the original, and vice-versa.

Specified by:

createCopy in interface JdbiConfig<Arguments>

Returns:

a copy of this configuration object.

findFor

@Beta
public Optional<Argument> findFor(QualifiedType<?> type,
                                        Object value)

Obtain an argument for given value in the given context.

Parameters:

type - the qualified type of the argument.

value - the argument value.

Returns:

an Argument for the given value.

findFor

public Optional<Argument> findFor(Type type,
                                  Object value)

Obtain an argument for given value in the given context

Parameters:

type - the type of the argument.

value - the argument value.

Returns:

an Argument for the given value.

getUntypedNullArgument

public Argument getUntypedNullArgument()

Returns:

the untyped null argument

register

public Arguments register(ArgumentFactory factory)

Registers the given argument factory. If more than one of the registered factories supports a given parameter type, the last-registered factory wins.

Parameters:

factory - the factory to add

Returns:

this

setRegistry

public void setRegistry(ConfigRegistry registry)

Description copied from interface: JdbiConfig

The registry will inject itself into the configuration object. This can be useful if you need to look up dependencies. You will get a new registry after being copied.

Specified by:

setRegistry in interface JdbiConfig<Arguments>

Parameters:

registry - the registry that owns this configuration object

setUntypedNullArgument

public void setUntypedNullArgument(Argument untypedNullArgument)

Configure the Argument to use when binding a null we don't have a type for.

Parameters:

untypedNullArgument - the argument to bind