Skip to content

Commit d6d7d24

Browse files
committed
- Add @see for new commands in interfaces
Signed-off-by: Chris Bono <chris.bono@broadcom.com>
1 parent 090a479 commit d6d7d24

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

src/main/java/org/springframework/data/redis/core/BoundHashOperations.java

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,7 @@ default BoundHashFieldExpirationOperations<HK> hashExpiration(@NonNull Collectio
255255
* @param hashFields must not be {@literal null}.
256256
* @return {@literal null} when used in pipeline / transaction.
257257
* @since 4.0
258+
* @see <a href="https://redis.io/commands/hgetdel">Redis Documentation: HGETDEL</a>
258259
*/
259260
List<HV> getAndDelete(@NonNull Collection<@NonNull HK> hashFields);
260261

@@ -266,6 +267,7 @@ default BoundHashFieldExpirationOperations<HK> hashExpiration(@NonNull Collectio
266267
* @param hashFields must not be {@literal null}.
267268
* @return never {@literal null}.
268269
* @since 4.0
270+
* @see <a href="https://redis.io/commands/hsetex">Redis Documentation: HSETEX</a>
269271
*/
270272
List<HV> getAndExpire(Expiration expiration, @NonNull Collection<@NonNull HK> hashFields);
271273

@@ -275,11 +277,12 @@ default BoundHashFieldExpirationOperations<HK> hashExpiration(@NonNull Collectio
275277
*
276278
* @param m must not be {@literal null}.
277279
* @param condition is optional. Use {@link RedisHashCommands.HashFieldSetOption#IF_NONE_EXIST} (FNX) to only set the fields if
278-
* none of them already exist, {@link RedisHashCommands.HashFieldSetOption#IF_ALL_EXIST} (FXX) to only set the
279-
* fields if all of them already exist, or {@link RedisHashCommands.HashFieldSetOption#UPSERT} to set the fields
280-
* unconditionally.
280+
* none of them already exist, {@link RedisHashCommands.HashFieldSetOption#IF_ALL_EXIST} (FXX) to only set the
281+
* fields if all of them already exist, or {@link RedisHashCommands.HashFieldSetOption#UPSERT} to set the fields
282+
* unconditionally.
281283
* @param expiration is optional.
282284
* @since 4.0
285+
* @see <a href="https://redis.io/commands/hsetex">Redis Documentation: HSETEX</a>
283286
*/
284287
void putAndExpire(Map<? extends @NonNull HK, ? extends HV> m, RedisHashCommands.HashFieldSetOption condition, Expiration expiration);
285288
}

src/main/java/org/springframework/data/redis/core/HashOperations.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ public interface HashOperations<H, HK, HV> {
8989
* @param hashKeys must not be {@literal null}.
9090
* @return list of values for the given fields or {@literal null} when used in pipeline / transaction.
9191
* @since 4.0
92+
* @see <a href="https://redis.io/commands/hgetdel">Redis Documentation: HGETDEL</a>
9293
*/
9394
List<HV> getAndDelete(@NonNull H key, @NonNull Collection<@NonNull HK> hashKeys);
9495

@@ -101,6 +102,7 @@ public interface HashOperations<H, HK, HV> {
101102
* @param hashKeys must not be {@literal null}.
102103
* @return list of values for the given fields or {@literal null} when used in pipeline / transaction.
103104
* @since 4.0
105+
* @see <a href="https://redis.io/commands/hgetex">Redis Documentation: HGETEX</a>
104106
*/
105107
List<HV> getAndExpire(@NonNull H key, Expiration expiration, @NonNull Collection<@NonNull HK> hashKeys);
106108

@@ -113,6 +115,7 @@ public interface HashOperations<H, HK, HV> {
113115
* @param expiration is optional.
114116
* @return whether all fields were set or {@literal null} when used in pipeline / transaction.
115117
* @since 4.0
118+
*@see <a href="https://redis.io/commands/hsetex">Redis Documentation: HSETEX</a>
116119
*/
117120
Boolean putAndExpire(@NonNull H key, @NonNull Map<? extends @NonNull HK, ? extends HV> m,
118121
RedisHashCommands.HashFieldSetOption condition, Expiration expiration);

0 commit comments

Comments
 (0)