public class GeneratedKeyHolder extends java.lang.Object implements KeyHolder
KeyHolder
interface, to be used for
holding auto-generated keys (as potentially returned by JDBC insert statements).
Create an instance of this class for each insert operation, and pass
it to the corresponding JdbcTemplate
or {org.springframework.jdbc.object.SqlUpdate} methods.
Modifier and Type | Field and Description |
---|---|
private java.util.List<java.util.Map<java.lang.String,java.lang.Object>> |
keyList |
Constructor and Description |
---|
GeneratedKeyHolder()
Create a new GeneratedKeyHolder with a default list.
|
GeneratedKeyHolder(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> keyList)
Create a new GeneratedKeyHolder with a given list.
|
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.
|
private final java.util.List<java.util.Map<java.lang.String,java.lang.Object>> keyList
public GeneratedKeyHolder()
public GeneratedKeyHolder(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> keyList)
keyList
- a list to hold maps of keyspublic java.lang.Number getKey() throws InvalidDataAccessApiUsageException, DataRetrievalFailureException
KeyHolder
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.
getKey
in interface KeyHolder
InvalidDataAccessApiUsageException
- if multiple keys are encountered.DataRetrievalFailureException
public java.util.Map<java.lang.String,java.lang.Object> getKeys() throws InvalidDataAccessApiUsageException
KeyHolder
getKeys
in interface KeyHolder
InvalidDataAccessApiUsageException
- if keys for multiple rows are encounteredpublic java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getKeyList()
KeyHolder
getKeyList
in interface KeyHolder