|
1 | 1 | /*
|
2 |
| - * Copyright 2002-2012 the original author or authors. |
| 2 | + * Copyright 2002-2018 the original author or authors. |
3 | 3 | *
|
4 | 4 | * Licensed under the Apache License, Version 2.0 (the "License");
|
5 | 5 | * you may not use this file except in compliance with the License.
|
@@ -52,28 +52,28 @@ public interface KeyHolder {
|
52 | 52 | * multiple entries as well. If this method encounters multiple entries in
|
53 | 53 | * either the map or the list meaning that multiple keys were returned,
|
54 | 54 | * then an InvalidDataAccessApiUsageException is thrown.
|
55 |
| - * @return the generated key |
56 |
| - * @throws InvalidDataAccessApiUsageException if multiple keys are encountered. |
| 55 | + * @return the generated key as a number |
| 56 | + * @throws InvalidDataAccessApiUsageException if multiple keys are encountered |
57 | 57 | */
|
58 | 58 | @Nullable
|
59 | 59 | Number getKey() throws InvalidDataAccessApiUsageException;
|
60 | 60 |
|
61 | 61 | /**
|
62 |
| - * Retrieve the first map of keys. If there are multiple entries in the list |
63 |
| - * (meaning that multiple rows had keys returned), then an |
64 |
| - * InvalidDataAccessApiUsageException is thrown. |
65 |
| - * @return the Map of generated keys |
| 62 | + * Retrieve the first map of keys. |
| 63 | + * <p>If there are multiple entries in the list (meaning that multiple rows |
| 64 | + * had keys returned), then an InvalidDataAccessApiUsageException is thrown. |
| 65 | + * @return the Map of generated keys for a single row |
66 | 66 | * @throws InvalidDataAccessApiUsageException if keys for multiple rows are encountered
|
67 | 67 | */
|
68 | 68 | @Nullable
|
69 | 69 | Map<String, Object> getKeys() throws InvalidDataAccessApiUsageException;
|
70 | 70 |
|
71 | 71 | /**
|
72 | 72 | * Return a reference to the List that contains the keys.
|
73 |
| - * Can be used for extracting keys for multiple rows (an unusual case), |
| 73 | + * <p>Can be used for extracting keys for multiple rows (an unusual case), |
74 | 74 | * and also for adding new maps of keys.
|
75 |
| - * @return the List for the generated keys, with each entry being a Map |
76 |
| - * of column names and key values |
| 75 | + * @return the List for the generated keys, with each entry representing |
| 76 | + * an individual row through a Map of column names and key values |
77 | 77 | */
|
78 | 78 | List<Map<String, Object>> getKeyList();
|
79 | 79 |
|
|
0 commit comments