public class

GeneratedKeyHolder

extends Object
implements KeyHolder
java.lang.Object
   ↳ org.springframework.jdbc.support.GeneratedKeyHolder

Class Overview

Default implementation of the 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.

Summary

Public Constructors
GeneratedKeyHolder()
Create a new GeneratedKeyHolder with a default list.
GeneratedKeyHolder(List<Map<StringObject>> keyList)
Create a new GeneratedKeyHolder with a given list.
Public Methods
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.
List<Map<StringObject>> getKeyList()
Return a reference to the List that contains the keys.
Map<StringObject> getKeys()
Retrieve the first map of keys.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.jdbc.support.KeyHolder

Public Constructors

public GeneratedKeyHolder ()

Create a new GeneratedKeyHolder with a default list.

public GeneratedKeyHolder (List<Map<StringObject>> keyList)

Create a new GeneratedKeyHolder with a given list.

Parameters
keyList a list to hold maps of keys

Public Methods

public 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. This is the typical case: a single, numeric generated key.

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.

Returns
  • the generated key

public List<Map<StringObject>> getKeyList ()

Return a reference to the List that contains the keys. Can be used for extracting keys for multiple rows (an unusual case), and also for adding new maps of keys.

Returns
  • the List for the generated keys, with each entry being a Map of column names and key values

public Map<StringObject> getKeys ()

Retrieve the first map of keys. If there are multiple entries in the list (meaning that multiple rows had keys returned), then an InvalidDataAccessApiUsageException is thrown.

Returns
  • the Map of generated keys