public interface KeyHolder
Implementations of this interface can hold any number of keys. In the general case, the keys are returned as a List containing one Map for each row of keys.
Most applications only use on key per row and process only one row at a
time in an insert statement. In these cases, just call getKey
to retrieve the key. The returned value is a Number here, which is the
usual type for auto-generated keys.
JdbcTemplate
,
SqlUpdate
Modifier and Type | Method and Description |
---|---|
java.lang.Number |
getKey()
Retrieve the first item from the first map, assuming that there is just
one item and just one map, and that the item is a number.
|
java.util.List<java.util.Map<java.lang.String,java.lang.Object>> |
getKeyList()
Return a reference to the List that contains the keys.
|
java.util.Map<java.lang.String,java.lang.Object> |
getKeys()
Retrieve the first map of keys.
|
@Nullable java.lang.Number getKey() throws InvalidDataAccessApiUsageException
Keys are held in a List of Maps, where each item in the list represents the keys for each row. If there are multiple columns, then the Map will have multiple entries as well. If this method encounters multiple entries in either the map or the list meaning that multiple keys were returned, then an InvalidDataAccessApiUsageException is thrown.
InvalidDataAccessApiUsageException
- if multiple keys are encountered.@Nullable java.util.Map<java.lang.String,java.lang.Object> getKeys() throws InvalidDataAccessApiUsageException
InvalidDataAccessApiUsageException
- if keys for multiple rows are encounteredjava.util.List<java.util.Map<java.lang.String,java.lang.Object>> getKeyList()