org.jdbi.v3.sqlobject

Annotation Type BindMap

@Retention(value=RUNTIME)
 @Target(value=PARAMETER)
public @interface BindMap

Binds the entries of a Map<String, Object> to a SQL statement.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	convertKeys Whether to automatically convert map keys to strings.
String[]	keys The set of map keys to bind.
String	value Prefix to apply to each map key.

Element Detail

value

public abstract String value

Prefix to apply to each map key. If specified, map keys will be bound as prefix.key.

Default:

""

keys

public abstract String[] keys

The set of map keys to bind. If specified, binds only the specified keys; any keys present in this property but absent from the map will be bound as null. If not specified, all map entries are bound.

Returns:

the map keys to bind.

Default:

{}

convertKeys

public abstract boolean convertKeys

Whether to automatically convert map keys to strings. If false, Map keys must be strings, or an exception is thrown. If true, any object may be the key, and it will be converted with Object.toString().

Returns:

whether keys will be implicitly converted to Strings.

Default:

false