diff --git a/CODE_OF_CONDUCT.adoc b/CODE_OF_CONDUCT.adoc index f64fb1b7a5..33ae7bc9f1 100644 --- a/CODE_OF_CONDUCT.adoc +++ b/CODE_OF_CONDUCT.adoc @@ -24,4 +24,4 @@ Instances of abusive, harassing, or otherwise unacceptable behavior may be repor All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Maintainers are obligated to maintain confidentiality with regard to the reporter of an incident. -This Code of Conduct is adapted from the http://contributor-covenant.org[Contributor Covenant], version 1.3.0, available at http://contributor-covenant.org/version/1/3/0/[contributor-covenant.org/version/1/3/0/]. \ No newline at end of file +This Code of Conduct is adapted from the https://contributor-covenant.org[Contributor Covenant], version 1.3.0, available at https://contributor-covenant.org/version/1/3/0/[contributor-covenant.org/version/1/3/0/]. \ No newline at end of file diff --git a/README.md b/README.md index 6a33445c03..b81013cc4c 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ -[![Spring Data Redis](https://spring.io/badges/spring-data-redis/ga.svg)](http://projects.spring.io/spring-data-redis/#quick-start) -[![Spring Data Redis](https://spring.io/badges/spring-data-redis/snapshot.svg)](http://projects.spring.io/spring-data-redis/#quick-start) +[![Spring Data Redis](https://spring.io/badges/spring-data-redis/ga.svg)](https://projects.spring.io/spring-data-redis/#quick-start) +[![Spring Data Redis](https://spring.io/badges/spring-data-redis/snapshot.svg)](https://projects.spring.io/spring-data-redis/#quick-start) Spring Data Redis ======================= -The primary goal of the [Spring Data](http://projects.spring.io/spring-data/) project is to make it easier to build Spring-powered applications that use new data access technologies such as non-relational databases, map-reduce frameworks, and cloud based data services. -This modules provides integration with the [Redis](http://redis.io/) store. +The primary goal of the [Spring Data](https://projects.spring.io/spring-data/) project is to make it easier to build Spring-powered applications that use new data access technologies such as non-relational databases, map-reduce frameworks, and cloud based data services. +This modules provides integration with the [Redis](https://redis.io/) store. # Docs -You can find out more details from the [user documentation](http://docs.spring.io/spring-data/data-redis/docs/current/reference/html/) or by browsing the [javadocs](http://docs.spring.io/spring-data/data-redis/docs/current/api/). +You can find out more details from the [user documentation](https://docs.spring.io/spring-data/data-redis/docs/current/reference/html/) or by browsing the [javadocs](https://docs.spring.io/spring-data/data-redis/docs/current/api/). # Examples @@ -41,7 +41,7 @@ If you'd rather like the latest snapshots of the upcoming major version, use our spring-libs-snapshot Spring Snapshot Repository - http://repo.spring.io/libs-snapshot + https://repo.spring.io/libs-snapshot ``` @@ -49,8 +49,8 @@ If you'd rather like the latest snapshots of the upcoming major version, use our ```groovy repositories { - maven { url "http://repo.spring.io/libs-milestone" } - maven { url "http://repo.spring.io/libs-snapshot" } + maven { url "https://repo.spring.io/libs-milestone" } + maven { url "https://repo.spring.io/libs-snapshot" } } // used for nightly builds @@ -68,7 +68,7 @@ dependencies { xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p" xsi:schemaLocation=" - http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd"> + http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd"> @@ -115,15 +115,15 @@ You can alternatively use the provided `Makefile` which runs the build plus down Here are some ways for you to get involved in the community: -* Get involved with the Spring community on the Stackoverflow. Please help out on the [spring-data-redis](http://stackoverflow.com/questions/tagged/spring-data-redis) tag by responding to questions and joining the debate. +* Get involved with the Spring community on the Stackoverflow. Please help out on the [spring-data-redis](https://stackoverflow.com/questions/tagged/spring-data-redis) tag by responding to questions and joining the debate. * Create [JIRA](https://jira.spring.io/browse/DATAREDIS) tickets for bugs and new features and comment and vote on the ones that you are interested in. * Watch for upcoming articles on Spring by [subscribing](https://spring.io/blog) to spring.io. Before we accept a non-trivial patch or pull request we will need you to [sign the Contributor License Agreement](https://cla.pivotal.io/sign/spring). Signing the contributor’s agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. If you forget to do so, you'll be reminded when you submit a pull request. -Github is for social coding: if you want to write code, we encourage contributions through pull requests from [forks of this repository](http://help.github.com/forking/). If you want to contribute code this way, read the Spring Framework [contributor guidelines] (https://github.com/spring-projects/spring-framework/blob/master/CONTRIBUTING.md). +Github is for social coding: if you want to write code, we encourage contributions through pull requests from [forks of this repository](https://help.github.com/forking/). If you want to contribute code this way, read the Spring Framework [contributor guidelines] (https://github.com/spring-projects/spring-framework/blob/master/CONTRIBUTING.md). # Staying in touch -Follow the project team ([@SpringData](http://twitter.com/springdata)) on Twitter. In-depth articles can be +Follow the project team ([@SpringData](https://twitter.com/springdata)) on Twitter. In-depth articles can be found at the Spring [team blog](https://spring.io/blog), and releases are announced via our [news feed](https://spring.io/blog/category/news). diff --git a/src/main/asciidoc/appendix/appendix-schema.adoc b/src/main/asciidoc/appendix/appendix-schema.adoc index fa3aa7311c..b8f0438471 100644 --- a/src/main/asciidoc/appendix/appendix-schema.adoc +++ b/src/main/asciidoc/appendix/appendix-schema.adoc @@ -2,4 +2,4 @@ [appendix] = Schema -link:http://www.springframework.org/schema/redis/spring-redis-1.0.xsd[Spring Data Redis Schema (redis-namespace)] +link:https://www.springframework.org/schema/redis/spring-redis-1.0.xsd[Spring Data Redis Schema (redis-namespace)] diff --git a/src/main/asciidoc/introduction/getting-started.adoc b/src/main/asciidoc/introduction/getting-started.adoc index f98f06cb42..7beadeed11 100644 --- a/src/main/asciidoc/introduction/getting-started.adoc +++ b/src/main/asciidoc/introduction/getting-started.adoc @@ -11,17 +11,17 @@ As explained in <>, Spring Data Redis (SDR) provides integrati [[get-started:first-steps:spring]] === Learning Spring -Spring Data uses Spring framework's http://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/core.html[core] functionality, such as the http://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/core.html[IoC] container, http://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/core.html#resources[resource] abstract, and the http://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/core.html#aop[AOP] infrastructure. While it is not important to know the Spring APIs, understanding the concepts behind them is important. At a minimum, the idea behind IoC should be familiar. That being said, the more knowledge you have about the Spring, the faster you can pick up Spring Data Redis. In addition to the Spring Framework's comprehensive documentation, there are a lot of articles, blog entries, and books on the matter. The Spring Guides http://spring.io/guides[home page] offer a good place to start. In general, this should be the starting point for developers wanting to try Spring Data Redis. +Spring Data uses Spring framework's https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/core.html[core] functionality, such as the https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/core.html[IoC] container, https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/core.html#resources[resource] abstract, and the https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/core.html#aop[AOP] infrastructure. While it is not important to know the Spring APIs, understanding the concepts behind them is important. At a minimum, the idea behind IoC should be familiar. That being said, the more knowledge you have about the Spring, the faster you can pick up Spring Data Redis. In addition to the Spring Framework's comprehensive documentation, there are a lot of articles, blog entries, and books on the matter. The Spring Guides https://spring.io/guides[home page] offer a good place to start. In general, this should be the starting point for developers wanting to try Spring Data Redis. [[get-started:first-steps:nosql]] === Learning NoSQL and Key Value Stores -NoSQL stores have taken the storage world by storm. It is a vast domain with a plethora of solutions, terms, and patterns (to make things worse, even the term itself has multiple http://www.google.com/search?q=nosoql+acronym[meanings]). While some of the principles are common, it is crucial that you be familiar to some degree with the stores supported by SDR. The best way to get acquainted with these solutions is to read their documentation and follow their examples. It usually does not take more then five to ten minutes to go through them and, if you come from an RDMBS-only background, many times these exercises can be eye-openers. +NoSQL stores have taken the storage world by storm. It is a vast domain with a plethora of solutions, terms, and patterns (to make things worse, even the term itself has multiple https://www.google.com/search?q=nosoql+acronym[meanings]). While some of the principles are common, it is crucial that you be familiar to some degree with the stores supported by SDR. The best way to get acquainted with these solutions is to read their documentation and follow their examples. It usually does not take more then five to ten minutes to go through them and, if you come from an RDMBS-only background, many times these exercises can be eye-openers. [[get-started:first-steps:samples]] === Trying out the Samples -One can find various samples for key-value stores in the dedicated Spring Data example repo, at https://github.com/spring-projects/spring-data-keyvalue-examples[http://github.com/spring-projects/spring-data-keyvalue-examples]. For Spring Data Redis, you should pay particular attention to the `retwisj` sample, a Twitter-clone built on top of Redis that can be run locally or be deployed into the cloud. See its http://static.springsource.org/spring-data/data-keyvalue/examples/retwisj/current/[documentation], the following blog http://blog.springsource.com/2011/04/27/getting-started-redis-spring-cloud-foundry/[entry] for more information. +One can find various samples for key-value stores in the dedicated Spring Data example repo, at https://github.com/spring-projects/spring-data-keyvalue-examples[https://github.com/spring-projects/spring-data-keyvalue-examples]. For Spring Data Redis, you should pay particular attention to the `retwisj` sample, a Twitter-clone built on top of Redis that can be run locally or be deployed into the cloud. See its https://docs.spring.io/spring-data/data-keyvalue/examples/retwisj/current/[documentation], the following blog https://spring.io/blog/2011/04/27/getting-started-redis-spring-cloud-foundry/[entry] for more information. [[get-started:help]] == Need Help? @@ -31,23 +31,23 @@ If you encounter issues or you are just looking for advice, use one of the links [[get-started:help:community]] === Community Support -The Spring Data tag on http://stackoverflow.com/questions/tagged/spring-data[Stack Overflow] is a message board for all Spring Data (not just Redis) users to share information and help each other. Note that registration is needed *only* for posting. +The Spring Data tag on https://stackoverflow.com/questions/tagged/spring-data[Stack Overflow] is a message board for all Spring Data (not just Redis) users to share information and help each other. Note that registration is needed *only* for posting. [[get-started:help:professional]] === Professional Support -Professional, from-the-source support, with guaranteed response time, is available from http://www.pivotal.io/[Pivotal Software, Inc.], the company behind Spring Data and Spring. +Professional, from-the-source support, with guaranteed response time, is available from https://www.pivotal.io/[Pivotal Software, Inc.], the company behind Spring Data and Spring. [[get-started:up-to-date]] == Following Development -For information on the Spring Data source code repository, nightly builds, and snapshot artifacts, see the Spring Data home http://spring.io/spring-data[page]. +For information on the Spring Data source code repository, nightly builds, and snapshot artifacts, see the Spring Data home https://spring.io/spring-data[page]. You can help make Spring Data best serve the needs of the Spring community by interacting with developers on Stack Overflow at either -http://stackoverflow.com/questions/tagged/spring-data[spring-data] or http://stackoverflow.com/questions/tagged/spring-data-redis[spring-data-redis]. +https://stackoverflow.com/questions/tagged/spring-data[spring-data] or https://stackoverflow.com/questions/tagged/spring-data-redis[spring-data-redis]. If you encounter a bug or want to suggest an improvement (including to this documentation), please create a ticket on the Spring Data issue https://jira.spring.io/browse/DATAREDIS[tracker]. -To stay up to date with the latest news and announcements in the Spring eco system, subscribe to the Spring Community http://spring.io/[Portal]. +To stay up to date with the latest news and announcements in the Spring eco system, subscribe to the Spring Community https://spring.io/[Portal]. -Lastly, you can follow the Spring http://spring.io/blog/[blog] or the project team (http://twitter.com/SpringData[@SpringData]) on Twitter. +Lastly, you can follow the Spring https://spring.io/blog/[blog] or the project team (https://twitter.com/SpringData[@SpringData]) on Twitter. diff --git a/src/main/asciidoc/introduction/requirements.adoc b/src/main/asciidoc/introduction/requirements.adoc index 5db3a31037..58c4b7cd37 100644 --- a/src/main/asciidoc/introduction/requirements.adoc +++ b/src/main/asciidoc/introduction/requirements.adoc @@ -1,6 +1,6 @@ [[requirements]] = Requirements -Spring Data Redis 2.x binaries require JDK level 8.0 and above and http://projects.spring.io/spring-framework/[Spring Framework] {springVersion} and above. +Spring Data Redis 2.x binaries require JDK level 8.0 and above and https://projects.spring.io/spring-framework/[Spring Framework] {springVersion} and above. -In terms of key-value stores, http://redis.io[Redis] 2.6.x or higher is required. Spring Data Redis is currently tested against the latest 4.0 release. +In terms of key-value stores, https://redis.io[Redis] 2.6.x or higher is required. Spring Data Redis is currently tested against the latest 4.0 release. diff --git a/src/main/asciidoc/introduction/why-sdr.adoc b/src/main/asciidoc/introduction/why-sdr.adoc index 1e1689a58d..14dcbbfc2a 100644 --- a/src/main/asciidoc/introduction/why-sdr.adoc +++ b/src/main/asciidoc/introduction/why-sdr.adoc @@ -3,6 +3,6 @@ The Spring Framework is the leading full-stack Java/JEE application framework. It provides a lightweight container and a non-invasive programming model enabled by the use of dependency injection, AOP, and portable service abstractions. -http://en.wikipedia.org/wiki/NoSQL[NoSQL] storage systems provide an alternative to classical RDBMS for horizontal scalability and speed. In terms of implementation, key-value stores represent one of the largest (and oldest) members in the NoSQL space. +https://en.wikipedia.org/wiki/NoSQL[NoSQL] storage systems provide an alternative to classical RDBMS for horizontal scalability and speed. In terms of implementation, key-value stores represent one of the largest (and oldest) members in the NoSQL space. The Spring Data Redis (SDR) framework makes it easy to write Spring applications that use the Redis key-value store by eliminating the redundant tasks and boilerplate code required for interacting with the store through Spring's excellent infrastructure support. diff --git a/src/main/asciidoc/new-features.adoc b/src/main/asciidoc/new-features.adoc index 6cd6d460d6..98126a3f53 100644 --- a/src/main/asciidoc/new-features.adoc +++ b/src/main/asciidoc/new-features.adoc @@ -41,7 +41,7 @@ This section briefly covers items that are new and noteworthy in the latest rele * Upgrade to Jedis 2.9. * Upgrade to `Lettuce` 4.2 (Note: Lettuce 4.2 requires Java 8). -* Support for Redis http://redis.io/commands#geo[GEO] commands. +* Support for Redis https://redis.io/commands#geo[GEO] commands. * Support for Geospatial Indexes using Spring Data Repository abstractions (see <>). * `MappingRedisConverter`-based `HashMapper` implementation (see <>). * Support for `PartialUpdate` in repositories (see <>). @@ -51,7 +51,7 @@ This section briefly covers items that are new and noteworthy in the latest rele [[new-in-1.7.0]] == New in Spring Data Redis 1.7 -* Support for http://redis.io/topics/cluster-tutorial[RedisCluster]. +* Support for https://redis.io/topics/cluster-tutorial[RedisCluster]. * Support for Spring Data Repository abstractions (see <>). [[new-in-1-6-0]] diff --git a/src/main/asciidoc/reference/pipelining.adoc b/src/main/asciidoc/reference/pipelining.adoc index f2753bff9b..3cec6dfcd6 100644 --- a/src/main/asciidoc/reference/pipelining.adoc +++ b/src/main/asciidoc/reference/pipelining.adoc @@ -1,7 +1,7 @@ [[pipeline]] = Pipelining -Redis provides support for http://redis.io/topics/pipelining[pipelining], which involves sending multiple commands to the server without waiting for the replies and then reading the replies in a single step. Pipelining can improve performance when you need to send several commands in a row, such as adding many elements to the same List. +Redis provides support for https://redis.io/topics/pipelining[pipelining], which involves sending multiple commands to the server without waiting for the replies and then reading the replies in a single step. Pipelining can improve performance when you need to send several commands in a row, such as adding many elements to the same List. Spring Data Redis provides several `RedisTemplate` methods for executing commands in a pipeline. If you do not care about the results of the pipelined operations, you can use the standard `execute` method, passing `true` for the `pipeline` argument. The `executePipelined` methods run the provided `RedisCallback` or `SessionCallback` in a pipeline and return the results, as shown in the following example: diff --git a/src/main/asciidoc/reference/reactive-redis.adoc b/src/main/asciidoc/reference/reactive-redis.adoc index f256780d58..3e0b35c35f 100644 --- a/src/main/asciidoc/reference/reactive-redis.adoc +++ b/src/main/asciidoc/reference/reactive-redis.adoc @@ -7,7 +7,7 @@ This section covers reactive Redis support and how to get started. Reactive Redi [[redis:reactive:requirements]] == Redis Requirements -Spring Data Redis currently integrates with http://github.com/lettuce-io/lettuce-core[Lettuce] as the only reactive Java connector. https://projectreactor.io/[Project Reactor] is used as reactive composition library. +Spring Data Redis currently integrates with https://github.com/lettuce-io/lettuce-core[Lettuce] as the only reactive Java connector. https://projectreactor.io/[Project Reactor] is used as reactive composition library. [[redis:reactive:connectors]] == Connecting to Redis by Using a Reactive Driver @@ -18,14 +18,14 @@ One of the first tasks when using Redis and Spring is to connect to the store th === Redis Operation Modes Redis can be run as a standalone server, with <>, or in <> mode. -http://github.com/lettuce-io/lettuce-core[Lettuce] supports all of the previously mentioned connection types. +https://github.com/lettuce-io/lettuce-core[Lettuce] supports all of the previously mentioned connection types. [[redis:reactive:connectors:connection]] === `ReactiveRedisConnection` and `ReactiveRedisConnectionFactory` -`ReactiveRedisConnection` is the core of Redis communication, as it handles the communication with the Redis back-end. It also automatically translates the underlying driver exceptions to Spring's consistent DAO exception http://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/data-access.html#dao-exceptions[hierarchy], so you can switch the connectors without any code changes, as the operation semantics remain the same. +`ReactiveRedisConnection` is the core of Redis communication, as it handles the communication with the Redis back-end. It also automatically translates the underlying driver exceptions to Spring's consistent DAO exception https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/data-access.html#dao-exceptions[hierarchy], so you can switch the connectors without any code changes, as the operation semantics remain the same. -`ReactiveRedisConnectionFactory` creates active `ReactiveRedisConnection` instances. In addition, the factories act as `PersistenceExceptionTranslator` instances, meaning that, once declared, they let you do transparent exception translation -- for example, exception translation through the use of the `@Repository` annotation and AOP. For more information, see the dedicated http://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/data-access.html#orm-exception-translation[section] in the Spring Framework documentation. +`ReactiveRedisConnectionFactory` creates active `ReactiveRedisConnection` instances. In addition, the factories act as `PersistenceExceptionTranslator` instances, meaning that, once declared, they let you do transparent exception translation -- for example, exception translation through the use of the `@Repository` annotation and AOP. For more information, see the dedicated https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/data-access.html#orm-exception-translation[section] in the Spring Framework documentation. NOTE: Depending on the underlying configuration, the factory can return a new connection or an existing connection (in case a pool or shared native connection is used). @@ -70,7 +70,7 @@ For more detailed client configuration tweaks, see https://docs.spring.io/spring Most users are likely to use `ReactiveRedisTemplate` and its corresponding package, `org.springframework.data.redis.core`. Due to its rich feature set, the template is, in fact, the central class of the Redis module. The template offers a high-level abstraction for Redis interactions. While `ReactiveRedisConnection` offers low-level methods that accept and return binary values (`ByteBuffer`), the template takes care of serialization and connection management, freeing you from dealing with such details. -Moreover, the template provides operation views (following the grouping from Redis command http://redis.io/commands[reference]) that offer rich, generified interfaces for working against a certain type as described in the following table: +Moreover, the template provides operation views (following the grouping from Redis command https://redis.io/commands[reference]) that offer rich, generified interfaces for working against a certain type as described in the following table: .Operational views [width="80%",cols="<1,<2",options="header"] diff --git a/src/main/asciidoc/reference/redis-cluster.adoc b/src/main/asciidoc/reference/redis-cluster.adoc index 7406d17d01..ba0587ba90 100644 --- a/src/main/asciidoc/reference/redis-cluster.adoc +++ b/src/main/asciidoc/reference/redis-cluster.adoc @@ -1,7 +1,7 @@ [[cluster]] = Redis Cluster -Working with http://redis.io/topics/cluster-spec[Redis Cluster] requires Redis Server version 3.0+. See the http://redis.io/topics/cluster-tutorial[Cluster Tutorial] for more information. +Working with https://redis.io/topics/cluster-spec[Redis Cluster] requires Redis Server version 3.0+. See the https://redis.io/topics/cluster-tutorial[Cluster Tutorial] for more information. == Enabling Redis Cluster diff --git a/src/main/asciidoc/reference/redis-messaging.adoc b/src/main/asciidoc/reference/redis-messaging.adoc index 1e4bd06364..f746b0eb4f 100644 --- a/src/main/asciidoc/reference/redis-messaging.adoc +++ b/src/main/asciidoc/reference/redis-messaging.adoc @@ -87,8 +87,8 @@ Notice how the above implementation of the `MessageDelegate` interface (the abov + xsi:schemaLocation="http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd + http://www.springframework.org/schema/redis https://www.springframework.org/schema/redis/spring-redis.xsd"> diff --git a/src/main/asciidoc/reference/redis-repositories.adoc b/src/main/asciidoc/reference/redis-repositories.adoc index 0f1279854c..162fdb7bcd 100644 --- a/src/main/asciidoc/reference/redis-repositories.adoc +++ b/src/main/asciidoc/reference/redis-repositories.adoc @@ -379,7 +379,7 @@ public class ApplicationConfig { [[redis.repositories.indexes]] == Secondary Indexes -http://redis.io/topics/indexes[Secondary indexes] are used to enable lookup operations based on native Redis structures. Values are written to the according indexes on every save and are removed when objects are deleted or <>. +https://redis.io/topics/indexes[Secondary indexes] are used to enable lookup operations based on native Redis structures. Values are written to the according indexes on every save and are removed when objects are deleted or <>. [[redis.repositories.indexes.simple]] === Simple Property Index @@ -578,7 +578,7 @@ public class TimeToLiveOnMethod { NOTE: Annotating a property explicitly with `@TimeToLive` reads back the actual `TTL` or `PTTL` value from Redis. -1 indicates that the object has no associated expiration. -The repository implementation ensures subscription to http://redis.io/topics/notifications[Redis keyspace notifications] via `RedisMessageListenerContainer`. +The repository implementation ensures subscription to https://redis.io/topics/notifications[Redis keyspace notifications] via `RedisMessageListenerContainer`. When the expiration is set to a positive value, the corresponding `EXPIRE` command is executed. In addition to persisting the original, a phantom copy is persisted in Redis and set to expire five minutes after the original one. This is done to enable the Repository support to publish `RedisKeyExpiredEvent`, holding the expired value in Spring's `ApplicationEventPublisher` whenever a key expires, even though the original values have already been removed. Expiry events are received on all connected applications that use Spring Data Redis repositories. diff --git a/src/main/asciidoc/reference/redis-scripting.adoc b/src/main/asciidoc/reference/redis-scripting.adoc index f17a0a75d8..3c4fdb97fb 100644 --- a/src/main/asciidoc/reference/redis-scripting.adoc +++ b/src/main/asciidoc/reference/redis-scripting.adoc @@ -1,7 +1,7 @@ [[scripting]] = Redis Scripting -Redis versions 2.6 and higher provide support for execution of Lua scripts through the http://redis.io/commands/eval[eval] and http://redis.io/commands/evalsha[evalsha] commands. Spring Data Redis provides a high-level abstraction for script execution that handles serialization and automatically uses the Redis script cache. +Redis versions 2.6 and higher provide support for execution of Lua scripts through the https://redis.io/commands/eval[eval] and https://redis.io/commands/evalsha[evalsha] commands. Spring Data Redis provides a high-level abstraction for script execution that handles serialization and automatically uses the Redis script cache. Scripts can be run by calling the `execute` methods of `RedisTemplate` and `ReactiveRedisTemplate`. Both use a configurable `ScriptExecutor` (or `ReactiveScriptExecutor`) to run the provided script. By default, the `ScriptExecutor` (or `ReactiveScriptExecutor`) takes care of serializing the provided keys and arguments and deserializing the script result. This is done through the key and value serializers of the template. There is an additional overload that lets you pass custom serializers for the script arguments and the result. @@ -49,4 +49,4 @@ TIP: It is ideal to configure a single instance of `DefaultRedisScript` in your The `checkAndSet` method above then runs the scripts. Scripts can be run within a `SessionCallback` as part of a transaction or pipeline. See "`<>`" and "`<>`" for more information. -The scripting support provided by Spring Data Redis also lets you schedule Redis scripts for periodic execution by using the Spring Task and Scheduler abstractions. See the http://projects.spring.io/spring-framework/[Spring Framework] documentation for more details. +The scripting support provided by Spring Data Redis also lets you schedule Redis scripts for periodic execution by using the Spring Task and Scheduler abstractions. See the https://projects.spring.io/spring-framework/[Spring Framework] documentation for more details. diff --git a/src/main/asciidoc/reference/redis-transactions.adoc b/src/main/asciidoc/reference/redis-transactions.adoc index 024b7d4af1..203e8ed1a6 100644 --- a/src/main/asciidoc/reference/redis-transactions.adoc +++ b/src/main/asciidoc/reference/redis-transactions.adoc @@ -1,7 +1,7 @@ [[tx]] = Redis Transactions -Redis provides support for http://redis.io/topics/transactions[transactions] through the `multi`, `exec`, and `discard` commands. These operations are available on `RedisTemplate`. However, `RedisTemplate` is not guaranteed to execute all operations in the transaction with the same connection. +Redis provides support for https://redis.io/topics/transactions[transactions] through the `multi`, `exec`, and `discard` commands. These operations are available on `RedisTemplate`. However, `RedisTemplate` is not guaranteed to execute all operations in the transaction with the same connection. Spring Data Redis provides the `SessionCallback` interface for use when multiple operations need to be performed with the same `connection`, such as when using Redis transactions. The following example uses the `multi` method: @@ -63,7 +63,7 @@ public class RedisTxContextConfiguration { } } ---- -<1> Configures a Spring Context to enable http://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/data-access.html#transaction-declarative[declarative transaction management]. +<1> Configures a Spring Context to enable https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/data-access.html#transaction-declarative[declarative transaction management]. <2> Configures `RedisTemplate` to participate in transactions by binding connections to the current thread. <3> Transaction management requires a `PlatformTransactionManager`. Spring Data Redis does not ship with a `PlatformTransactionManager` implementation. Assuming your application uses JDBC, Spring Data Redis can participate in transactions by using existing transaction managers. ==== diff --git a/src/main/asciidoc/reference/redis.adoc b/src/main/asciidoc/reference/redis.adoc index 6f2bc36e7f..3d57c271e0 100644 --- a/src/main/asciidoc/reference/redis.adoc +++ b/src/main/asciidoc/reference/redis.adoc @@ -2,7 +2,7 @@ = Redis support :referenceDir: . -One of the key-value stores supported by Spring Data is http://redis.io[Redis]. To quote the Redis project home page: +One of the key-value stores supported by Spring Data is https://redis.io[Redis]. To quote the Redis project home page: [quote] Redis is an advanced key-value store. It is similar to memcached but the dataset is not volatile, and values can be strings, exactly like in memcached, but also lists, sets, and ordered sets. All this data types can be manipulated with atomic operations to push/pop elements, add/remove elements, perform server side union, intersection, difference between sets, and so forth. Redis supports different kind of sorting abilities. @@ -12,7 +12,7 @@ Spring Data Redis provides easy configuration and access to Redis from Spring ap [[redis:requirements]] == Redis Requirements -Spring Redis requires Redis 2.6 or above and Spring Data Redis integrates with http://github.com/lettuce-io/lettuce-core[Lettuce] and http://github.com/xetorthio/jedis[Jedis], two popular open-source Java libraries for Redis. +Spring Redis requires Redis 2.6 or above and Spring Data Redis integrates with https://github.com/lettuce-io/lettuce-core[Lettuce] and https://github.com/xetorthio/jedis[Jedis], two popular open-source Java libraries for Redis. [[redis:architecture]] == Redis Support High-level View @@ -27,11 +27,11 @@ One of the first tasks when using Redis and Spring is to connect to the store th [[redis:connectors:connection]] === RedisConnection and RedisConnectionFactory -`RedisConnection` provides the core building block for Redis communication, as it handles the communication with the Redis back end. It also automatically translates the underlying connecting library exceptions to Spring's consistent DAO exception http://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/data-access.html#dao-exceptions[hierarchy] so that you can switch the connectors without any code changes, as the operation semantics remain the same. +`RedisConnection` provides the core building block for Redis communication, as it handles the communication with the Redis back end. It also automatically translates the underlying connecting library exceptions to Spring's consistent DAO exception https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/data-access.html#dao-exceptions[hierarchy] so that you can switch the connectors without any code changes, as the operation semantics remain the same. NOTE: For the corner cases where the native library API is required, `RedisConnection` provides a dedicated method (`getNativeConnection`) that returns the raw, underlying object used for communication. -Active `RedisConnection` objects are created through `RedisConnectionFactory`. In addition, the factory acts as `PersistenceExceptionTranslator` objects, meaning that, once declared, they let you do transparent exception translation. For example, you can do exception translation through the use of the `@Repository` annotation and AOP. For more information, see the dedicated http://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/data-access.html#orm-exception-translation[section] in the Spring Framework documentation. +Active `RedisConnection` objects are created through `RedisConnectionFactory`. In addition, the factory acts as `PersistenceExceptionTranslator` objects, meaning that, once declared, they let you do transparent exception translation. For example, you can do exception translation through the use of the `@Repository` annotation and AOP. For more information, see the dedicated https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/data-access.html#orm-exception-translation[section] in the Spring Framework documentation. NOTE: Depending on the underlying configuration, the factory can return a new connection or an existing connection (when a pool or shared native connection is used). @@ -42,7 +42,7 @@ IMPORTANT: Unfortunately, currently, not all connectors support all Redis featur [[redis:connectors:lettuce]] === Configuring the Lettuce Connector -https://github.com/lettuce-io/lettuce-core[Lettuce] is a http://netty.io/[Netty]-based open-source connector supported by Spring Data Redis through the `org.springframework.data.redis.connection.lettuce` package. The following example shows how to create a new Lettuce connection factory: +https://github.com/lettuce-io/lettuce-core[Lettuce] is a https://netty.io/[Netty]-based open-source connector supported by Spring Data Redis through the `org.springframework.data.redis.connection.lettuce` package. The following example shows how to create a new Lettuce connection factory: [source,java] ---- @@ -59,7 +59,7 @@ class AppConfig { There are also a few Lettuce-specific connection parameters that can be tweaked. By default, all `LettuceConnection` instances created by the `LettuceConnectionFactory` share the same thread-safe native connection for all non-blocking and non-transactional operations. To use a dedicated connection each time, set `shareNativeConnection` to `false`. `LettuceConnectionFactory` can also be configured to use a `LettucePool` for pooling blocking and transactional connections or all connections if `shareNativeConnection` is set to `false`. -Lettuce integrates with Netty's http://netty.io/wiki/native-transports.html[native transports], letting you use Unix domain sockets to communicate with Redis. Make sure to include the appropriate native transport dependencies that match your runtime environment. The following example shows how to create a Lettuce Connection factory for a Unix domain socket at `/var/run/redis.sock`: +Lettuce integrates with Netty's https://netty.io/wiki/native-transports.html[native transports], letting you use Unix domain sockets to communicate with Redis. Make sure to include the appropriate native transport dependencies that match your runtime environment. The following example shows how to create a Lettuce Connection factory for a Unix domain socket at `/var/run/redis.sock`: [source,java] ---- @@ -79,7 +79,7 @@ NOTE: Netty currently supports the epoll (Linux) and kqueue (BSD/macOS) interfac [[redis:connectors:jedis]] === Configuring the Jedis Connector -http://github.com/xetorthio/jedis[Jedis] is a community-driven connector supported by the Spring Data Redis module through the `org.springframework.data.redis.connection.jedis` package. In its simplest form, the Jedis configuration looks as follow: +https://github.com/xetorthio/jedis[Jedis] is a community-driven connector supported by the Spring Data Redis module through the `org.springframework.data.redis.connection.jedis` package. In its simplest form, the Jedis configuration looks as follow: [source,java] ---- @@ -138,7 +138,7 @@ TIP: For environments reporting non-public addresses through the `INFO` command [[redis:sentinel]] == Redis Sentinel Support -For dealing with high-availability Redis, Spring Data Redis has support for http://redis.io/topics/sentinel[Redis Sentinel], using `RedisSentinelConfiguration`, as shown in the following example: +For dealing with high-availability Redis, Spring Data Redis has support for https://redis.io/topics/sentinel[Redis Sentinel], using `RedisSentinelConfiguration`, as shown in the following example: [source,java] ---- @@ -183,7 +183,7 @@ Sometimes, direct interaction with one of the Sentinels is required. Using `Redi Most users are likely to use `RedisTemplate` and its corresponding package, `org.springframework.data.redis.core`. The template is, in fact, the central class of the Redis module, due to its rich feature set. The template offers a high-level abstraction for Redis interactions. While `RedisConnection` offers low-level methods that accept and return binary values (`byte` arrays), the template takes care of serialization and connection management, freeing the user from dealing with such details. -Moreover, the template provides operations views (following the grouping from the Redis command http://redis.io/commands[reference]) that offer rich, generified interfaces for working against a certain type or certain key (through the `KeyBound` interfaces) as described in the following table: +Moreover, the template provides operations views (following the grouping from the Redis command https://redis.io/commands[reference]) that offer rich, generified interfaces for working against a certain type or certain key (through the `KeyBound` interfaces) as described in the following table: .Operational views [width="80%",cols="<1,<2",options="header"] @@ -251,7 +251,7 @@ For cases where you need a certain template view, declare the view as a dependen + xsi:schemaLocation="http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd"> @@ -290,7 +290,7 @@ Since it is quite common for the keys and values stored in Redis to be `java.lan + xsi:schemaLocation="http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd"> @@ -347,7 +347,7 @@ Multiple implementations are available (including two that have been already men * `JdkSerializationRedisSerializer`, which is used by default for `RedisCache` and `RedisTemplate`. * the `StringRedisSerializer`. -However one can use `OxmSerializer` for Object/XML mapping through Spring http://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/data-access.html#oxm[OXM] support or `Jackson2JsonRedisSerializer` or `GenericJackson2JsonRedisSerializer` for storing data in http://en.wikipedia.org/wiki/JSON[JSON] format. +However one can use `OxmSerializer` for Object/XML mapping through Spring https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/data-access.html#oxm[OXM] support or `Jackson2JsonRedisSerializer` or `GenericJackson2JsonRedisSerializer` for storing data in https://en.wikipedia.org/wiki/JSON[JSON] format. Do note that the storage format is not limited only to values. It can be used for keys, values, or hashes without any restrictions. @@ -358,14 +358,14 @@ By default, `RedisCache` and `RedisTemplate` are configured to use Java native s If you are concerned about security vulnerabilities due to Java serialization, consider the general-purpose serialization filter mechanism at the core JVM level, originally developed for JDK 9 but backported to JDK 8, 7, and 6: * https://blogs.oracle.com/java-platform-group/entry/incoming_filter_serialization_data_a[Filter Incoming Serialization Data]. -* http://openjdk.java.net/jeps/290[JEP 290]. +* https://openjdk.java.net/jeps/290[JEP 290]. * https://www.owasp.org/index.php/Deserialization_of_untrusted_data[OWASP: Deserialization of untrusted data]. ==== [[redis.hashmappers.root]] == Hash mapping -Data can be stored by using various data structures within Redis. `Jackson2JsonRedisSerializer` can convert objects in http://en.wikipedia.org/wiki/JSON[JSON] format. Ideally, JSON can be stored as a value by using plain keys. You can achieve a more sophisticated mapping of structured objects by using Redis hashes. Spring Data Redis offers various strategies for mapping data to hashes (depending on the use case): +Data can be stored by using various data structures within Redis. `Jackson2JsonRedisSerializer` can convert objects in https://en.wikipedia.org/wiki/JSON[JSON] format. Ideally, JSON can be stored as a value by using plain keys. You can achieve a more sophisticated mapping of structured objects by using Redis hashes. Spring Data Redis offers various strategies for mapping data to hashes (depending on the use case): * Direct mapping, by using `HashOperations` and a <> * Using <> @@ -377,7 +377,7 @@ Hash mappers are converters of map objects to a `Map` and back. `HashMappe Multiple implementations are available: -* `BeanUtilsHashMapper` using Spring's http://docs.spring.io/spring/docs/{springVersion}/javadoc-api/org/springframework/beans/BeanUtils.html[BeanUtils]. +* `BeanUtilsHashMapper` using Spring's https://docs.spring.io/spring/docs/{springVersion}/javadoc-api/org/springframework/beans/BeanUtils.html[BeanUtils]. * `ObjectHashMapper` using <>. * <> using https://github.com/FasterXML/jackson[FasterXML Jackson]. @@ -494,7 +494,7 @@ include::{referenceDir}/redis-scripting.adoc[] [[redis:support]] == Support Classes -Package `org.springframework.data.redis.support` offers various reusable components that rely on Redis as a backing store. Currently, the package contains various JDK-based interface implementations on top of Redis, such as http://download.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/package-summary.html[atomic] counters and JDK http://download.oracle.com/javase/8/docs/api/java/util/Collection.html[Collections]. +Package `org.springframework.data.redis.support` offers various reusable components that rely on Redis as a backing store. Currently, the package contains various JDK-based interface implementations on top of Redis, such as https://download.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/package-summary.html[atomic] counters and JDK https://download.oracle.com/javase/8/docs/api/java/util/Collection.html[Collections]. The atomic counters make it easy to wrap Redis key incrementation while the collections allow easy management of Redis keys with minimal storage exposure or API leakage. In particular, the `RedisSet` and `RedisZSet` interfaces offer easy access to the set operations supported by Redis, such as `intersection` and `union`. `RedisList` implements the `List`, `Queue`, and `Deque` contracts (and their equivalent blocking siblings) on top of Redis, exposing the storage as a FIFO (First-In-First-Out), LIFO (Last-In-First-Out) or capped collection with minimal configuration. The following example shows the configuration for a bean that uses a `RedisList`: @@ -504,7 +504,7 @@ The atomic counters make it easy to wrap Redis key incrementation while the coll + http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd"> @@ -536,7 +536,7 @@ As shown in the preceding example, the consuming code is decoupled from the actu NOTE: Changed in 2.0 -Spring Redis provides an implementation for the Spring http://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/integration.html#cache[cache abstraction] through the `org.springframework.data.redis.cache` package. To use Redis as a backing implementation, add `RedisCacheManager` to your configuration, as follows: +Spring Redis provides an implementation for the Spring https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/integration.html#cache[cache abstraction] through the `org.springframework.data.redis.cache` package. To use Redis as a backing implementation, add `RedisCacheManager` to your configuration, as follows: [source,java] ---- diff --git a/src/main/java/org/springframework/data/redis/connection/BitFieldSubCommands.java b/src/main/java/org/springframework/data/redis/connection/BitFieldSubCommands.java index 82cb4e4753..4a927975e8 100644 --- a/src/main/java/org/springframework/data/redis/connection/BitFieldSubCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/BitFieldSubCommands.java @@ -328,7 +328,7 @@ public interface BitFieldSubCommand { /** * Offset used inside a {@link BitFieldSubCommand}. Can be zero or type based. See - * Bits and positional offsets in the + * Bits and positional offsets in the * Redis reference. * * @author Christoph Strobl diff --git a/src/main/java/org/springframework/data/redis/connection/ReactiveGeoCommands.java b/src/main/java/org/springframework/data/redis/connection/ReactiveGeoCommands.java index 092dc0ae1b..1e11af6488 100644 --- a/src/main/java/org/springframework/data/redis/connection/ReactiveGeoCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/ReactiveGeoCommands.java @@ -57,7 +57,7 @@ public interface ReactiveGeoCommands { * {@code GEOADD} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD */ class GeoAddCommand extends KeyCommand { @@ -121,7 +121,7 @@ public List> getGeoLocations() { * @param point must not be {@literal null}. * @param member must not be {@literal null}. * @return - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD */ default Mono geoAdd(ByteBuffer key, Point point, ByteBuffer member) { @@ -138,7 +138,7 @@ default Mono geoAdd(ByteBuffer key, Point point, ByteBuffer member) { * @param key must not be {@literal null}. * @param location must not be {@literal null}. * @return - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD */ default Mono geoAdd(ByteBuffer key, GeoLocation location) { @@ -154,7 +154,7 @@ default Mono geoAdd(ByteBuffer key, GeoLocation location) { * @param key must not be {@literal null}. * @param locations must not be {@literal null}. * @return - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD */ default Mono geoAdd(ByteBuffer key, Collection> locations) { @@ -169,7 +169,7 @@ default Mono geoAdd(ByteBuffer key, Collection> lo * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD */ Flux> geoAdd(Publisher commands); @@ -177,7 +177,7 @@ default Mono geoAdd(ByteBuffer key, Collection> lo * {@code GEODIST} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: GEODIST + * @see Redis Documentation: GEODIST */ class GeoDistCommand extends KeyCommand { @@ -306,7 +306,7 @@ public Optional getMetric() { * @param from must not be {@literal null}. * @param to must not be {@literal null}. * @return - * @see Redis Documentation: GEODIST + * @see Redis Documentation: GEODIST */ default Mono geoDist(ByteBuffer key, ByteBuffer from, ByteBuffer to) { return geoDist(key, from, to, DistanceUnit.METERS); @@ -320,7 +320,7 @@ default Mono geoDist(ByteBuffer key, ByteBuffer from, ByteBuffer to) { * @param to must not be {@literal null}. * @param metric must not be {@literal null}. * @return - * @see Redis Documentation: GEODIST + * @see Redis Documentation: GEODIST */ default Mono geoDist(ByteBuffer key, ByteBuffer from, ByteBuffer to, Metric metric) { @@ -339,7 +339,7 @@ default Mono geoDist(ByteBuffer key, ByteBuffer from, ByteBuffer to, M * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: GEODIST + * @see Redis Documentation: GEODIST */ Flux> geoDist(Publisher commands); @@ -347,7 +347,7 @@ default Mono geoDist(ByteBuffer key, ByteBuffer from, ByteBuffer to, M * {@code GEOHASH} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: GEOHASH + * @see Redis Documentation: GEOHASH */ class GeoHashCommand extends KeyCommand { @@ -413,7 +413,7 @@ public List getMembers() { * @param key must not be {@literal null}. * @param member must not be {@literal null}. * @return - * @see Redis Documentation: GEOHASH + * @see Redis Documentation: GEOHASH */ default Mono geoHash(ByteBuffer key, ByteBuffer member) { @@ -429,7 +429,7 @@ default Mono geoHash(ByteBuffer key, ByteBuffer member) { * @param key must not be {@literal null}. * @param members must not be {@literal null}. * @return - * @see Redis Documentation: GEOHASH + * @see Redis Documentation: GEOHASH */ default Mono> geoHash(ByteBuffer key, Collection members) { @@ -446,7 +446,7 @@ default Mono> geoHash(ByteBuffer key, Collection member * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: GEOHASH + * @see Redis Documentation: GEOHASH */ Flux> geoHash(Publisher commands); @@ -454,7 +454,7 @@ default Mono> geoHash(ByteBuffer key, Collection member * {@code GEOPOS} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: GEOPOS + * @see Redis Documentation: GEOPOS */ class GeoPosCommand extends KeyCommand { @@ -520,7 +520,7 @@ public List getMembers() { * @param key must not be {@literal null}. * @param member must not be {@literal null}. * @return - * @see Redis Documentation: GEOPOS + * @see Redis Documentation: GEOPOS */ default Mono geoPos(ByteBuffer key, ByteBuffer member) { @@ -536,7 +536,7 @@ default Mono geoPos(ByteBuffer key, ByteBuffer member) { * @param key must not be {@literal null}. * @param members must not be {@literal null}. * @return - * @see Redis Documentation: GEOPOS + * @see Redis Documentation: GEOPOS */ default Mono> geoPos(ByteBuffer key, Collection members) { @@ -551,7 +551,7 @@ default Mono> geoPos(ByteBuffer key, Collection members) * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: GEOPOS + * @see Redis Documentation: GEOPOS */ Flux> geoPos(Publisher commands); @@ -559,7 +559,7 @@ default Mono> geoPos(ByteBuffer key, Collection members) * {@code GEORADIUS} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: GEORADIUS + * @see Redis Documentation: GEORADIUS */ class GeoRadiusCommand extends KeyCommand { @@ -868,7 +868,7 @@ private GeoRadiusCommandArgs cloneArgs() { * @param key must not be {@literal null}. * @param circle must not be {@literal null}. * @return - * @see Redis Documentation: GEORADIUS + * @see Redis Documentation: GEORADIUS */ default Flux>> geoRadius(ByteBuffer key, Circle circle) { return geoRadius(key, circle, GeoRadiusCommandArgs.newGeoRadiusArgs()); @@ -881,7 +881,7 @@ default Flux>> geoRadius(ByteBuffer key, Circl * @param circle must not be {@literal null}. * @param geoRadiusArgs must not be {@literal null}. * @return - * @see Redis Documentation: GEORADIUS + * @see Redis Documentation: GEORADIUS */ default Flux>> geoRadius(ByteBuffer key, Circle circle, GeoRadiusCommandArgs geoRadiusArgs) { @@ -899,7 +899,7 @@ default Flux>> geoRadius(ByteBuffer key, Circl * * @param commands * @return - * @see Redis Documentation: GEORADIUS + * @see Redis Documentation: GEORADIUS */ Flux>>>> geoRadius( Publisher commands); @@ -908,7 +908,7 @@ Flux>>> * {@code GEORADIUSBYMEMBER} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER */ class GeoRadiusByMemberCommand extends KeyCommand { @@ -1201,7 +1201,7 @@ private GeoRadiusCommandArgs cloneArgs() { * @param key must not be {@literal null}. * @param member must not be {@literal null}. * @return - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER */ default Flux>> geoRadiusByMember(ByteBuffer key, ByteBuffer member, Distance distance) { @@ -1215,7 +1215,7 @@ default Flux>> geoRadiusByMember(ByteBuffer ke * @param member must not be {@literal null}. * @param geoRadiusArgs must not be {@literal null}. * @return - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER */ default Flux>> geoRadiusByMember(ByteBuffer key, ByteBuffer member, Distance distance, GeoRadiusCommandArgs geoRadiusArgs) { @@ -1235,7 +1235,7 @@ default Flux>> geoRadiusByMember(ByteBuffer ke * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER */ Flux>>>> geoRadiusByMember( Publisher commands); diff --git a/src/main/java/org/springframework/data/redis/connection/ReactiveHashCommands.java b/src/main/java/org/springframework/data/redis/connection/ReactiveHashCommands.java index e52ad3781a..70aafea393 100644 --- a/src/main/java/org/springframework/data/redis/connection/ReactiveHashCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/ReactiveHashCommands.java @@ -51,7 +51,7 @@ public interface ReactiveHashCommands { * {@literal HSET} {@link Command}. * * @author Christoph Strobl - * @see Redis Documentation: HSET + * @see Redis Documentation: HSET */ class HSetCommand extends KeyCommand { @@ -154,7 +154,7 @@ public Map getFieldValueMap() { * @param field must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: HSET + * @see Redis Documentation: HSET */ default Mono hSet(ByteBuffer key, ByteBuffer field, ByteBuffer value) { @@ -172,7 +172,7 @@ default Mono hSet(ByteBuffer key, ByteBuffer field, ByteBuffer value) { * @param field must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: HSETNX + * @see Redis Documentation: HSETNX */ default Mono hSetNX(ByteBuffer key, ByteBuffer field, ByteBuffer value) { @@ -190,7 +190,7 @@ default Mono hSetNX(ByteBuffer key, ByteBuffer field, ByteBuffer value) * @param key must not be {@literal null}. * @param fieldValueMap must not be {@literal null}. * @return - * @see Redis Documentation: HMSET + * @see Redis Documentation: HMSET */ default Mono hMSet(ByteBuffer key, Map fieldValueMap) { @@ -205,7 +205,7 @@ default Mono hMSet(ByteBuffer key, Map fieldVal * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: HSET + * @see Redis Documentation: HSET */ Flux> hSet(Publisher commands); @@ -213,7 +213,7 @@ default Mono hMSet(ByteBuffer key, Map fieldVal * {@literal HGET} {@link Command}. * * @author Christoph Strobl - * @see Redis Documentation: HGET + * @see Redis Documentation: HGET */ class HGetCommand extends KeyCommand { @@ -279,7 +279,7 @@ public List getFields() { * @param key must not be {@literal null}. * @param field must not be {@literal null}. * @return - * @see Redis Documentation: HGET + * @see Redis Documentation: HGET */ default Mono hGet(ByteBuffer key, ByteBuffer field) { return hMGet(key, Collections.singletonList(field)).map(val -> val.isEmpty() ? null : val.iterator().next()); @@ -291,7 +291,7 @@ default Mono hGet(ByteBuffer key, ByteBuffer field) { * @param key must not be {@literal null}. * @param fields must not be {@literal null}. * @return - * @see Redis Documentation: HMGET + * @see Redis Documentation: HMGET */ default Mono> hMGet(ByteBuffer key, Collection fields) { @@ -306,7 +306,7 @@ default Mono> hMGet(ByteBuffer key, Collection fiel * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: HMGET + * @see Redis Documentation: HMGET */ Flux> hMGet(Publisher commands); @@ -314,7 +314,7 @@ default Mono> hMGet(ByteBuffer key, Collection fiel * {@literal HEXISTS} {@link Command}. * * @author Christoph Strobl - * @see Redis Documentation: HEXISTS + * @see Redis Documentation: HEXISTS */ class HExistsCommand extends KeyCommand { @@ -367,7 +367,7 @@ public ByteBuffer getField() { * @param key must not be {@literal null}. * @param field must not be {@literal null}. * @return - * @see Redis Documentation: HEXISTS + * @see Redis Documentation: HEXISTS */ default Mono hExists(ByteBuffer key, ByteBuffer field) { @@ -382,13 +382,13 @@ default Mono hExists(ByteBuffer key, ByteBuffer field) { * * @param commands * @return - * @see Redis Documentation: HEXISTS + * @see Redis Documentation: HEXISTS */ Flux> hExists(Publisher commands); /** * @author Christoph Strobl - * @see Redis Documentation: HDEL + * @see Redis Documentation: HDEL */ class HDelCommand extends KeyCommand { @@ -454,7 +454,7 @@ public List getFields() { * @param key must not be {@literal null}. * @param field must not be {@literal null}. * @return - * @see Redis Documentation: HDEL + * @see Redis Documentation: HDEL */ default Mono hDel(ByteBuffer key, ByteBuffer field) { @@ -469,7 +469,7 @@ default Mono hDel(ByteBuffer key, ByteBuffer field) { * @param key must not be {@literal null}. * @param fields must not be {@literal null}. * @return - * @see Redis Documentation: HDEL + * @see Redis Documentation: HDEL */ default Mono hDel(ByteBuffer key, Collection fields) { @@ -484,7 +484,7 @@ default Mono hDel(ByteBuffer key, Collection fields) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: HDEL + * @see Redis Documentation: HDEL */ Flux> hDel(Publisher commands); @@ -493,7 +493,7 @@ default Mono hDel(ByteBuffer key, Collection fields) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: HLEN + * @see Redis Documentation: HLEN */ default Mono hLen(ByteBuffer key) { @@ -507,7 +507,7 @@ default Mono hLen(ByteBuffer key) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: HLEN + * @see Redis Documentation: HLEN */ Flux> hLen(Publisher commands); @@ -516,7 +516,7 @@ default Mono hLen(ByteBuffer key) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: HKEYS + * @see Redis Documentation: HKEYS */ default Flux hKeys(ByteBuffer key) { @@ -530,7 +530,7 @@ default Flux hKeys(ByteBuffer key) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: HKEYS + * @see Redis Documentation: HKEYS */ Flux>> hKeys(Publisher commands); @@ -539,7 +539,7 @@ default Flux hKeys(ByteBuffer key) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: HVALS + * @see Redis Documentation: HVALS */ default Flux hVals(ByteBuffer key) { @@ -553,7 +553,7 @@ default Flux hVals(ByteBuffer key) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: HVALS + * @see Redis Documentation: HVALS */ Flux>> hVals(Publisher commands); @@ -562,7 +562,7 @@ default Flux hVals(ByteBuffer key) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: HGETALL + * @see Redis Documentation: HGETALL */ default Flux> hGetAll(ByteBuffer key) { @@ -576,7 +576,7 @@ default Flux> hGetAll(ByteBuffer key) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: HGETALL + * @see Redis Documentation: HGETALL */ Flux>>> hGetAll(Publisher commands); @@ -587,7 +587,7 @@ default Flux> hGetAll(ByteBuffer key) { * @param key must not be {@literal null}. * @return the {@link Flux} emitting {@link java.util.Map.Entry entries} one by one. * @throws IllegalArgumentException in case the given key is {@literal null}. - * @see Redis Documentation: HSCAN + * @see Redis Documentation: HSCAN * @since 2.1 */ default Flux> hScan(ByteBuffer key) { @@ -602,7 +602,7 @@ default Flux> hScan(ByteBuffer key) { * @param options must not be {@literal null}. Use {@link ScanOptions#NONE} instead. * @return the {@link Flux} emitting the raw {@link java.util.Map.Entry entries} one by one. * @throws IllegalArgumentException in case one of the required arguments is {@literal null}. - * @see Redis Documentation: HSCAN + * @see Redis Documentation: HSCAN * @since 2.1 */ default Flux> hScan(ByteBuffer key, ScanOptions options) { @@ -617,14 +617,14 @@ default Flux> hScan(ByteBuffer key, ScanOption * * @param commands must not be {@literal null}. * @return the {@link Flux} emitting {@link CommandResponse} one by one. - * @see Redis Documentation: HSCAN + * @see Redis Documentation: HSCAN * @since 2.1 */ Flux>>> hScan(Publisher commands); /** * @author Christoph Strobl - * @see Redis Documentation: HSTRLEN + * @see Redis Documentation: HSTRLEN * @since 2.1 */ class HStrLenCommand extends KeyCommand { diff --git a/src/main/java/org/springframework/data/redis/connection/ReactiveHyperLogLogCommands.java b/src/main/java/org/springframework/data/redis/connection/ReactiveHyperLogLogCommands.java index 6cb87d50f6..616b3f0a25 100644 --- a/src/main/java/org/springframework/data/redis/connection/ReactiveHyperLogLogCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/ReactiveHyperLogLogCommands.java @@ -44,7 +44,7 @@ public interface ReactiveHyperLogLogCommands { * {@code PFADD} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: PFADD + * @see Redis Documentation: PFADD */ class PfAddCommand extends KeyCommand { @@ -109,7 +109,7 @@ public List getValues() { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: PFADD + * @see Redis Documentation: PFADD */ default Mono pfAdd(ByteBuffer key, ByteBuffer value) { @@ -124,7 +124,7 @@ default Mono pfAdd(ByteBuffer key, ByteBuffer value) { * @param key must not be {@literal null}. * @param values must not be {@literal null}. * @return - * @see Redis Documentation: PFADD + * @see Redis Documentation: PFADD */ default Mono pfAdd(ByteBuffer key, Collection values) { @@ -139,7 +139,7 @@ default Mono pfAdd(ByteBuffer key, Collection values) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: PFADD + * @see Redis Documentation: PFADD */ Flux> pfAdd(Publisher commands); @@ -147,7 +147,7 @@ default Mono pfAdd(ByteBuffer key, Collection values) { * {@code PFCOUNT} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: PFCOUNT + * @see Redis Documentation: PFCOUNT */ class PfCountCommand implements Command { @@ -206,7 +206,7 @@ public ByteBuffer getKey() { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: PFCOUNT + * @see Redis Documentation: PFCOUNT */ default Mono pfCount(ByteBuffer key) { @@ -220,7 +220,7 @@ default Mono pfCount(ByteBuffer key) { * * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: PFCOUNT + * @see Redis Documentation: PFCOUNT */ default Mono pfCount(Collection keys) { @@ -234,7 +234,7 @@ default Mono pfCount(Collection keys) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: PFCOUNT + * @see Redis Documentation: PFCOUNT */ Flux> pfCount(Publisher commands); @@ -242,7 +242,7 @@ default Mono pfCount(Collection keys) { * {@code PFMERGE} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: PFMERGE + * @see Redis Documentation: PFMERGE */ class PfMergeCommand extends KeyCommand { @@ -295,7 +295,7 @@ public List getSourceKeys() { * @param destinationKey must not be {@literal null}. * @param sourceKeys must not be {@literal null}. * @return - * @see Redis Documentation: PFMERGE + * @see Redis Documentation: PFMERGE */ default Mono pfMerge(ByteBuffer destinationKey, Collection sourceKeys) { @@ -311,7 +311,7 @@ default Mono pfMerge(ByteBuffer destinationKey, Collection * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: PFMERGE + * @see Redis Documentation: PFMERGE */ Flux> pfMerge(Publisher commands); } diff --git a/src/main/java/org/springframework/data/redis/connection/ReactiveKeyCommands.java b/src/main/java/org/springframework/data/redis/connection/ReactiveKeyCommands.java index c2b9ffc5a3..a3ec9365b7 100644 --- a/src/main/java/org/springframework/data/redis/connection/ReactiveKeyCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/ReactiveKeyCommands.java @@ -48,7 +48,7 @@ public interface ReactiveKeyCommands { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: EXISTS + * @see Redis Documentation: EXISTS */ default Mono exists(ByteBuffer key) { @@ -62,7 +62,7 @@ default Mono exists(ByteBuffer key) { * * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: EXISTS + * @see Redis Documentation: EXISTS */ Flux> exists(Publisher keys); @@ -71,7 +71,7 @@ default Mono exists(ByteBuffer key) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: TYPE + * @see Redis Documentation: TYPE */ default Mono type(ByteBuffer key) { @@ -85,7 +85,7 @@ default Mono type(ByteBuffer key) { * * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: TYPE + * @see Redis Documentation: TYPE */ Flux> type(Publisher keys); @@ -94,7 +94,7 @@ default Mono type(ByteBuffer key) { * * @param keys must not be {@literal null}. * @return {@link Mono} emitting the number of keys touched. - * @see Redis Documentation: TOUCH + * @see Redis Documentation: TOUCH * @since 2.1 */ default Mono touch(Collection keys) { @@ -106,7 +106,7 @@ default Mono touch(Collection keys) { * * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: TOUCH + * @see Redis Documentation: TOUCH * @since 2.1 */ Flux, Long>> touch(Publisher> keys); @@ -118,7 +118,7 @@ default Mono touch(Collection keys) { * * @param pattern must not be {@literal null}. * @return - * @see Redis Documentation: KEYS + * @see Redis Documentation: KEYS */ default Mono> keys(ByteBuffer pattern) { @@ -134,7 +134,7 @@ default Mono> keys(ByteBuffer pattern) { * * @param patterns must not be {@literal null}. * @return - * @see Redis Documentation: KEYS + * @see Redis Documentation: KEYS */ Flux> keys(Publisher patterns); @@ -143,7 +143,7 @@ default Mono> keys(ByteBuffer pattern) { * commands itself as long as the subscriber signals demand. * * @return never {@literal null}. - * @see Redis Documentation: SCAN + * @see Redis Documentation: SCAN * @since 2.1 */ default Flux scan() { @@ -157,7 +157,7 @@ default Flux scan() { * @param options must not be {@literal null}. * @return the {@link Flux} emitting {@link ByteBuffer keys} one by one. * @throws IllegalArgumentException when options is {@literal null}. - * @see Redis Documentation: SCAN + * @see Redis Documentation: SCAN * @since 2.1 */ Flux scan(ScanOptions options); @@ -166,7 +166,7 @@ default Flux scan() { * Return a random key from the keyspace. * * @return - * @see Redis Documentation: RANDOMKEY + * @see Redis Documentation: RANDOMKEY */ Mono randomKey(); @@ -174,7 +174,7 @@ default Flux scan() { * {@code RENAME} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: RENAME + * @see Redis Documentation: RENAME */ class RenameCommand extends KeyCommand { @@ -228,7 +228,7 @@ public ByteBuffer getNewName() { * @param key must not be {@literal null}. * @param newName must not be {@literal null}. * @return - * @see Redis Documentation: RENAME + * @see Redis Documentation: RENAME */ default Mono rename(ByteBuffer key, ByteBuffer newName) { @@ -242,7 +242,7 @@ default Mono rename(ByteBuffer key, ByteBuffer newName) { * * @param command must not be {@literal null}. * @return - * @see Redis Documentation: RENAME + * @see Redis Documentation: RENAME */ Flux> rename(Publisher command); @@ -252,7 +252,7 @@ default Mono rename(ByteBuffer key, ByteBuffer newName) { * @param key must not be {@literal null}. * @param newName must not be {@literal null}. * @return - * @see Redis Documentation: RENAMENX + * @see Redis Documentation: RENAMENX */ default Mono renameNX(ByteBuffer key, ByteBuffer newName) { @@ -266,7 +266,7 @@ default Mono renameNX(ByteBuffer key, ByteBuffer newName) { * * @param command must not be {@literal null}. * @return - * @see Redis Documentation: RENAMENX + * @see Redis Documentation: RENAMENX */ Flux> renameNX(Publisher command); @@ -275,7 +275,7 @@ default Mono renameNX(ByteBuffer key, ByteBuffer newName) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: DEL + * @see Redis Documentation: DEL */ default Mono del(ByteBuffer key) { @@ -289,7 +289,7 @@ default Mono del(ByteBuffer key) { * * @param keys must not be {@literal null}. * @return {@link Flux} of {@link NumericResponse} holding the {@literal key} removed along with the deletion result. - * @see Redis Documentation: DEL + * @see Redis Documentation: DEL */ Flux> del(Publisher keys); @@ -298,7 +298,7 @@ default Mono del(ByteBuffer key) { * * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: DEL + * @see Redis Documentation: DEL */ default Mono mDel(List keys) { @@ -312,7 +312,7 @@ default Mono mDel(List keys) { * * @param keys must not be {@literal null}. * @return {@link Flux} of {@link NumericResponse} holding the {@literal keys} removed along with the deletion result. - * @see Redis Documentation: DEL + * @see Redis Documentation: DEL */ Flux, Long>> mDel(Publisher> keys); @@ -322,7 +322,7 @@ default Mono mDel(List keys) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: UNLINK + * @see Redis Documentation: UNLINK * @since 2.1 */ default Mono unlink(ByteBuffer key) { @@ -338,7 +338,7 @@ default Mono unlink(ByteBuffer key) { * * @param keys must not be {@literal null}. * @return {@link Flux} of {@link NumericResponse} holding the {@literal key} removed along with the unlink result. - * @see Redis Documentation: UNLINK + * @see Redis Documentation: UNLINK * @since 2.1 */ Flux> unlink(Publisher keys); @@ -349,7 +349,7 @@ default Mono unlink(ByteBuffer key) { * * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: UNLINK + * @see Redis Documentation: UNLINK * @since 2.1 */ default Mono mUnlink(List keys) { @@ -365,7 +365,7 @@ default Mono mUnlink(List keys) { * * @param keys must not be {@literal null}. * @return {@link Flux} of {@link NumericResponse} holding the {@literal key} removed along with the deletion result. - * @see Redis Documentation: UNLINK + * @see Redis Documentation: UNLINK * @since 2.1 */ Flux, Long>> mUnlink(Publisher> keys); @@ -374,8 +374,8 @@ default Mono mUnlink(List keys) { * {@code EXPIRE}/{@code PEXPIRE} command parameters. * * @author Mark Paluch - * @see Redis Documentation: EXPIRE - * @see Redis Documentation: PEXPIRE + * @see Redis Documentation: EXPIRE + * @see Redis Documentation: PEXPIRE */ class ExpireCommand extends KeyCommand { @@ -429,7 +429,7 @@ public Duration getTimeout() { * @param key must not be {@literal null}. * @param timeout must not be {@literal null}. * @return - * @see Redis Documentation: EXPIRE + * @see Redis Documentation: EXPIRE */ default Mono expire(ByteBuffer key, Duration timeout) { @@ -445,7 +445,7 @@ default Mono expire(ByteBuffer key, Duration timeout) { * @param commands must not be {@literal null}. * @return {@link Flux} of {@link BooleanResponse} holding the {@literal key} removed along with the expiration * result. - * @see Redis Documentation: EXPIRE + * @see Redis Documentation: EXPIRE */ Flux> expire(Publisher commands); @@ -455,7 +455,7 @@ default Mono expire(ByteBuffer key, Duration timeout) { * @param key must not be {@literal null}. * @param timeout must not be {@literal null}. * @return - * @see Redis Documentation: PEXPIRE + * @see Redis Documentation: PEXPIRE */ default Mono pExpire(ByteBuffer key, Duration timeout) { @@ -471,7 +471,7 @@ default Mono pExpire(ByteBuffer key, Duration timeout) { * @param commands must not be {@literal null}. * @return {@link Flux} of {@link BooleanResponse} holding the {@literal key} removed along with the expiration * result. - * @see Redis Documentation: PEXPIRE + * @see Redis Documentation: PEXPIRE */ Flux> pExpire(Publisher commands); @@ -479,8 +479,8 @@ default Mono pExpire(ByteBuffer key, Duration timeout) { * {@code EXPIREAT}/{@code PEXPIREAT} command parameters. * * @author Mark Paluch - * @see Redis Documentation: EXPIREAT - * @see Redis Documentation: PEXPIREAT + * @see Redis Documentation: EXPIREAT + * @see Redis Documentation: PEXPIREAT */ class ExpireAtCommand extends KeyCommand { @@ -534,7 +534,7 @@ public Instant getExpireAt() { * @param key must not be {@literal null}. * @param expireAt must not be {@literal null}. * @return - * @see Redis Documentation: EXPIREAT + * @see Redis Documentation: EXPIREAT */ default Mono expireAt(ByteBuffer key, Instant expireAt) { @@ -550,7 +550,7 @@ default Mono expireAt(ByteBuffer key, Instant expireAt) { * @param commands must not be {@literal null}. * @return {@link Flux} of {@link BooleanResponse} holding the {@literal key} removed along with the expiration * result. - * @see Redis Documentation: EXPIREAT + * @see Redis Documentation: EXPIREAT */ Flux> expireAt(Publisher commands); @@ -560,7 +560,7 @@ default Mono expireAt(ByteBuffer key, Instant expireAt) { * @param key must not be {@literal null}. * @param expireAt must not be {@literal null}. * @return - * @see Redis Documentation: PEXPIREAT + * @see Redis Documentation: PEXPIREAT */ default Mono pExpireAt(ByteBuffer key, Instant expireAt) { @@ -576,7 +576,7 @@ default Mono pExpireAt(ByteBuffer key, Instant expireAt) { * @param commands must not be {@literal null}. * @return {@link Flux} of {@link BooleanResponse} holding the {@literal key} removed along with the expiration * result. - * @see Redis Documentation: PEXPIREAT + * @see Redis Documentation: PEXPIREAT */ Flux> pExpireAt(Publisher commands); @@ -585,7 +585,7 @@ default Mono pExpireAt(ByteBuffer key, Instant expireAt) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: PERSIST + * @see Redis Documentation: PERSIST */ default Mono persist(ByteBuffer key) { @@ -599,7 +599,7 @@ default Mono persist(ByteBuffer key) { * * @param commands must not be {@literal null}. * @return {@link Flux} of {@link BooleanResponse} holding the {@literal key} persisted along with the persist result. - * @see Redis Documentation: PERSIST + * @see Redis Documentation: PERSIST */ Flux> persist(Publisher commands); @@ -608,7 +608,7 @@ default Mono persist(ByteBuffer key) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: TTL + * @see Redis Documentation: TTL */ default Mono ttl(ByteBuffer key) { @@ -622,7 +622,7 @@ default Mono ttl(ByteBuffer key) { * * @param commands must not be {@literal null}. * @return {@link Flux} of {@link NumericResponse} holding the {@literal key} along with the time to live result. - * @see Redis Documentation: TTL + * @see Redis Documentation: TTL */ Flux> ttl(Publisher commands); @@ -631,7 +631,7 @@ default Mono ttl(ByteBuffer key) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: TTL + * @see Redis Documentation: TTL */ default Mono pTtl(ByteBuffer key) { @@ -645,7 +645,7 @@ default Mono pTtl(ByteBuffer key) { * * @param commands must not be {@literal null}. * @return {@link Flux} of {@link NumericResponse} holding the {@literal key} along with the time to live result. - * @see Redis Documentation: PTTL + * @see Redis Documentation: PTTL */ Flux> pTtl(Publisher commands); @@ -653,7 +653,7 @@ default Mono pTtl(ByteBuffer key) { * {@code MOVE} command parameters. * * @author Mark Paluch - * @see Redis Documentation: MOVE + * @see Redis Documentation: MOVE */ class MoveCommand extends KeyCommand { @@ -704,7 +704,7 @@ public Integer getDatabase() { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: MOVE + * @see Redis Documentation: MOVE */ default Mono move(ByteBuffer key, int database) { @@ -718,7 +718,7 @@ default Mono move(ByteBuffer key, int database) { * * @param commands must not be {@literal null}. * @return {@link Flux} of {@link BooleanResponse} holding the {@literal key} to move along with the move result. - * @see Redis Documentation: MOVE + * @see Redis Documentation: MOVE */ Flux> move(Publisher commands); @@ -728,7 +728,7 @@ default Mono move(ByteBuffer key, int database) { * @param key must not be {@literal null}. * @return the {@link Mono} emitting {@link org.springframework.data.redis.connection.ValueEncoding}. * @throws IllegalArgumentException if {@code key} is {@literal null}. - * @see Redis Documentation: OBJECT ENCODING + * @see Redis Documentation: OBJECT ENCODING * @since 2.1 */ Mono encodingOf(ByteBuffer key); @@ -739,7 +739,7 @@ default Mono move(ByteBuffer key, int database) { * @param key must not be {@literal null}. * @return the {@link Mono} emitting the idletime of the key of {@link Mono#empty()} if the key does not exist. * @throws IllegalArgumentException if {@code key} is {@literal null}. - * @see Redis Documentation: OBJECT IDLETIME + * @see Redis Documentation: OBJECT IDLETIME * @since 2.1 */ Mono idletime(ByteBuffer key); @@ -750,7 +750,7 @@ default Mono move(ByteBuffer key, int database) { * @param key must not be {@literal null}. * @return {@link Mono#empty()} if key does not exist. * @throws IllegalArgumentException if {@code key} is {@literal null}. - * @see Redis Documentation: OBJECT REFCOUNT + * @see Redis Documentation: OBJECT REFCOUNT * @since 2.1 */ Mono refcount(ByteBuffer key); diff --git a/src/main/java/org/springframework/data/redis/connection/ReactiveListCommands.java b/src/main/java/org/springframework/data/redis/connection/ReactiveListCommands.java index 5b3cdd85a6..3cc2def8b6 100644 --- a/src/main/java/org/springframework/data/redis/connection/ReactiveListCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/ReactiveListCommands.java @@ -57,8 +57,8 @@ enum Direction { * {@code LPUSH}/{@literal RPUSH} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: LPUSH - * @see Redis Documentation: RPUSH + * @see Redis Documentation: LPUSH + * @see Redis Documentation: RPUSH */ class PushCommand extends KeyCommand { @@ -169,7 +169,7 @@ public Direction getDirection() { * @param key must not be {@literal null}. * @param values must not be {@literal null}. * @return - * @see Redis Documentation: RPUSH + * @see Redis Documentation: RPUSH */ default Mono rPush(ByteBuffer key, List values) { @@ -185,7 +185,7 @@ default Mono rPush(ByteBuffer key, List values) { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: RPUSHX + * @see Redis Documentation: RPUSHX */ default Mono rPushX(ByteBuffer key, ByteBuffer value) { @@ -201,7 +201,7 @@ default Mono rPushX(ByteBuffer key, ByteBuffer value) { * @param key must not be {@literal null}. * @param values must not be {@literal null}. * @return - * @see Redis Documentation: LPUSH + * @see Redis Documentation: LPUSH */ default Mono lPush(ByteBuffer key, List values) { @@ -217,7 +217,7 @@ default Mono lPush(ByteBuffer key, List values) { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: LPUSHX + * @see Redis Documentation: LPUSHX */ default Mono lPushX(ByteBuffer key, ByteBuffer value) { @@ -232,8 +232,8 @@ default Mono lPushX(ByteBuffer key, ByteBuffer value) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: LPUSH - * @see Redis Documentation: RPUSH + * @see Redis Documentation: LPUSH + * @see Redis Documentation: RPUSH */ Flux> push(Publisher commands); @@ -242,7 +242,7 @@ default Mono lPushX(ByteBuffer key, ByteBuffer value) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: LLEN + * @see Redis Documentation: LLEN */ default Mono lLen(ByteBuffer key) { @@ -256,7 +256,7 @@ default Mono lLen(ByteBuffer key) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: LLEN + * @see Redis Documentation: LLEN */ Flux> lLen(Publisher commands); @@ -267,7 +267,7 @@ default Mono lLen(ByteBuffer key) { * @param start * @param end * @return - * @see Redis Documentation: LRANGE + * @see Redis Documentation: LRANGE */ default Flux lRange(ByteBuffer key, long start, long end) { @@ -281,7 +281,7 @@ default Flux lRange(ByteBuffer key, long start, long end) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: LRANGE + * @see Redis Documentation: LRANGE */ Flux>> lRange(Publisher commands); @@ -292,7 +292,7 @@ default Flux lRange(ByteBuffer key, long start, long end) { * @param start * @param end * @return - * @see Redis Documentation: LTRIM + * @see Redis Documentation: LTRIM */ default Mono lTrim(ByteBuffer key, long start, long end) { @@ -308,7 +308,7 @@ default Mono lTrim(ByteBuffer key, long start, long end) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: LTRIM + * @see Redis Documentation: LTRIM */ Flux> lTrim(Publisher commands); @@ -316,7 +316,7 @@ default Mono lTrim(ByteBuffer key, long start, long end) { * {@code LINDEX} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: LINDEX + * @see Redis Documentation: LINDEX */ class LIndexCommand extends KeyCommand { @@ -365,7 +365,7 @@ public Long getIndex() { * @param key must not be {@literal null}. * @param index * @return - * @see Redis Documentation: LINDEX + * @see Redis Documentation: LINDEX */ default Mono lIndex(ByteBuffer key, long index) { @@ -379,7 +379,7 @@ default Mono lIndex(ByteBuffer key, long index) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: LINDEX + * @see Redis Documentation: LINDEX */ Flux> lIndex(Publisher commands); @@ -387,7 +387,7 @@ default Mono lIndex(ByteBuffer key, long index) { * {@code LINSERT} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: LINSERT + * @see Redis Documentation: LINSERT */ class LInsertCommand extends KeyCommand { @@ -490,7 +490,7 @@ public ByteBuffer getPivot() { * @param pivot must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: LINSERT + * @see Redis Documentation: LINSERT */ default Mono lInsert(ByteBuffer key, Position position, ByteBuffer pivot, ByteBuffer value) { @@ -511,7 +511,7 @@ default Mono lInsert(ByteBuffer key, Position position, ByteBuffer pivot, * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: LINSERT + * @see Redis Documentation: LINSERT */ Flux> lInsert(Publisher commands); @@ -519,7 +519,7 @@ default Mono lInsert(ByteBuffer key, Position position, ByteBuffer pivot, * {@code LSET} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: LSET + * @see Redis Documentation: LSET */ class LSetCommand extends KeyCommand { @@ -592,7 +592,7 @@ public Long getIndex() { * @param index * @param value must not be {@literal null}. * @return - * @see Redis Documentation: LSET + * @see Redis Documentation: LSET */ default Mono lSet(ByteBuffer key, long index, ByteBuffer value) { @@ -607,7 +607,7 @@ default Mono lSet(ByteBuffer key, long index, ByteBuffer value) { * * @param commands * @return - * @see Redis Documentation: LSET + * @see Redis Documentation: LSET */ Flux> lSet(Publisher commands); @@ -615,7 +615,7 @@ default Mono lSet(ByteBuffer key, long index, ByteBuffer value) { * {@code LREM} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: LREM + * @see Redis Documentation: LREM */ class LRemCommand extends KeyCommand { @@ -707,7 +707,7 @@ public ByteBuffer getValue() { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: LREM + * @see Redis Documentation: LREM */ default Mono lRem(ByteBuffer key, ByteBuffer value) { @@ -724,7 +724,7 @@ default Mono lRem(ByteBuffer key, ByteBuffer value) { * @param count must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: LREM + * @see Redis Documentation: LREM */ default Mono lRem(ByteBuffer key, Long count, ByteBuffer value) { @@ -742,7 +742,7 @@ default Mono lRem(ByteBuffer key, Long count, ByteBuffer value) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: LREM + * @see Redis Documentation: LREM */ Flux> lRem(Publisher commands); @@ -750,8 +750,8 @@ default Mono lRem(ByteBuffer key, Long count, ByteBuffer value) { * {@code LPOP}/{@literal RPOP} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: LPOP - * @see Redis Documentation: RPOP + * @see Redis Documentation: LPOP + * @see Redis Documentation: RPOP */ class PopCommand extends KeyCommand { @@ -808,7 +808,7 @@ public Direction getDirection() { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: LPOP + * @see Redis Documentation: LPOP */ default Mono lPop(ByteBuffer key) { @@ -822,7 +822,7 @@ default Mono lPop(ByteBuffer key) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: RPOP + * @see Redis Documentation: RPOP */ default Mono rPop(ByteBuffer key) { @@ -836,15 +836,15 @@ default Mono rPop(ByteBuffer key) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: LPOP - * @see Redis Documentation: RPOP + * @see Redis Documentation: LPOP + * @see Redis Documentation: RPOP */ Flux> pop(Publisher commands); /** * @author Christoph Strobl - * @see Redis Documentation: BLPOP - * @see Redis Documentation: BRPOP + * @see Redis Documentation: BLPOP + * @see Redis Documentation: BRPOP */ class BPopCommand implements Command { @@ -977,7 +977,7 @@ public PopResponse(BPopCommand input, PopResult output) { * @param keys must not be {@literal null}. * @param timeout must not be {@literal null}. * @return - * @see Redis Documentation: BLPOP + * @see Redis Documentation: BLPOP */ default Mono blPop(List keys, Duration timeout) { @@ -994,7 +994,7 @@ default Mono blPop(List keys, Duration timeout) { * @param keys must not be {@literal null}. * @param timeout must not be {@literal null}. * @return - * @see Redis Documentation: BRPOP + * @see Redis Documentation: BRPOP */ default Mono brPop(List keys, Duration timeout) { @@ -1011,8 +1011,8 @@ default Mono brPop(List keys, Duration timeout) { * * @param commands * @return - * @see Redis Documentation: BLPOP - * @see Redis Documentation: BRPOP + * @see Redis Documentation: BLPOP + * @see Redis Documentation: BRPOP */ Flux bPop(Publisher commands); @@ -1020,7 +1020,7 @@ default Mono brPop(List keys, Duration timeout) { * {@code RPOPLPUSH} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: RPOPLPUSH + * @see Redis Documentation: RPOPLPUSH */ class RPopLPushCommand extends KeyCommand { @@ -1074,7 +1074,7 @@ public ByteBuffer getDestination() { * @param source must not be {@literal null}. * @param destination must not be {@literal null}. * @return - * @see Redis Documentation: RPOPLPUSH + * @see Redis Documentation: RPOPLPUSH */ default Mono rPopLPush(ByteBuffer source, ByteBuffer destination) { @@ -1092,7 +1092,7 @@ default Mono rPopLPush(ByteBuffer source, ByteBuffer destination) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: RPOPLPUSH + * @see Redis Documentation: RPOPLPUSH */ Flux> rPopLPush(Publisher commands); @@ -1100,7 +1100,7 @@ default Mono rPopLPush(ByteBuffer source, ByteBuffer destination) { * {@code BRPOPLPUSH} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: BRPOPLPUSH + * @see Redis Documentation: BRPOPLPUSH */ class BRPopLPushCommand extends KeyCommand { @@ -1178,7 +1178,7 @@ public Duration getTimeout() { * @param source must not be {@literal null}. * @param destination must not be {@literal null}. * @return - * @see Redis Documentation: BRPOPLPUSH + * @see Redis Documentation: BRPOPLPUSH */ default Mono bRPopLPush(ByteBuffer source, ByteBuffer destination, Duration timeout) { @@ -1196,7 +1196,7 @@ default Mono bRPopLPush(ByteBuffer source, ByteBuffer destination, D * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: BRPOPLPUSH + * @see Redis Documentation: BRPOPLPUSH */ Flux> bRPopLPush(Publisher commands); } diff --git a/src/main/java/org/springframework/data/redis/connection/ReactiveNumberCommands.java b/src/main/java/org/springframework/data/redis/connection/ReactiveNumberCommands.java index 445c63dadd..75fe3f4ba0 100644 --- a/src/main/java/org/springframework/data/redis/connection/ReactiveNumberCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/ReactiveNumberCommands.java @@ -40,7 +40,7 @@ public interface ReactiveNumberCommands { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: INCR + * @see Redis Documentation: INCR */ default Mono incr(ByteBuffer key) { @@ -54,7 +54,7 @@ default Mono incr(ByteBuffer key) { * * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: INCR + * @see Redis Documentation: INCR */ Flux> incr(Publisher keys); @@ -62,7 +62,7 @@ default Mono incr(ByteBuffer key) { * {@code INCRBY} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: INCRBY + * @see Redis Documentation: INCRBY */ class IncrByCommand extends KeyCommand { @@ -116,8 +116,8 @@ public T getValue() { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: INCRBY - * @see Redis Documentation: INCRBYFLOAT + * @see Redis Documentation: INCRBY + * @see Redis Documentation: INCRBYFLOAT */ default Mono incrBy(ByteBuffer key, T value) { @@ -132,8 +132,8 @@ default Mono incrBy(ByteBuffer key, T value) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: INCRBY - * @see Redis Documentation: INCRBYFLOAT + * @see Redis Documentation: INCRBY + * @see Redis Documentation: INCRBYFLOAT */ Flux, T>> incrBy( Publisher> commands); @@ -142,7 +142,7 @@ Flux, * {@code DECRBY} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: DECRBY + * @see Redis Documentation: DECRBY */ class DecrByCommand extends KeyCommand { @@ -194,7 +194,7 @@ public T getValue() { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: DECR + * @see Redis Documentation: DECR */ default Mono decr(ByteBuffer key) { @@ -208,7 +208,7 @@ default Mono decr(ByteBuffer key) { * * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: DECR + * @see Redis Documentation: DECR */ Flux> decr(Publisher keys); @@ -218,7 +218,7 @@ default Mono decr(ByteBuffer key) { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: DECRBY + * @see Redis Documentation: DECRBY */ default Mono decrBy(ByteBuffer key, T value) { @@ -240,7 +240,7 @@ default Mono decrBy(ByteBuffer key, T value) { * {@code HINCRBY} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: HINCRBY + * @see Redis Documentation: HINCRBY */ class HIncrByCommand extends KeyCommand { @@ -318,7 +318,7 @@ public ByteBuffer getField() { * @param field must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: HINCRBY + * @see Redis Documentation: HINCRBY */ default Mono hIncrBy(ByteBuffer key, ByteBuffer field, T value) { @@ -334,7 +334,7 @@ default Mono hIncrBy(ByteBuffer key, ByteBuffer field, T v * Increment {@literal value} of a hash {@literal field} by the given {@literal value}. * * @return - * @see Redis Documentation: HINCRBY + * @see Redis Documentation: HINCRBY */ Flux, T>> hIncrBy(Publisher> commands); diff --git a/src/main/java/org/springframework/data/redis/connection/ReactivePubSubCommands.java b/src/main/java/org/springframework/data/redis/connection/ReactivePubSubCommands.java index 807959bb0f..d97f2bd57e 100644 --- a/src/main/java/org/springframework/data/redis/connection/ReactivePubSubCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/ReactivePubSubCommands.java @@ -45,7 +45,7 @@ public interface ReactivePubSubCommands { * @param channel the channel to publish to. Must not be {@literal null}. * @param message message to publish. Must not be {@literal null}. * @return the number of clients that received the message. - * @see Redis Documentation: PUBLISH + * @see Redis Documentation: PUBLISH */ default Mono publish(ByteBuffer channel, ByteBuffer message) { return publish(Mono.just(new ChannelMessage<>(channel, message))).next(); @@ -56,7 +56,7 @@ default Mono publish(ByteBuffer channel, ByteBuffer message) { * * @param messageStream the messages to publish to. Must not be {@literal null}. * @return the number of clients that received the message. - * @see Redis Documentation: PUBLISH + * @see Redis Documentation: PUBLISH */ Flux publish(Publisher> messageStream); @@ -68,7 +68,7 @@ default Mono publish(ByteBuffer channel, ByteBuffer message) { * Note that cancellation of the {@link Flux} will unsubscribe from {@code channels}. * * @param channels channel names, must not be {@literal null}. - * @see Redis Documentation: SUBSCRIBE + * @see Redis Documentation: SUBSCRIBE */ Mono subscribe(ByteBuffer... channels); @@ -80,7 +80,7 @@ default Mono publish(ByteBuffer channel, ByteBuffer message) { * Note that cancellation of the {@link Flux} will unsubscribe from {@code patterns}. * * @param patterns channel name patterns, must not be {@literal null}. - * @see Redis Documentation: PSUBSCRIBE + * @see Redis Documentation: PSUBSCRIBE */ Mono pSubscribe(ByteBuffer... patterns); diff --git a/src/main/java/org/springframework/data/redis/connection/ReactiveRedisConnection.java b/src/main/java/org/springframework/data/redis/connection/ReactiveRedisConnection.java index 648b67eea1..4c695958ef 100644 --- a/src/main/java/org/springframework/data/redis/connection/ReactiveRedisConnection.java +++ b/src/main/java/org/springframework/data/redis/connection/ReactiveRedisConnection.java @@ -164,7 +164,7 @@ default void close() { * Test connection. * * @return {@link Mono} wrapping server response message - usually {@literal PONG}. - * @see Redis Documentation: PING + * @see Redis Documentation: PING */ Mono ping(); diff --git a/src/main/java/org/springframework/data/redis/connection/ReactiveScriptingCommands.java b/src/main/java/org/springframework/data/redis/connection/ReactiveScriptingCommands.java index 6a7f952ba0..65af264bff 100644 --- a/src/main/java/org/springframework/data/redis/connection/ReactiveScriptingCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/ReactiveScriptingCommands.java @@ -36,14 +36,14 @@ public interface ReactiveScriptingCommands { /** * Flush lua script cache. * - * @see Redis Documentation: SCRIPT FLUSH + * @see Redis Documentation: SCRIPT FLUSH */ Mono scriptFlush(); /** * Kill current lua script execution. * - * @see Redis Documentation: SCRIPT KILL + * @see Redis Documentation: SCRIPT KILL */ Mono scriptKill(); @@ -53,7 +53,7 @@ public interface ReactiveScriptingCommands { * * @param script must not be {@literal null}. * @return never {@literal null}. - * @see Redis Documentation: SCRIPT LOAD + * @see Redis Documentation: SCRIPT LOAD */ Mono scriptLoad(ByteBuffer script); @@ -74,7 +74,7 @@ default Mono scriptExists(String scriptSha) { * * @param scriptShas must not be {@literal null}. * @return {@link Flux} emitting one entry per scriptSha in given {@link List}. - * @see Redis Documentation: SCRIPT EXISTS + * @see Redis Documentation: SCRIPT EXISTS */ Flux scriptExists(List scriptShas); @@ -87,7 +87,7 @@ default Mono scriptExists(String scriptSha) { * @param numKeys * @param keysAndArgs must not be {@literal null}. * @return never {@literal null}. - * @see Redis Documentation: EVAL + * @see Redis Documentation: EVAL */ Flux eval(ByteBuffer script, ReturnType returnType, int numKeys, ByteBuffer... keysAndArgs); @@ -100,7 +100,7 @@ default Mono scriptExists(String scriptSha) { * @param numKeys * @param keysAndArgs must not be {@literal null}. * @return never {@literal null}. - * @see Redis Documentation: EVALSHA + * @see Redis Documentation: EVALSHA */ Flux evalSha(String scriptSha, ReturnType returnType, int numKeys, ByteBuffer... keysAndArgs); } diff --git a/src/main/java/org/springframework/data/redis/connection/ReactiveServerCommands.java b/src/main/java/org/springframework/data/redis/connection/ReactiveServerCommands.java index 8d6a13f7e4..efac0abbfe 100644 --- a/src/main/java/org/springframework/data/redis/connection/ReactiveServerCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/ReactiveServerCommands.java @@ -35,7 +35,7 @@ public interface ReactiveServerCommands { * Start an {@literal Append Only File} rewrite process on server. * * @return {@link Mono} indicating command completion. - * @see Redis Documentation: BGREWRITEAOF + * @see Redis Documentation: BGREWRITEAOF */ Mono bgReWriteAof(); @@ -44,7 +44,7 @@ public interface ReactiveServerCommands { * * @return {@link Mono} indicating command received by server. Operation success needs to be checked via * {@link #lastSave()}. - * @see Redis Documentation: BGSAVE + * @see Redis Documentation: BGSAVE */ Mono bgSave(); @@ -52,7 +52,7 @@ public interface ReactiveServerCommands { * Get time unix timestamp of last successful {@link #bgSave()} operation in seconds. * * @return {@link Mono} wrapping unix timestamp. - * @see Redis Documentation: LASTSAVE + * @see Redis Documentation: LASTSAVE */ Mono lastSave(); @@ -60,7 +60,7 @@ public interface ReactiveServerCommands { * Synchronous save current db snapshot on server. * * @return {@link Mono} indicating command completion. - * @see Redis Documentation: SAVE + * @see Redis Documentation: SAVE */ Mono save(); @@ -68,7 +68,7 @@ public interface ReactiveServerCommands { * Get the total number of available keys in currently selected database. * * @return {@link Mono} wrapping number of keys. - * @see Redis Documentation: DBSIZE + * @see Redis Documentation: DBSIZE */ Mono dbSize(); @@ -76,7 +76,7 @@ public interface ReactiveServerCommands { * Delete all keys of the currently selected database. * * @return {@link Mono} indicating command completion. - * @see Redis Documentation: FLUSHDB + * @see Redis Documentation: FLUSHDB */ Mono flushDb(); @@ -84,7 +84,7 @@ public interface ReactiveServerCommands { * Delete all all keys from all databases. * * @return {@link Mono} indicating command completion. - * @see Redis Documentation: FLUSHALL + * @see Redis Documentation: FLUSHALL */ Mono flushAll(); @@ -98,7 +98,7 @@ public interface ReactiveServerCommands { *

* * @return {@link Mono} wrapping server information. - * @see Redis Documentation: INFO + * @see Redis Documentation: INFO */ Mono info(); @@ -108,7 +108,7 @@ public interface ReactiveServerCommands { * @param section must not be {@literal null} nor {@literal empty}. * @return {@link Mono} wrapping server information of given {@code section}. * @throws IllegalArgumentException when section is {@literal null} or {@literal empty}. - * @see Redis Documentation: INFO + * @see Redis Documentation: INFO */ Mono info(String section); @@ -118,7 +118,7 @@ public interface ReactiveServerCommands { * @param pattern must not be {@literal null}. * @return {@link Mono} wrapping configuration parameters matching given {@code pattern}. * @throws IllegalArgumentException when {@code pattern} is {@literal null} or {@literal empty}. - * @see Redis Documentation: CONFIG GET + * @see Redis Documentation: CONFIG GET */ Mono getConfig(String pattern); @@ -128,7 +128,7 @@ public interface ReactiveServerCommands { * @param param must not be {@literal null} nor {@literal empty}. * @param value must not be {@literal null} nor {@literal empty}. * @throws IllegalArgumentException when {@code pattern} / {@code value} is {@literal null} or {@literal empty}. - * @see Redis Documentation: CONFIG SET + * @see Redis Documentation: CONFIG SET */ Mono setConfig(String param, String value); @@ -137,7 +137,7 @@ public interface ReactiveServerCommands { * Counters can be retrieved using {@link #info()}. * * @return {@link Mono} indicating command completion. - * @see Redis Documentation: CONFIG RESETSTAT + * @see Redis Documentation: CONFIG RESETSTAT */ Mono resetConfigStats(); @@ -145,7 +145,7 @@ public interface ReactiveServerCommands { * Request server timestamp using {@code TIME} command. * * @return {@link Mono} wrapping current server time in milliseconds. - * @see Redis Documentation: TIME + * @see Redis Documentation: TIME */ Mono time(); @@ -156,7 +156,7 @@ public interface ReactiveServerCommands { * @param port of connection to close * @return {@link Mono} wrapping {@link String} representation of the command result. * @throws IllegalArgumentException if {@code host} is {@literal null} or {@literal empty}. - * @see Redis Documentation: CLIENT KILL + * @see Redis Documentation: CLIENT KILL */ Mono killClient(String host, int port); @@ -165,7 +165,7 @@ public interface ReactiveServerCommands { * * @param name must not be {@literal null} nor {@literal empty}. * @throws IllegalArgumentException when {@code name} is {@literal null} or {@literal empty}. - * @see Redis Documentation: CLIENT SETNAME + * @see Redis Documentation: CLIENT SETNAME */ Mono setClientName(String name); @@ -173,7 +173,7 @@ public interface ReactiveServerCommands { * Returns the name of the current connection. * * @return {@link Mono} wrapping the connection name. - * @see Redis Documentation: CLIENT GETNAME + * @see Redis Documentation: CLIENT GETNAME */ Mono getClientName(); @@ -181,7 +181,7 @@ public interface ReactiveServerCommands { * Request information and statistics about connected clients. * * @return {@link Flux} emitting {@link RedisClientInfo} objects. - * @see Redis Documentation: CLIENT LIST + * @see Redis Documentation: CLIENT LIST */ Flux getClientList(); } diff --git a/src/main/java/org/springframework/data/redis/connection/ReactiveSetCommands.java b/src/main/java/org/springframework/data/redis/connection/ReactiveSetCommands.java index 1d6dc5e932..e81ae672d0 100644 --- a/src/main/java/org/springframework/data/redis/connection/ReactiveSetCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/ReactiveSetCommands.java @@ -50,7 +50,7 @@ public interface ReactiveSetCommands { * {@code SADD} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: SADD + * @see Redis Documentation: SADD */ class SAddCommand extends KeyCommand { @@ -116,7 +116,7 @@ public List getValues() { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: SADD + * @see Redis Documentation: SADD */ default Mono sAdd(ByteBuffer key, ByteBuffer value) { @@ -131,7 +131,7 @@ default Mono sAdd(ByteBuffer key, ByteBuffer value) { * @param key must not be {@literal null}. * @param values must not be {@literal null}. * @return - * @see Redis Documentation: SADD + * @see Redis Documentation: SADD */ default Mono sAdd(ByteBuffer key, Collection values) { @@ -146,7 +146,7 @@ default Mono sAdd(ByteBuffer key, Collection values) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: SADD + * @see Redis Documentation: SADD */ Flux> sAdd(Publisher commands); @@ -154,7 +154,7 @@ default Mono sAdd(ByteBuffer key, Collection values) { * {@code SREM} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: SREM + * @see Redis Documentation: SREM */ class SRemCommand extends KeyCommand { @@ -220,7 +220,7 @@ public List getValues() { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: SREM + * @see Redis Documentation: SREM */ default Mono sRem(ByteBuffer key, ByteBuffer value) { @@ -235,7 +235,7 @@ default Mono sRem(ByteBuffer key, ByteBuffer value) { * @param key must not be {@literal null}. * @param values must not be {@literal null}. * @return - * @see Redis Documentation: SREM + * @see Redis Documentation: SREM */ default Mono sRem(ByteBuffer key, Collection values) { @@ -250,7 +250,7 @@ default Mono sRem(ByteBuffer key, Collection values) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: SREM + * @see Redis Documentation: SREM */ Flux> sRem(Publisher commands); @@ -258,7 +258,7 @@ default Mono sRem(ByteBuffer key, Collection values) { * {@code SPOP} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: SPOP + * @see Redis Documentation: SPOP */ class SPopCommand extends KeyCommand { @@ -311,7 +311,7 @@ public long getCount() { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: SPOP + * @see Redis Documentation: SPOP */ default Mono sPop(ByteBuffer key) { @@ -326,7 +326,7 @@ default Mono sPop(ByteBuffer key) { * @param key must not be {@literal null}. * @param count number of random members to pop from the set. * @return - * @see Redis Documentation: SPOP + * @see Redis Documentation: SPOP */ default Flux sPop(ByteBuffer key, long count) { @@ -340,7 +340,7 @@ default Flux sPop(ByteBuffer key, long count) { * * @param command must not be {@literal null}. * @return - * @see Redis Documentation: SPOP + * @see Redis Documentation: SPOP */ Flux sPop(SPopCommand command); @@ -349,7 +349,7 @@ default Flux sPop(ByteBuffer key, long count) { * * @param commands * @return - * @see Redis Documentation: SPOP + * @see Redis Documentation: SPOP */ Flux> sPop(Publisher commands); @@ -357,7 +357,7 @@ default Flux sPop(ByteBuffer key, long count) { * {@code SMOVE} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: SMOVE + * @see Redis Documentation: SMOVE */ class SMoveCommand extends KeyCommand { @@ -434,7 +434,7 @@ public ByteBuffer getValue() { * @param destinationKey must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: SMOVE + * @see Redis Documentation: SMOVE */ default Mono sMove(ByteBuffer sourceKey, ByteBuffer destinationKey, ByteBuffer value) { @@ -451,7 +451,7 @@ default Mono sMove(ByteBuffer sourceKey, ByteBuffer destinationKey, Byt * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: SMOVE + * @see Redis Documentation: SMOVE */ Flux> sMove(Publisher commands); @@ -460,7 +460,7 @@ default Mono sMove(ByteBuffer sourceKey, ByteBuffer destinationKey, Byt * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: SCARD + * @see Redis Documentation: SCARD */ default Mono sCard(ByteBuffer key) { @@ -474,7 +474,7 @@ default Mono sCard(ByteBuffer key) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: SCARD + * @see Redis Documentation: SCARD */ Flux> sCard(Publisher commands); @@ -482,7 +482,7 @@ default Mono sCard(ByteBuffer key) { * {@code SISMEMBER} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: SISMEMBER + * @see Redis Documentation: SISMEMBER */ class SIsMemberCommand extends KeyCommand { @@ -535,7 +535,7 @@ public ByteBuffer getValue() { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: SISMEMBER + * @see Redis Documentation: SISMEMBER */ default Mono sIsMember(ByteBuffer key, ByteBuffer value) { @@ -550,7 +550,7 @@ default Mono sIsMember(ByteBuffer key, ByteBuffer value) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: SISMEMBER + * @see Redis Documentation: SISMEMBER */ Flux> sIsMember(Publisher commands); @@ -558,7 +558,7 @@ default Mono sIsMember(ByteBuffer key, ByteBuffer value) { * {@code SINTER} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: SINTER + * @see Redis Documentation: SINTER */ class SInterCommand implements Command { @@ -604,7 +604,7 @@ public List getKeys() { * * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: SINTER + * @see Redis Documentation: SINTER */ default Flux sInter(Collection keys) { @@ -618,7 +618,7 @@ default Flux sInter(Collection keys) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: SINTER + * @see Redis Documentation: SINTER */ Flux>> sInter(Publisher commands); @@ -626,7 +626,7 @@ default Flux sInter(Collection keys) { * {@code SINTERSTORE} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: SINTERSTORE + * @see Redis Documentation: SINTERSTORE */ class SInterStoreCommand extends KeyCommand { @@ -680,7 +680,7 @@ public List getKeys() { * @param destinationKey must not be {@literal null}. * @param keys must not be {@literal null}. * @return size of set stored a {@literal destinationKey}. - * @see Redis Documentation: SINTERSTORE + * @see Redis Documentation: SINTERSTORE */ default Mono sInterStore(ByteBuffer destinationKey, Collection keys) { @@ -696,7 +696,7 @@ default Mono sInterStore(ByteBuffer destinationKey, Collection * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: SINTERSTORE + * @see Redis Documentation: SINTERSTORE */ Flux> sInterStore(Publisher commands); @@ -704,7 +704,7 @@ default Mono sInterStore(ByteBuffer destinationKey, Collection * {@code SUNION} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: SUNION + * @see Redis Documentation: SUNION */ class SUnionCommand implements Command { @@ -750,7 +750,7 @@ public List getKeys() { * * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: SUNION + * @see Redis Documentation: SUNION */ default Flux sUnion(Collection keys) { @@ -764,7 +764,7 @@ default Flux sUnion(Collection keys) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: SUNION + * @see Redis Documentation: SUNION */ Flux>> sUnion(Publisher commands); @@ -772,7 +772,7 @@ default Flux sUnion(Collection keys) { * {@code SUNIONSTORE} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: SUNIONSTORE + * @see Redis Documentation: SUNIONSTORE */ class SUnionStoreCommand extends KeyCommand { @@ -826,7 +826,7 @@ public List getKeys() { * @param destinationKey must not be {@literal null}. * @param keys must not be {@literal null}. * @return size of set stored a {@literal destinationKey}. - * @see Redis Documentation: SUNIONSTORE + * @see Redis Documentation: SUNIONSTORE */ default Mono sUnionStore(ByteBuffer destinationKey, Collection keys) { @@ -842,7 +842,7 @@ default Mono sUnionStore(ByteBuffer destinationKey, Collection * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: SUNIONSTORE + * @see Redis Documentation: SUNIONSTORE */ Flux> sUnionStore(Publisher commands); @@ -850,7 +850,7 @@ default Mono sUnionStore(ByteBuffer destinationKey, Collection * {@code SDIFF} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: SDIFF + * @see Redis Documentation: SDIFF */ class SDiffCommand implements Command { @@ -896,7 +896,7 @@ public List getKeys() { * * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: SDIFF + * @see Redis Documentation: SDIFF */ default Flux sDiff(Collection keys) { @@ -910,7 +910,7 @@ default Flux sDiff(Collection keys) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: SDIFF + * @see Redis Documentation: SDIFF */ Flux>> sDiff(Publisher commands); @@ -918,7 +918,7 @@ default Flux sDiff(Collection keys) { * {@code SDIFFSTORE} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: SDIFFSTORE + * @see Redis Documentation: SDIFFSTORE */ class SDiffStoreCommand extends KeyCommand { @@ -972,7 +972,7 @@ public List getKeys() { * @param destinationKey must not be {@literal null}. * @param keys must not be {@literal null}. * @return size of set stored a {@literal destinationKey}. - * @see Redis Documentation: SDIFFSTORE + * @see Redis Documentation: SDIFFSTORE */ default Mono sDiffStore(ByteBuffer destinationKey, Collection keys) { @@ -988,7 +988,7 @@ default Mono sDiffStore(ByteBuffer destinationKey, Collection * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: SDIFFSTORE + * @see Redis Documentation: SDIFFSTORE */ Flux> sDiffStore(Publisher commands); @@ -997,7 +997,7 @@ default Mono sDiffStore(ByteBuffer destinationKey, Collection * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: SMEMBERS + * @see Redis Documentation: SMEMBERS */ default Flux sMembers(ByteBuffer key) { @@ -1011,7 +1011,7 @@ default Flux sMembers(ByteBuffer key) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: SMEMBERS + * @see Redis Documentation: SMEMBERS */ Flux>> sMembers(Publisher commands); @@ -1022,7 +1022,7 @@ default Flux sMembers(ByteBuffer key) { * @param key must not be {@literal null}. * @return the {@link Flux} emitting the raw {@link ByteBuffer members} one by one. * @throws IllegalArgumentException when options is {@literal null}. - * @see Redis Documentation: SSCAN + * @see Redis Documentation: SSCAN * @since 2.1 */ default Flux sScan(ByteBuffer key) { @@ -1037,7 +1037,7 @@ default Flux sScan(ByteBuffer key) { * @param options must not be {@literal null}. Use {@link ScanOptions#NONE} instead. * @return the {@link Flux} emitting the raw {@link ByteBuffer members} one by one. * @throws IllegalArgumentException when one of the required arguments is {@literal null}. - * @see Redis Documentation: SSCAN + * @see Redis Documentation: SSCAN * @since 2.1 */ default Flux sScan(ByteBuffer key, ScanOptions options) { @@ -1052,7 +1052,7 @@ default Flux sScan(ByteBuffer key, ScanOptions options) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: SSCAN + * @see Redis Documentation: SSCAN * @since 2.1 */ Flux>> sScan(Publisher commands); @@ -1061,7 +1061,7 @@ default Flux sScan(ByteBuffer key, ScanOptions options) { * {@code SRANDMEMBER} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: SRANDMEMBER + * @see Redis Documentation: SRANDMEMBER */ class SRandMembersCommand extends KeyCommand { @@ -1118,7 +1118,7 @@ public Optional getCount() { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: SRANDMEMBER + * @see Redis Documentation: SRANDMEMBER */ default Mono sRandMember(ByteBuffer key) { return sRandMember(key, 1L).singleOrEmpty(); @@ -1130,7 +1130,7 @@ default Mono sRandMember(ByteBuffer key) { * @param key must not be {@literal null}. * @param count must not be {@literal null}. * @return - * @see Redis Documentation: SRANDMEMBER + * @see Redis Documentation: SRANDMEMBER */ default Flux sRandMember(ByteBuffer key, Long count) { @@ -1145,7 +1145,7 @@ default Flux sRandMember(ByteBuffer key, Long count) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: SRANDMEMBER + * @see Redis Documentation: SRANDMEMBER */ Flux>> sRandMember(Publisher commands); } diff --git a/src/main/java/org/springframework/data/redis/connection/ReactiveStreamCommands.java b/src/main/java/org/springframework/data/redis/connection/ReactiveStreamCommands.java index cd5f5eea1b..348d96d2c6 100644 --- a/src/main/java/org/springframework/data/redis/connection/ReactiveStreamCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/ReactiveStreamCommands.java @@ -53,7 +53,7 @@ public interface ReactiveStreamCommands { /** * {@code XACK} command parameters. * - * @see Redis Documentation: XACK + * @see Redis Documentation: XACK */ class AcknowledgeCommand extends KeyCommand { @@ -140,7 +140,7 @@ public List getRecordIds() { * @param group name of the consumer group. * @param recordIds record Id's to acknowledge. * @return {@link Mono} emitting the nr of acknowledged messages. - * @see Redis Documentation: XADD + * @see Redis Documentation: XADD */ default Mono xAck(ByteBuffer key, String group, String... recordIds) { @@ -158,7 +158,7 @@ default Mono xAck(ByteBuffer key, String group, String... recordIds) { * @param group name of the consumer group. * @param recordIds record Id's to acknowledge. * @return {@link Mono} emitting the nr of acknowledged messages. - * @see Redis Documentation: XADD + * @see Redis Documentation: XADD */ default Mono xAck(ByteBuffer key, String group, RecordId... recordIds) { @@ -174,14 +174,14 @@ default Mono xAck(ByteBuffer key, String group, RecordId... recordIds) { * * @param commands must not be {@literal null}. * @return {@link Flux} emitting the nr of acknowledged messages per {@link AcknowledgeCommand}. - * @see Redis Documentation: XACK + * @see Redis Documentation: XACK */ Flux> xAck(Publisher commands); /** * {@code XADD} command parameters. * - * @see Redis Documentation: XADD + * @see Redis Documentation: XADD */ class AddStreamRecord extends KeyCommand { @@ -247,7 +247,7 @@ public ByteBufferRecord getRecord() { * @param key must not be {@literal null}. * @param body must not be {@literal null}. * @return {@link Mono} emitting the server generated {@link RecordId id}. - * @see Redis Documentation: XADD + * @see Redis Documentation: XADD */ default Mono xAdd(ByteBuffer key, Map body) { @@ -262,7 +262,7 @@ default Mono xAdd(ByteBuffer key, Map body) { * * @param record must not be {@literal null}. * @return {@link Mono} the {@link RecordId id}. - * @see Redis Documentation: XADD + * @see Redis Documentation: XADD */ default Mono xAdd(ByteBufferRecord record) { @@ -276,14 +276,14 @@ default Mono xAdd(ByteBufferRecord record) { * * @param commands must not be {@literal null}. * @return {@link Flux} emitting the {@link RecordId} on by for for the given {@link AddStreamRecord} commands. - * @see Redis Documentation: XADD + * @see Redis Documentation: XADD */ Flux> xAdd(Publisher commands); /** * {@code XDEL} command parameters. * - * @see Redis Documentation: XDEL + * @see Redis Documentation: XDEL */ class DeleteCommand extends KeyCommand { @@ -350,7 +350,7 @@ public List getRecordIds() { * @param key the stream key. * @param recordIds stream record Id's. * @return {@link Mono} emitting the number of removed entries. - * @see Redis Documentation: XDEL + * @see Redis Documentation: XDEL */ default Mono xDel(ByteBuffer key, String... recordIds) { @@ -367,7 +367,7 @@ default Mono xDel(ByteBuffer key, String... recordIds) { * @param key the stream key. * @param recordIds stream record Id's. * @return {@link Mono} emitting the number of removed entries. - * @see Redis Documentation: XDEL + * @see Redis Documentation: XDEL */ default Mono xDel(ByteBuffer key, RecordId... recordIds) { @@ -383,7 +383,7 @@ default Mono xDel(ByteBuffer key, RecordId... recordIds) { * * @param commands must not be {@literal null}. * @return {@link Mono} emitting the number of removed entries. - * @see Redis Documentation: XDEL + * @see Redis Documentation: XDEL */ Flux> xDel(Publisher commands); @@ -392,7 +392,7 @@ default Mono xDel(ByteBuffer key, RecordId... recordIds) { * * @param key must not be {@literal null}. * @return {@link Mono} emitting the length of the stream. - * @see Redis Documentation: XLEN + * @see Redis Documentation: XLEN */ default Mono xLen(ByteBuffer key) { @@ -406,15 +406,15 @@ default Mono xLen(ByteBuffer key) { * * @param commands must not be {@literal null}. * @return {@link Flux} emitting the length of the stream per {@link KeyCommand}. - * @see Redis Documentation: XLEN + * @see Redis Documentation: XLEN */ Flux> xLen(Publisher commands); /** * {@code XRANGE}/{@code XREVRANGE} command parameters. * - * @see Redis Documentation: XRANGE - * @see Redis Documentation: XREVRANGE + * @see Redis Documentation: XRANGE + * @see Redis Documentation: XREVRANGE */ class RangeCommand extends KeyCommand { @@ -502,7 +502,7 @@ public Limit getLimit() { * @param key the stream key. * @param range must not be {@literal null}. * @return {@link Flux} emitting with members of the stream. - * @see Redis Documentation: XRANGE + * @see Redis Documentation: XRANGE */ default Flux xRange(ByteBuffer key, Range range) { return xRange(key, range, Limit.unlimited()); @@ -515,7 +515,7 @@ default Flux xRange(ByteBuffer key, Range range) { * @param range must not be {@literal null}. * @param limit must not be {@literal null}. * @return {@link Flux} emitting with members of the stream. - * @see Redis Documentation: XRANGE + * @see Redis Documentation: XRANGE */ default Flux xRange(ByteBuffer key, Range range, Limit limit) { @@ -532,15 +532,15 @@ default Flux xRange(ByteBuffer key, Range range, Limit * * @param commands must not be {@literal null}. * @return {@link Flux} emitting with members of the stream per {@link RangeCommand}. - * @see Redis Documentation: XRANGE + * @see Redis Documentation: XRANGE */ Flux>> xRange(Publisher commands); /** * {@code XRANGE}/{@code XREVRANGE} command parameters. * - * @see Redis Documentation: XRANGE - * @see Redis Documentation: XREVRANGE + * @see Redis Documentation: XRANGE + * @see Redis Documentation: XREVRANGE */ class ReadCommand { @@ -634,7 +634,7 @@ public Consumer getConsumer() { * * @param streams the streams to read from. * @return {@link Flux} emitting with members of the stream. - * @see Redis Documentation: XREAD + * @see Redis Documentation: XREAD */ default Flux xRead(StreamOffset... streams) { return xRead(StreamReadOptions.empty(), streams); @@ -646,7 +646,7 @@ default Flux xRead(StreamOffset... streams) { * @param readOptions read arguments. * @param streams the streams to read from. * @return {@link Flux} emitting with members of the stream. - * @see Redis Documentation: XREAD + * @see Redis Documentation: XREAD */ default Flux xRead(StreamReadOptions readOptions, StreamOffset... streams) { @@ -662,8 +662,8 @@ default Flux xRead(StreamReadOptions readOptions, StreamOffset * * @param commands must not be {@literal null}. * @return {@link Flux} emitting the members of the stream per {@link ReadCommand}. - * @see Redis Documentation: XREAD - * @see Redis Documentation: XREADGROUP + * @see Redis Documentation: XREAD + * @see Redis Documentation: XREADGROUP */ Flux>> read(Publisher commands); @@ -810,7 +810,7 @@ default Mono xGroup(GroupCommand command) { * @param consumer consumer/group. * @param streams the streams to read from. * @return {@link Flux} emitting the members of the stream - * @see Redis Documentation: XREADGROUP + * @see Redis Documentation: XREADGROUP */ default Flux xReadGroup(Consumer consumer, StreamOffset... streams) { return xReadGroup(consumer, StreamReadOptions.empty(), streams); @@ -823,7 +823,7 @@ default Flux xReadGroup(Consumer consumer, StreamOffsetRedis Documentation: XREADGROUP + * @see Redis Documentation: XREADGROUP */ default Flux xReadGroup(Consumer consumer, StreamReadOptions readOptions, StreamOffset... streams) { @@ -842,7 +842,7 @@ default Flux xReadGroup(Consumer consumer, StreamReadOptions r * @param key the stream key. * @param range must not be {@literal null}. * @return {@link Flux} emitting the members of the stream in reverse. - * @see Redis Documentation: XREVRANGE + * @see Redis Documentation: XREVRANGE */ default Flux xRevRange(ByteBuffer key, Range range) { return xRevRange(key, range, Limit.unlimited()); @@ -855,7 +855,7 @@ default Flux xRevRange(ByteBuffer key, Range range) { * @param range must not be {@literal null}. * @param limit must not be {@literal null}. * @return {@link Flux} emitting the members of the stream in reverse. - * @see Redis Documentation: XREVRANGE + * @see Redis Documentation: XREVRANGE */ default Flux xRevRange(ByteBuffer key, Range range, Limit limit) { @@ -872,14 +872,14 @@ default Flux xRevRange(ByteBuffer key, Range range, Li * * @param commands must not be {@literal null}. * @return {@link Flux} emitting the members of the stream in reverse. - * @see Redis Documentation: XREVRANGE + * @see Redis Documentation: XREVRANGE */ Flux>> xRevRange(Publisher commands); /** * {@code XTRIM} command parameters. * - * @see Redis Documentation: XTRIM + * @see Redis Documentation: XTRIM */ class TrimCommand extends KeyCommand { @@ -930,7 +930,7 @@ public Long getCount() { * @param key the stream key. * @param count length of the stream. * @return {@link Mono} emitting the number of removed entries. - * @see Redis Documentation: XTRIM + * @see Redis Documentation: XTRIM */ default Mono xTrim(ByteBuffer key, long count) { @@ -944,7 +944,7 @@ default Mono xTrim(ByteBuffer key, long count) { * * @param commands must not be {@literal null}. * @return {@link Flux} emitting the number of removed entries per {@link TrimCommand}. - * @see Redis Documentation: XTRIM + * @see Redis Documentation: XTRIM */ Flux> xTrim(Publisher commands); } diff --git a/src/main/java/org/springframework/data/redis/connection/ReactiveStringCommands.java b/src/main/java/org/springframework/data/redis/connection/ReactiveStringCommands.java index 9f7a21c33b..48fb1158dc 100644 --- a/src/main/java/org/springframework/data/redis/connection/ReactiveStringCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/ReactiveStringCommands.java @@ -55,7 +55,7 @@ public interface ReactiveStringCommands { * {@code SET} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: SET + * @see Redis Documentation: SET */ class SetCommand extends KeyCommand { @@ -154,7 +154,7 @@ public Optional getOption() { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: SET + * @see Redis Documentation: SET */ default Mono set(ByteBuffer key, ByteBuffer value) { @@ -172,7 +172,7 @@ default Mono set(ByteBuffer key, ByteBuffer value) { * @param expiration must not be {@literal null}. * @param option must not be {@literal null}. * @return - * @see Redis Documentation: SET + * @see Redis Documentation: SET */ default Mono set(ByteBuffer key, ByteBuffer value, Expiration expiration, SetOption option) { @@ -188,7 +188,7 @@ default Mono set(ByteBuffer key, ByteBuffer value, Expiration expiratio * * @param commands must not be {@literal null}. * @return {@link Flux} of {@link BooleanResponse} holding the {@link SetCommand} along with the command result. - * @see Redis Documentation: SET + * @see Redis Documentation: SET */ Flux> set(Publisher commands); @@ -197,7 +197,7 @@ default Mono set(ByteBuffer key, ByteBuffer value, Expiration expiratio * * @param key must not be {@literal null}. * @return {@link Mono#empty()} in case {@literal key} does not exist. - * @see Redis Documentation: GET + * @see Redis Documentation: GET */ default Mono get(ByteBuffer key) { @@ -213,7 +213,7 @@ default Mono get(ByteBuffer key) { * @param keys must not be {@literal null}. * @return {@link Flux} of {@link ByteBufferResponse} holding the {@literal key} to get along with the value * retrieved. - * @see Redis Documentation: GET + * @see Redis Documentation: GET */ Flux> get(Publisher keys); @@ -223,7 +223,7 @@ default Mono get(ByteBuffer key) { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return {@link Mono#empty()} if key did not exist. - * @see Redis Documentation: GETSET + * @see Redis Documentation: GETSET */ default Mono getSet(ByteBuffer key, ByteBuffer value) { @@ -240,7 +240,7 @@ default Mono getSet(ByteBuffer key, ByteBuffer value) { * @param commands must not be {@literal null}. * @return {@link Flux} of {@link ByteBufferResponse} holding the {@link SetCommand} along with the previously * existing value. - * @see Redis Documentation: GETSET + * @see Redis Documentation: GETSET */ Flux> getSet(Publisher commands); @@ -249,7 +249,7 @@ default Mono getSet(ByteBuffer key, ByteBuffer value) { * * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: MGET + * @see Redis Documentation: MGET */ default Mono> mGet(List keys) { @@ -263,7 +263,7 @@ default Mono> mGet(List keys) { * * @param keysets must not be {@literal null}. * @return - * @see Redis Documentation: MGET + * @see Redis Documentation: MGET */ Flux, ByteBuffer>> mGet(Publisher> keysets); @@ -273,7 +273,7 @@ default Mono> mGet(List keys) { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: SETNX + * @see Redis Documentation: SETNX */ default Mono setNX(ByteBuffer key, ByteBuffer value) { @@ -288,7 +288,7 @@ default Mono setNX(ByteBuffer key, ByteBuffer value) { * * @param values must not be {@literal null}. * @return - * @see Redis Documentation: SETNX + * @see Redis Documentation: SETNX */ Flux> setNX(Publisher values); @@ -299,7 +299,7 @@ default Mono setNX(ByteBuffer key, ByteBuffer value) { * @param value must not be {@literal null}. * @param expireTimeout must not be {@literal null}. * @return - * @see Redis Documentation: SETEX + * @see Redis Documentation: SETEX */ default Mono setEX(ByteBuffer key, ByteBuffer value, Expiration expireTimeout) { @@ -316,7 +316,7 @@ default Mono setEX(ByteBuffer key, ByteBuffer value, Expiration expireT * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: SETEX + * @see Redis Documentation: SETEX */ Flux> setEX(Publisher commands); @@ -327,7 +327,7 @@ default Mono setEX(ByteBuffer key, ByteBuffer value, Expiration expireT * @param value must not be {@literal null}. * @param expireTimeout must not be {@literal null}. * @return - * @see Redis Documentation: PSETEX + * @see Redis Documentation: PSETEX */ default Mono pSetEX(ByteBuffer key, ByteBuffer value, Expiration expireTimeout) { @@ -344,7 +344,7 @@ default Mono pSetEX(ByteBuffer key, ByteBuffer value, Expiration expire * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: PSETEX + * @see Redis Documentation: PSETEX */ Flux> pSetEX(Publisher commands); @@ -352,7 +352,7 @@ default Mono pSetEX(ByteBuffer key, ByteBuffer value, Expiration expire * {@code MSET} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: MSET + * @see Redis Documentation: MSET */ class MSetCommand implements Command { @@ -398,7 +398,7 @@ public Map getKeyValuePairs() { * * @param keyValuePairs must not be {@literal null}. * @return - * @see Redis Documentation: MSET + * @see Redis Documentation: MSET */ default Mono mSet(Map keyValuePairs) { @@ -412,7 +412,7 @@ default Mono mSet(Map keyValuePairs) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: MSET + * @see Redis Documentation: MSET */ Flux> mSet(Publisher commands); @@ -422,7 +422,7 @@ default Mono mSet(Map keyValuePairs) { * * @param keyValuePairs must not be {@literal null}. * @return - * @see Redis Documentation: MSETNX + * @see Redis Documentation: MSETNX */ default Mono mSetNX(Map keyValuePairs) { @@ -437,7 +437,7 @@ default Mono mSetNX(Map keyValuePairs) { * * @param source must not be {@literal null}. * @return - * @see Redis Documentation: MSETNX + * @see Redis Documentation: MSETNX */ Flux> mSetNX(Publisher source); @@ -445,7 +445,7 @@ default Mono mSetNX(Map keyValuePairs) { * {@code APPEND} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: APPEND + * @see Redis Documentation: APPEND */ class AppendCommand extends KeyCommand { @@ -499,7 +499,7 @@ public ByteBuffer getValue() { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: APPEND + * @see Redis Documentation: APPEND */ default Mono append(ByteBuffer key, ByteBuffer value) { @@ -514,7 +514,7 @@ default Mono append(ByteBuffer key, ByteBuffer value) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: APPEND + * @see Redis Documentation: APPEND */ Flux> append(Publisher commands); @@ -525,7 +525,7 @@ default Mono append(ByteBuffer key, ByteBuffer value) { * @param start * @param end * @return - * @see Redis Documentation: GETRANGE + * @see Redis Documentation: GETRANGE */ default Mono getRange(ByteBuffer key, long start, long end) { @@ -541,7 +541,7 @@ default Mono getRange(ByteBuffer key, long start, long end) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: GETRANGE + * @see Redis Documentation: GETRANGE */ Flux> getRange(Publisher commands); @@ -549,7 +549,7 @@ default Mono getRange(ByteBuffer key, long start, long end) { * {@code SETRANGE} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: SETRANGE + * @see Redis Documentation: SETRANGE */ class SetRangeCommand extends KeyCommand { @@ -623,7 +623,7 @@ public Long getOffset() { * @param value must not be {@literal null}. * @param offset * @return - * @see Redis Documentation: SETRANGE + * @see Redis Documentation: SETRANGE */ default Mono setRange(ByteBuffer key, ByteBuffer value, long offset) { @@ -640,7 +640,7 @@ default Mono setRange(ByteBuffer key, ByteBuffer value, long offset) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: SETRANGE + * @see Redis Documentation: SETRANGE */ Flux> setRange(Publisher commands); @@ -648,7 +648,7 @@ default Mono setRange(ByteBuffer key, ByteBuffer value, long offset) { * {@code GETBIT} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: GETBIT + * @see Redis Documentation: GETBIT */ class GetBitCommand extends KeyCommand { @@ -699,7 +699,7 @@ public Long getOffset() { * @param key must not be {@literal null}. * @param offset * @return - * @see Redis Documentation: GETBIT + * @see Redis Documentation: GETBIT */ default Mono getBit(ByteBuffer key, long offset) { @@ -713,7 +713,7 @@ default Mono getBit(ByteBuffer key, long offset) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: GETBIT + * @see Redis Documentation: GETBIT */ Flux> getBit(Publisher commands); @@ -721,7 +721,7 @@ default Mono getBit(ByteBuffer key, long offset) { * {@code SETBIT} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: SETBIT + * @see Redis Documentation: SETBIT */ class SetBitCommand extends KeyCommand { @@ -805,7 +805,7 @@ default Mono setBit(ByteBuffer key, long offset, boolean value) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: SETBIT + * @see Redis Documentation: SETBIT */ Flux> setBit(Publisher commands); @@ -813,7 +813,7 @@ default Mono setBit(ByteBuffer key, long offset, boolean value) { * {@code BITCOUNT} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: BITCOUNT + * @see Redis Documentation: BITCOUNT */ class BitCountCommand extends KeyCommand { @@ -865,7 +865,7 @@ public Range getRange() { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: BITCOUNT + * @see Redis Documentation: BITCOUNT */ default Mono bitCount(ByteBuffer key) { @@ -882,7 +882,7 @@ default Mono bitCount(ByteBuffer key) { * @param start * @param end * @return - * @see Redis Documentation: BITCOUNT + * @see Redis Documentation: BITCOUNT */ default Mono bitCount(ByteBuffer key, long start, long end) { @@ -899,7 +899,7 @@ default Mono bitCount(ByteBuffer key, long start, long end) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: BITCOUNT + * @see Redis Documentation: BITCOUNT */ Flux> bitCount(Publisher commands); @@ -907,7 +907,7 @@ default Mono bitCount(ByteBuffer key, long start, long end) { * {@code BITFIELD} command parameters. * * @author Mark Paluch - * @see Redis Documentation: BITFIELD + * @see Redis Documentation: BITFIELD * @since 2.1 */ class BitFieldCommand extends KeyCommand { @@ -960,7 +960,7 @@ public BitFieldSubCommands getSubCommands() { * @param key must not be {@literal null}. * @param subCommands * @return - * @see Redis Documentation: BITFIELD + * @see Redis Documentation: BITFIELD * @since 2.1 */ default Mono> bitField(ByteBuffer key, BitFieldSubCommands subCommands) { @@ -978,7 +978,7 @@ default Mono> bitField(ByteBuffer key, BitFieldSubCommands subCommand * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: BITFIELD + * @see Redis Documentation: BITFIELD * @since 2.1 */ Flux> bitField(Publisher commands); @@ -987,7 +987,7 @@ default Mono> bitField(ByteBuffer key, BitFieldSubCommands subCommand * {@code BITOP} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: BITOP + * @see Redis Documentation: BITOP */ class BitOpCommand { @@ -1073,7 +1073,7 @@ public ByteBuffer getDestinationKey() { * @param bitOp must not be {@literal null}. * @param destination must not be {@literal null}. * @return - * @see Redis Documentation: BITOP + * @see Redis Documentation: BITOP */ default Mono bitOp(Collection keys, BitOperation bitOp, ByteBuffer destination) { @@ -1091,7 +1091,7 @@ default Mono bitOp(Collection keys, BitOperation bitOp, ByteBu * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: BITOP + * @see Redis Documentation: BITOP */ Flux> bitOp(Publisher commands); @@ -1174,7 +1174,7 @@ default Mono bitPos(ByteBuffer key, boolean bit, Range range) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: STRLEN + * @see Redis Documentation: STRLEN */ default Mono strLen(ByteBuffer key) { @@ -1188,7 +1188,7 @@ default Mono strLen(ByteBuffer key) { * * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: STRLEN + * @see Redis Documentation: STRLEN */ Flux> strLen(Publisher keys); } diff --git a/src/main/java/org/springframework/data/redis/connection/ReactiveZSetCommands.java b/src/main/java/org/springframework/data/redis/connection/ReactiveZSetCommands.java index 187fb6f1b7..e6c563cb6b 100644 --- a/src/main/java/org/springframework/data/redis/connection/ReactiveZSetCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/ReactiveZSetCommands.java @@ -54,7 +54,7 @@ public interface ReactiveZSetCommands { * {@code ZADD} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: ZADD + * @see Redis Documentation: ZADD */ class ZAddCommand extends KeyCommand { @@ -189,7 +189,7 @@ public boolean isReturnTotalChanged() { * @param score must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: ZADD + * @see Redis Documentation: ZADD */ default Mono zAdd(ByteBuffer key, Double score, ByteBuffer value) { @@ -207,7 +207,7 @@ default Mono zAdd(ByteBuffer key, Double score, ByteBuffer value) { * @param key must not be {@literal null}. * @param tuples must not be {@literal null}. * @return - * @see Redis Documentation: ZADD + * @see Redis Documentation: ZADD */ default Mono zAdd(ByteBuffer key, Collection tuples) { @@ -223,7 +223,7 @@ default Mono zAdd(ByteBuffer key, Collection tuples) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: ZADD + * @see Redis Documentation: ZADD */ Flux> zAdd(Publisher commands); @@ -231,7 +231,7 @@ default Mono zAdd(ByteBuffer key, Collection tuples) { * {@code ZREM} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: ZREM + * @see Redis Documentation: ZREM */ class ZRemCommand extends KeyCommand { @@ -297,7 +297,7 @@ public List getValues() { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: ZREM + * @see Redis Documentation: ZREM */ default Mono zRem(ByteBuffer key, ByteBuffer value) { @@ -312,7 +312,7 @@ default Mono zRem(ByteBuffer key, ByteBuffer value) { * @param key must not be {@literal null}. * @param values must not be {@literal null}. * @return - * @see Redis Documentation: ZREM + * @see Redis Documentation: ZREM */ default Mono zRem(ByteBuffer key, Collection values) { @@ -327,7 +327,7 @@ default Mono zRem(ByteBuffer key, Collection values) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: ZREM + * @see Redis Documentation: ZREM */ Flux> zRem(Publisher commands); @@ -335,7 +335,7 @@ default Mono zRem(ByteBuffer key, Collection values) { * {@code ZINCRBY} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: ZINCRBY + * @see Redis Documentation: ZINCRBY */ class ZIncrByCommand extends KeyCommand { @@ -413,7 +413,7 @@ public Number getIncrement() { * @param increment must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: ZINCRBY + * @see Redis Documentation: ZINCRBY */ default Mono zIncrBy(ByteBuffer key, Number increment, ByteBuffer value) { @@ -431,7 +431,7 @@ default Mono zIncrBy(ByteBuffer key, Number increment, ByteBuffer value) * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: ZINCRBY + * @see Redis Documentation: ZINCRBY */ Flux> zIncrBy(Publisher commands); @@ -439,8 +439,8 @@ default Mono zIncrBy(ByteBuffer key, Number increment, ByteBuffer value) * {@code ZRANK}/{@literal ZREVRANK} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: ZRANK - * @see Redis Documentation: ZREVRANK + * @see Redis Documentation: ZRANK + * @see Redis Documentation: ZREVRANK */ class ZRankCommand extends KeyCommand { @@ -516,7 +516,7 @@ public Direction getDirection() { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: ZRANK + * @see Redis Documentation: ZRANK */ default Mono zRank(ByteBuffer key, ByteBuffer value) { @@ -532,7 +532,7 @@ default Mono zRank(ByteBuffer key, ByteBuffer value) { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: ZREVRANK + * @see Redis Documentation: ZREVRANK */ default Mono zRevRank(ByteBuffer key, ByteBuffer value) { @@ -549,8 +549,8 @@ default Mono zRevRank(ByteBuffer key, ByteBuffer value) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: ZRANK - * @see Redis Documentation: ZREVRANK + * @see Redis Documentation: ZRANK + * @see Redis Documentation: ZREVRANK */ Flux> zRank(Publisher commands); @@ -558,8 +558,8 @@ default Mono zRevRank(ByteBuffer key, ByteBuffer value) { * {@code ZRANGE}/{@literal ZREVRANGE} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: ZRANGE - * @see Redis Documentation: ZREVRANGE + * @see Redis Documentation: ZRANGE + * @see Redis Documentation: ZREVRANGE */ class ZRangeCommand extends KeyCommand { @@ -655,7 +655,7 @@ public Direction getDirection() { * @param key must not be {@literal null}. * @param range must not be {@literal null}. * @return - * @see Redis Documentation: ZRANGE + * @see Redis Documentation: ZRANGE */ default Flux zRange(ByteBuffer key, Range range) { @@ -672,7 +672,7 @@ default Flux zRange(ByteBuffer key, Range range) { * @param key must not be {@literal null}. * @param range must not be {@literal null}. * @return - * @see Redis Documentation: ZRANGE + * @see Redis Documentation: ZRANGE */ default Flux zRangeWithScores(ByteBuffer key, Range range) { @@ -688,7 +688,7 @@ default Flux zRangeWithScores(ByteBuffer key, Range range) { * @param key must not be {@literal null}. * @param range must not be {@literal null}. * @return - * @see Redis Documentation: ZREVRANGE + * @see Redis Documentation: ZREVRANGE */ default Flux zRevRange(ByteBuffer key, Range range) { @@ -704,7 +704,7 @@ default Flux zRevRange(ByteBuffer key, Range range) { * @param key must not be {@literal null}. * @param range must not be {@literal null}. * @return - * @see Redis Documentation: ZREVRANGE + * @see Redis Documentation: ZREVRANGE */ default Flux zRevRangeWithScores(ByteBuffer key, Range range) { @@ -719,8 +719,8 @@ default Flux zRevRangeWithScores(ByteBuffer key, Range range) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: ZRANGE - * @see Redis Documentation: ZREVRANGE + * @see Redis Documentation: ZRANGE + * @see Redis Documentation: ZREVRANGE */ Flux>> zRange(Publisher commands); @@ -728,8 +728,8 @@ default Flux zRevRangeWithScores(ByteBuffer key, Range range) { * {@literal ZRANGEBYSCORE}/{@literal ZREVRANGEBYSCORE}. * * @author Christoph Strobl - * @see Redis Documentation: ZRANGEBYSCORE - * @see Redis Documentation: ZREVRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZREVRANGEBYSCORE */ class ZRangeByScoreCommand extends KeyCommand { @@ -847,7 +847,7 @@ public Optional getLimit() { * @param key must not be {@literal null}. * @param range must not be {@literal null}. * @return - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE */ default Flux zRangeByScore(ByteBuffer key, Range range) { @@ -866,7 +866,7 @@ default Flux zRangeByScore(ByteBuffer key, Range range) { * @param range must not be {@literal null}. * @param limit must not be {@literal null}. * @return - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE */ default Flux zRangeByScore(ByteBuffer key, Range range, Limit limit) { @@ -885,7 +885,7 @@ default Flux zRangeByScore(ByteBuffer key, Range range, Limi * @param key must not be {@literal null}. * @param range must not be {@literal null}. * @return - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE */ default Flux zRangeByScoreWithScores(ByteBuffer key, Range range) { @@ -903,7 +903,7 @@ default Flux zRangeByScoreWithScores(ByteBuffer key, Range range) * @param range must not be {@literal null}. * @param limit must not be {@literal null}. * @return - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE */ default Flux zRangeByScoreWithScores(ByteBuffer key, Range range, Limit limit) { @@ -921,7 +921,7 @@ default Flux zRangeByScoreWithScores(ByteBuffer key, Range range, * @param key must not be {@literal null}. * @param range must not be {@literal null}. * @return - * @see Redis Documentation: ZREVRANGEBYSCORE + * @see Redis Documentation: ZREVRANGEBYSCORE */ default Flux zRevRangeByScore(ByteBuffer key, Range range) { @@ -939,7 +939,7 @@ default Flux zRevRangeByScore(ByteBuffer key, Range range) { * @param range must not be {@literal null}. * @param limit must not be {@literal null}. * @return - * @see Redis Documentation: ZREVRANGEBYSCORE + * @see Redis Documentation: ZREVRANGEBYSCORE */ default Flux zRevRangeByScore(ByteBuffer key, Range range, Limit limit) { @@ -958,7 +958,7 @@ default Flux zRevRangeByScore(ByteBuffer key, Range range, L * @param key must not be {@literal null}. * @param range must not be {@literal null}. * @return - * @see Redis Documentation: ZREVRANGEBYSCORE + * @see Redis Documentation: ZREVRANGEBYSCORE */ default Flux zRevRangeByScoreWithScores(ByteBuffer key, Range range) { @@ -976,7 +976,7 @@ default Flux zRevRangeByScoreWithScores(ByteBuffer key, Range ran * @param range must not be {@literal null}. * @param limit must not be {@literal null}. * @return - * @see Redis Documentation: ZREVRANGEBYSCORE + * @see Redis Documentation: ZREVRANGEBYSCORE */ default Flux zRevRangeByScoreWithScores(ByteBuffer key, Range range, Limit limit) { @@ -994,8 +994,8 @@ default Flux zRevRangeByScoreWithScores(ByteBuffer key, Range ran * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: ZRANGEBYSCORE - * @see Redis Documentation: ZREVRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZREVRANGEBYSCORE */ Flux>> zRangeByScore(Publisher commands); @@ -1006,7 +1006,7 @@ default Flux zRevRangeByScoreWithScores(ByteBuffer key, Range ran * @param key must not be {@literal null}. * @return the {@link Flux} emitting the raw {@link Tuple tuples} one by one. * @throws IllegalArgumentException when key is {@literal null}. - * @see Redis Documentation: ZSCAN + * @see Redis Documentation: ZSCAN * @since 2.1 */ default Flux zScan(ByteBuffer key) { @@ -1021,7 +1021,7 @@ default Flux zScan(ByteBuffer key) { * @param options must not be {@literal null}. Use {@link ScanOptions#NONE} instead. * @return the {@link Flux} emitting the raw {@link Tuple tuples} one by one. * @throws IllegalArgumentException when one of the required arguments is {@literal null}. - * @see Redis Documentation: ZSCAN + * @see Redis Documentation: ZSCAN * @since 2.1 */ default Flux zScan(ByteBuffer key, ScanOptions options) { @@ -1036,7 +1036,7 @@ default Flux zScan(ByteBuffer key, ScanOptions options) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: ZSCAN + * @see Redis Documentation: ZSCAN * @since 2.1 */ Flux>> zScan(Publisher commands); @@ -1045,7 +1045,7 @@ default Flux zScan(ByteBuffer key, ScanOptions options) { * {@code ZCOUNT} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: ZCOUNT + * @see Redis Documentation: ZCOUNT */ class ZCountCommand extends KeyCommand { @@ -1099,7 +1099,7 @@ public Range getRange() { * @param key must not be {@literal null}. * @param range must not be {@literal null}. * @return - * @see Redis Documentation: ZCOUNT + * @see Redis Documentation: ZCOUNT */ default Mono zCount(ByteBuffer key, Range range) { @@ -1116,7 +1116,7 @@ default Mono zCount(ByteBuffer key, Range range) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: ZCOUNT + * @see Redis Documentation: ZCOUNT */ Flux> zCount(Publisher commands); @@ -1125,7 +1125,7 @@ default Mono zCount(ByteBuffer key, Range range) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: ZCARD + * @see Redis Documentation: ZCARD */ default Mono zCard(ByteBuffer key) { @@ -1139,7 +1139,7 @@ default Mono zCard(ByteBuffer key) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: ZCARD + * @see Redis Documentation: ZCARD */ Flux> zCard(Publisher commands); @@ -1147,7 +1147,7 @@ default Mono zCard(ByteBuffer key) { * {@code ZSCORE} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: ZSCORE + * @see Redis Documentation: ZSCORE */ class ZScoreCommand extends KeyCommand { @@ -1199,7 +1199,7 @@ public ByteBuffer getValue() { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: ZSCORE + * @see Redis Documentation: ZSCORE */ default Mono zScore(ByteBuffer key, ByteBuffer value) { @@ -1215,7 +1215,7 @@ default Mono zScore(ByteBuffer key, ByteBuffer value) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: ZSCORE + * @see Redis Documentation: ZSCORE */ Flux> zScore(Publisher commands); @@ -1223,7 +1223,7 @@ default Mono zScore(ByteBuffer key, ByteBuffer value) { * {@code ZREMRANGEBYRANK} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: ZREMRANGEBYRANK + * @see Redis Documentation: ZREMRANGEBYRANK */ class ZRemRangeByRankCommand extends KeyCommand { @@ -1274,7 +1274,7 @@ public Range getRange() { * @param key must not be {@literal null}. * @param range must not be {@literal null}. * @return - * @see Redis Documentation: ZREMRANGEBYRANK + * @see Redis Documentation: ZREMRANGEBYRANK */ default Mono zRemRangeByRank(ByteBuffer key, Range range) { @@ -1290,7 +1290,7 @@ default Mono zRemRangeByRank(ByteBuffer key, Range range) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: ZREMRANGEBYRANK + * @see Redis Documentation: ZREMRANGEBYRANK */ Flux> zRemRangeByRank(Publisher commands); @@ -1298,7 +1298,7 @@ default Mono zRemRangeByRank(ByteBuffer key, Range range) { * {@code ZREMRANGEBYSCORE} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: ZREMRANGEBYSCORE + * @see Redis Documentation: ZREMRANGEBYSCORE */ class ZRemRangeByScoreCommand extends KeyCommand { @@ -1347,7 +1347,7 @@ public Range getRange() { * @param key must not be {@literal null}. * @param range must not be {@literal null}. * @return - * @see Redis Documentation: ZREMRANGEBYSCORE + * @see Redis Documentation: ZREMRANGEBYSCORE */ default Mono zRemRangeByScore(ByteBuffer key, Range range) { @@ -1363,7 +1363,7 @@ default Mono zRemRangeByScore(ByteBuffer key, Range range) { * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: ZREMRANGEBYSCORE + * @see Redis Documentation: ZREMRANGEBYSCORE */ Flux> zRemRangeByScore(Publisher commands); @@ -1371,7 +1371,7 @@ default Mono zRemRangeByScore(ByteBuffer key, Range range) { * {@code ZUNIONSTORE} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: ZUNIONSTORE + * @see Redis Documentation: ZUNIONSTORE */ class ZUnionStoreCommand extends KeyCommand { @@ -1476,7 +1476,7 @@ public Optional getAggregateFunction() { * @param destinationKey must not be {@literal null}. * @param sets must not be {@literal null}. * @return - * @see Redis Documentation: ZUNIONSTORE + * @see Redis Documentation: ZUNIONSTORE */ default Mono zUnionStore(ByteBuffer destinationKey, List sets) { return zUnionStore(destinationKey, sets, Collections.emptyList()); @@ -1490,7 +1490,7 @@ default Mono zUnionStore(ByteBuffer destinationKey, List sets) * @param sets must not be {@literal null}. * @param weights must not be {@literal null}. * @return - * @see Redis Documentation: ZUNIONSTORE + * @see Redis Documentation: ZUNIONSTORE */ default Mono zUnionStore(ByteBuffer destinationKey, List sets, List weights) { return zUnionStore(destinationKey, sets, weights, null); @@ -1505,7 +1505,7 @@ default Mono zUnionStore(ByteBuffer destinationKey, List sets, * @param weights must not be {@literal null}. * @return * @since 2.1 - * @see Redis Documentation: ZUNIONSTORE + * @see Redis Documentation: ZUNIONSTORE */ default Mono zUnionStore(ByteBuffer destinationKey, List sets, Weights weights) { return zUnionStore(destinationKey, sets, weights, null); @@ -1520,7 +1520,7 @@ default Mono zUnionStore(ByteBuffer destinationKey, List sets, * @param weights can be {@literal null}. * @param aggregateFunction can be {@literal null}. * @return - * @see Redis Documentation: ZUNIONSTORE + * @see Redis Documentation: ZUNIONSTORE */ default Mono zUnionStore(ByteBuffer destinationKey, List sets, List weights, @Nullable Aggregate aggregateFunction) { @@ -1543,7 +1543,7 @@ default Mono zUnionStore(ByteBuffer destinationKey, List sets, * @param aggregateFunction can be {@literal null}. * @return * @since 2.1 - * @see Redis Documentation: ZUNIONSTORE + * @see Redis Documentation: ZUNIONSTORE */ default Mono zUnionStore(ByteBuffer destinationKey, List sets, Weights weights, @Nullable Aggregate aggregateFunction) { @@ -1562,7 +1562,7 @@ default Mono zUnionStore(ByteBuffer destinationKey, List sets, * * @param commands * @return - * @see Redis Documentation: ZUNIONSTORE + * @see Redis Documentation: ZUNIONSTORE */ Flux> zUnionStore(Publisher commands); @@ -1570,7 +1570,7 @@ default Mono zUnionStore(ByteBuffer destinationKey, List sets, * {@code ZINTERSTORE} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: ZINTERSTORE + * @see Redis Documentation: ZINTERSTORE */ class ZInterStoreCommand extends KeyCommand { @@ -1676,7 +1676,7 @@ public Optional getAggregateFunction() { * @param destinationKey must not be {@literal null}. * @param sets must not be {@literal null}. * @return - * @see Redis Documentation: ZINTERSTORE + * @see Redis Documentation: ZINTERSTORE */ default Mono zInterStore(ByteBuffer destinationKey, List sets) { return zInterStore(destinationKey, sets, Collections.emptyList()); @@ -1690,7 +1690,7 @@ default Mono zInterStore(ByteBuffer destinationKey, List sets) * @param sets must not be {@literal null}. * @param weights must not be {@literal null}. * @return - * @see Redis Documentation: ZINTERSTORE + * @see Redis Documentation: ZINTERSTORE */ default Mono zInterStore(ByteBuffer destinationKey, List sets, List weights) { return zInterStore(destinationKey, sets, weights, null); @@ -1705,7 +1705,7 @@ default Mono zInterStore(ByteBuffer destinationKey, List sets, * @param weights must not be {@literal null}. * @return * @since 2.1 - * @see Redis Documentation: ZINTERSTORE + * @see Redis Documentation: ZINTERSTORE */ default Mono zInterStore(ByteBuffer destinationKey, List sets, Weights weights) { return zInterStore(destinationKey, sets, weights, null); @@ -1720,7 +1720,7 @@ default Mono zInterStore(ByteBuffer destinationKey, List sets, * @param weights must not be {@literal null}. * @param aggregateFunction can be {@literal null}. * @return - * @see Redis Documentation: ZINTERSTORE + * @see Redis Documentation: ZINTERSTORE */ default Mono zInterStore(ByteBuffer destinationKey, List sets, List weights, @Nullable Aggregate aggregateFunction) { @@ -1743,7 +1743,7 @@ default Mono zInterStore(ByteBuffer destinationKey, List sets, * @param aggregateFunction can be {@literal null}. * @return * @since 2.1 - * @see Redis Documentation: ZINTERSTORE + * @see Redis Documentation: ZINTERSTORE */ default Mono zInterStore(ByteBuffer destinationKey, List sets, Weights weights, @Nullable Aggregate aggregateFunction) { @@ -1762,7 +1762,7 @@ default Mono zInterStore(ByteBuffer destinationKey, List sets, * * @param commands * @return - * @see Redis Documentation: ZINTERSTORE + * @see Redis Documentation: ZINTERSTORE */ Flux> zInterStore(Publisher commands); @@ -1770,8 +1770,8 @@ default Mono zInterStore(ByteBuffer destinationKey, List sets, * {@code ZRANGEBYLEX}/{@literal ZREVRANGEBYLEX} command parameters. * * @author Christoph Strobl - * @see Redis Documentation: ZRANGEBYLEX - * @see Redis Documentation: ZREVRANGEBYLEX + * @see Redis Documentation: ZRANGEBYLEX + * @see Redis Documentation: ZREVRANGEBYLEX */ class ZRangeByLexCommand extends KeyCommand { @@ -1868,7 +1868,7 @@ public Direction getDirection() { * @param key must not be {@literal null}. * @param range must not be {@literal null}. * @return - * @see Redis Documentation: ZRANGEBYLEX + * @see Redis Documentation: ZRANGEBYLEX */ default Flux zRangeByLex(ByteBuffer key, Range range) { return zRangeByLex(key, range, Limit.unlimited()); @@ -1882,7 +1882,7 @@ default Flux zRangeByLex(ByteBuffer key, Range range) { * @param range must not be {@literal null}. * @param limit can be {@literal null}. * @return - * @see Redis Documentation: ZRANGEBYLEX + * @see Redis Documentation: ZRANGEBYLEX */ default Flux zRangeByLex(ByteBuffer key, Range range, Limit limit) { @@ -1899,7 +1899,7 @@ default Flux zRangeByLex(ByteBuffer key, Range range, Limit * @param key must not be {@literal null}. * @param range must not be {@literal null}. * @return - * @see Redis Documentation: ZREVRANGEBYLEX + * @see Redis Documentation: ZREVRANGEBYLEX */ default Flux zRevRangeByLex(ByteBuffer key, Range range) { return zRevRangeByLex(key, range, Limit.unlimited()); @@ -1913,7 +1913,7 @@ default Flux zRevRangeByLex(ByteBuffer key, Range range) { * @param range must not be {@literal null}. * @param limit must not be {@literal null}. * @return - * @see Redis Documentation: ZREVRANGEBYLEX + * @see Redis Documentation: ZREVRANGEBYLEX */ default Flux zRevRangeByLex(ByteBuffer key, Range range, Limit limit) { @@ -1931,8 +1931,8 @@ default Flux zRevRangeByLex(ByteBuffer key, Range range, Lim * * @param commands must not be {@literal null}. * @return - * @see Redis Documentation: ZRANGEBYLEX - * @see Redis Documentation: ZREVRANGEBYLEX + * @see Redis Documentation: ZRANGEBYLEX + * @see Redis Documentation: ZREVRANGEBYLEX */ Flux>> zRangeByLex(Publisher commands); } diff --git a/src/main/java/org/springframework/data/redis/connection/RedisClusterConfiguration.java b/src/main/java/org/springframework/data/redis/connection/RedisClusterConfiguration.java index 097f7bde04..d202bcccbe 100644 --- a/src/main/java/org/springframework/data/redis/connection/RedisClusterConfiguration.java +++ b/src/main/java/org/springframework/data/redis/connection/RedisClusterConfiguration.java @@ -35,7 +35,7 @@ /** * Configuration class used for setting up {@link RedisConnection} via {@link RedisConnectionFactory} using connecting - * to Redis Cluster. Useful when setting up a high availability Redis + * to Redis Cluster. Useful when setting up a high availability Redis * environment. * * @author Christoph Strobl diff --git a/src/main/java/org/springframework/data/redis/connection/RedisClusterConnection.java b/src/main/java/org/springframework/data/redis/connection/RedisClusterConnection.java index 1367168790..7a2f277b42 100644 --- a/src/main/java/org/springframework/data/redis/connection/RedisClusterConnection.java +++ b/src/main/java/org/springframework/data/redis/connection/RedisClusterConnection.java @@ -58,7 +58,7 @@ public interface RedisClusterConnection extends RedisConnection, RedisClusterCom * @param options must not be {@literal null}. * @return never {@literal null}. * @since 2.1 - * @see Redis Documentation: SCAN + * @see Redis Documentation: SCAN */ Cursor scan(RedisClusterNode node, ScanOptions options); diff --git a/src/main/java/org/springframework/data/redis/connection/RedisConnectionCommands.java b/src/main/java/org/springframework/data/redis/connection/RedisConnectionCommands.java index 10683d0a04..170146bd68 100644 --- a/src/main/java/org/springframework/data/redis/connection/RedisConnectionCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/RedisConnectionCommands.java @@ -30,7 +30,7 @@ public interface RedisConnectionCommands { * Select the DB with given positive {@code dbIndex}. * * @param dbIndex the database index. - * @see Redis Documentation: SELECT + * @see Redis Documentation: SELECT */ void select(int dbIndex); @@ -39,7 +39,7 @@ public interface RedisConnectionCommands { * * @param message the message to echo. * @return the message or {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ECHO + * @see Redis Documentation: ECHO */ @Nullable byte[] echo(byte[] message); @@ -48,7 +48,7 @@ public interface RedisConnectionCommands { * Test connection. * * @return Server response message - usually {@literal PONG}. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: PING + * @see Redis Documentation: PING */ @Nullable String ping(); diff --git a/src/main/java/org/springframework/data/redis/connection/RedisGeoCommands.java b/src/main/java/org/springframework/data/redis/connection/RedisGeoCommands.java index 1e2dfd0513..265e90569c 100644 --- a/src/main/java/org/springframework/data/redis/connection/RedisGeoCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/RedisGeoCommands.java @@ -49,7 +49,7 @@ public interface RedisGeoCommands { * @param point must not be {@literal null}. * @param member must not be {@literal null}. * @return Number of elements added. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD */ @Nullable Long geoAdd(byte[] key, Point point, byte[] member); @@ -60,7 +60,7 @@ public interface RedisGeoCommands { * @param key must not be {@literal null}. * @param location must not be {@literal null}. * @return Number of elements added. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD */ @Nullable default Long geoAdd(byte[] key, GeoLocation location) { @@ -77,7 +77,7 @@ default Long geoAdd(byte[] key, GeoLocation location) { * @param key must not be {@literal null}. * @param memberCoordinateMap must not be {@literal null}. * @return Number of elements added. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD */ @Nullable Long geoAdd(byte[] key, Map memberCoordinateMap); @@ -88,7 +88,7 @@ default Long geoAdd(byte[] key, GeoLocation location) { * @param key must not be {@literal null}. * @param locations must not be {@literal null}. * @return Number of elements added. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD */ @Nullable Long geoAdd(byte[] key, Iterable> locations); @@ -100,7 +100,7 @@ default Long geoAdd(byte[] key, GeoLocation location) { * @param member1 must not be {@literal null}. * @param member2 must not be {@literal null}. * @return can be {@literal null}. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GEODIST + * @see Redis Documentation: GEODIST */ @Nullable Distance geoDist(byte[] key, byte[] member1, byte[] member2); @@ -113,7 +113,7 @@ default Long geoAdd(byte[] key, GeoLocation location) { * @param member2 must not be {@literal null}. * @param metric must not be {@literal null}. * @return can be {@literal null}. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GEODIST + * @see Redis Documentation: GEODIST */ @Nullable Distance geoDist(byte[] key, byte[] member1, byte[] member2, Metric metric); @@ -124,7 +124,7 @@ default Long geoAdd(byte[] key, GeoLocation location) { * @param key must not be {@literal null}. * @param members must not be {@literal null}. * @return empty list when key or members do not exists. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GEOHASH + * @see Redis Documentation: GEOHASH */ @Nullable List geoHash(byte[] key, byte[]... members); @@ -135,7 +135,7 @@ default Long geoAdd(byte[] key, GeoLocation location) { * @param key must not be {@literal null}. * @param members must not be {@literal null}. * @return empty {@link List} when key of members do not exist. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GEOPOS + * @see Redis Documentation: GEOPOS */ @Nullable List geoPos(byte[] key, byte[]... members); @@ -146,7 +146,7 @@ default Long geoAdd(byte[] key, GeoLocation location) { * @param key must not be {@literal null}. * @param within must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GEORADIUS + * @see Redis Documentation: GEORADIUS */ @Nullable GeoResults> geoRadius(byte[] key, Circle within); @@ -158,7 +158,7 @@ default Long geoAdd(byte[] key, GeoLocation location) { * @param within must not be {@literal null}. * @param args must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GEORADIUS + * @see Redis Documentation: GEORADIUS */ @Nullable GeoResults> geoRadius(byte[] key, Circle within, GeoRadiusCommandArgs args); @@ -171,7 +171,7 @@ default Long geoAdd(byte[] key, GeoLocation location) { * @param member must not be {@literal null}. * @param radius * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER */ @Nullable default GeoResults> geoRadiusByMember(byte[] key, byte[] member, double radius) { @@ -186,7 +186,7 @@ default GeoResults> geoRadiusByMember(byte[] key, byte[] mem * @param member must not be {@literal null}. * @param radius must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction.. - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER */ @Nullable GeoResults> geoRadiusByMember(byte[] key, byte[] member, Distance radius); @@ -200,7 +200,7 @@ default GeoResults> geoRadiusByMember(byte[] key, byte[] mem * @param radius must not be {@literal null}. * @param args must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER */ @Nullable GeoResults> geoRadiusByMember(byte[] key, byte[] member, Distance radius, @@ -212,7 +212,7 @@ GeoResults> geoRadiusByMember(byte[] key, byte[] member, Dis * @param key must not be {@literal null}. * @param members must not be {@literal null}. * @return Number of elements removed. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREM + * @see Redis Documentation: ZREM */ @Nullable Long geoRemove(byte[] key, byte[]... members); diff --git a/src/main/java/org/springframework/data/redis/connection/RedisHashCommands.java b/src/main/java/org/springframework/data/redis/connection/RedisHashCommands.java index aa1f0169d1..5d126b0d60 100644 --- a/src/main/java/org/springframework/data/redis/connection/RedisHashCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/RedisHashCommands.java @@ -39,7 +39,7 @@ public interface RedisHashCommands { * @param field must not be {@literal null}. * @param value must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: HSET + * @see Redis Documentation: HSET */ @Nullable Boolean hSet(byte[] key, byte[] field, byte[] value); @@ -51,7 +51,7 @@ public interface RedisHashCommands { * @param field must not be {@literal null}. * @param value must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: HSETNX + * @see Redis Documentation: HSETNX */ @Nullable Boolean hSetNX(byte[] key, byte[] field, byte[] value); @@ -62,7 +62,7 @@ public interface RedisHashCommands { * @param key must not be {@literal null}. * @param field must not be {@literal null}. * @return {@literal null} when key or field do not exists or when used in pipeline / transaction. - * @see Redis Documentation: HGET + * @see Redis Documentation: HGET */ @Nullable byte[] hGet(byte[] key, byte[] field); @@ -73,7 +73,7 @@ public interface RedisHashCommands { * @param key must not be {@literal null}. * @param fields must not be {@literal empty}. * @return empty {@link List} if key or fields do not exists. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: HMGET + * @see Redis Documentation: HMGET */ @Nullable List hMGet(byte[] key, byte[]... fields); @@ -83,7 +83,7 @@ public interface RedisHashCommands { * * @param key must not be {@literal null}. * @param hashes must not be {@literal null}. - * @see Redis Documentation: HMSET + * @see Redis Documentation: HMSET */ void hMSet(byte[] key, Map hashes); @@ -94,7 +94,7 @@ public interface RedisHashCommands { * @param field must not be {@literal null}. * @param delta * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: HINCRBY + * @see Redis Documentation: HINCRBY */ @Nullable Long hIncrBy(byte[] key, byte[] field, long delta); @@ -106,7 +106,7 @@ public interface RedisHashCommands { * @param field must not be {@literal null}. * @param delta * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: HINCRBYFLOAT + * @see Redis Documentation: HINCRBYFLOAT */ @Nullable Double hIncrBy(byte[] key, byte[] field, double delta); @@ -117,7 +117,7 @@ public interface RedisHashCommands { * @param key must not be {@literal null}. * @param field must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: HEXISTS + * @see Redis Documentation: HEXISTS */ @Nullable Boolean hExists(byte[] key, byte[] field); @@ -128,7 +128,7 @@ public interface RedisHashCommands { * @param key must not be {@literal null}. * @param fields must not be {@literal empty}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: HDEL + * @see Redis Documentation: HDEL */ @Nullable Long hDel(byte[] key, byte[]... fields); @@ -138,7 +138,7 @@ public interface RedisHashCommands { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: HLEN + * @see Redis Documentation: HLEN */ @Nullable Long hLen(byte[] key); @@ -148,7 +148,7 @@ public interface RedisHashCommands { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: HKEYS? + * @see Redis Documentation: HKEYS? */ @Nullable Set hKeys(byte[] key); @@ -158,7 +158,7 @@ public interface RedisHashCommands { * * @param key must not be {@literal null}. * @return empty {@link List} if key does not exist. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: HVALS + * @see Redis Documentation: HVALS */ @Nullable List hVals(byte[] key); @@ -168,7 +168,7 @@ public interface RedisHashCommands { * * @param key must not be {@literal null}. * @return empty {@link Map} if key does not exist or {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: HGETALL + * @see Redis Documentation: HGETALL */ @Nullable Map hGetAll(byte[] key); @@ -180,7 +180,7 @@ public interface RedisHashCommands { * @param options must not be {@literal null}. * @return * @since 1.4 - * @see Redis Documentation: HSCAN + * @see Redis Documentation: HSCAN */ Cursor> hScan(byte[] key, ScanOptions options); diff --git a/src/main/java/org/springframework/data/redis/connection/RedisHyperLogLogCommands.java b/src/main/java/org/springframework/data/redis/connection/RedisHyperLogLogCommands.java index 2d299ac3fc..415e5140fe 100644 --- a/src/main/java/org/springframework/data/redis/connection/RedisHyperLogLogCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/RedisHyperLogLogCommands.java @@ -32,7 +32,7 @@ public interface RedisHyperLogLogCommands { * @param key must not be {@literal null}. * @param values must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: PFADD + * @see Redis Documentation: PFADD */ @Nullable Long pfAdd(byte[] key, byte[]... values); @@ -42,7 +42,7 @@ public interface RedisHyperLogLogCommands { * * @param keys must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: PFCOUNT + * @see Redis Documentation: PFCOUNT */ @Nullable Long pfCount(byte[]... keys); @@ -52,7 +52,7 @@ public interface RedisHyperLogLogCommands { * * @param destinationKey must not be {@literal null}. * @param sourceKeys must not be {@literal null}. - * @see Redis Documentation: PFMERGE + * @see Redis Documentation: PFMERGE */ void pfMerge(byte[] destinationKey, byte[]... sourceKeys); diff --git a/src/main/java/org/springframework/data/redis/connection/RedisKeyCommands.java b/src/main/java/org/springframework/data/redis/connection/RedisKeyCommands.java index 1e9ed04cc6..b79f87ee99 100644 --- a/src/main/java/org/springframework/data/redis/connection/RedisKeyCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/RedisKeyCommands.java @@ -39,7 +39,7 @@ public interface RedisKeyCommands { * * @param key must not be {@literal null}. * @return {@literal true} if key exists. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: EXISTS + * @see Redis Documentation: EXISTS */ @Nullable default Boolean exists(byte[] key) { @@ -66,7 +66,7 @@ default Boolean exists(byte[] key) { * * @param keys must not be {@literal null}. * @return The number of keys that were removed. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: DEL + * @see Redis Documentation: DEL */ @Nullable Long del(byte[]... keys); @@ -77,7 +77,7 @@ default Boolean exists(byte[] key) { * * @param keys must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: UNLINK + * @see Redis Documentation: UNLINK * @since 2.1 */ @Nullable @@ -88,7 +88,7 @@ default Boolean exists(byte[] key) { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: TYPE + * @see Redis Documentation: TYPE */ @Nullable DataType type(byte[] key); @@ -98,7 +98,7 @@ default Boolean exists(byte[] key) { * * @param keys must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: TOUCH + * @see Redis Documentation: TOUCH * @since 2.1 */ @Nullable @@ -109,7 +109,7 @@ default Boolean exists(byte[] key) { * * @param pattern must not be {@literal null}. * @return empty {@link Set} if no match found. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: KEYS + * @see Redis Documentation: KEYS */ @Nullable Set keys(byte[] pattern); @@ -120,7 +120,7 @@ default Boolean exists(byte[] key) { * @param options must not be {@literal null}. * @return never {@literal null}. * @since 1.4 - * @see Redis Documentation: SCAN + * @see Redis Documentation: SCAN */ Cursor scan(ScanOptions options); @@ -128,7 +128,7 @@ default Boolean exists(byte[] key) { * Return a random key from the keyspace. * * @return {@literal null} if no keys available or when used in pipeline or transaction. - * @see Redis Documentation: RANDOMKEY + * @see Redis Documentation: RANDOMKEY */ @Nullable byte[] randomKey(); @@ -138,7 +138,7 @@ default Boolean exists(byte[] key) { * * @param sourceKey must not be {@literal null}. * @param targetKey must not be {@literal null}. - * @see Redis Documentation: RENAME + * @see Redis Documentation: RENAME */ void rename(byte[] sourceKey, byte[] targetKey); @@ -148,7 +148,7 @@ default Boolean exists(byte[] key) { * @param sourceKey must not be {@literal null}. * @param targetKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: RENAMENX + * @see Redis Documentation: RENAMENX */ @Nullable Boolean renameNX(byte[] sourceKey, byte[] targetKey); @@ -159,7 +159,7 @@ default Boolean exists(byte[] key) { * @param key must not be {@literal null}. * @param seconds * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: EXPIRE + * @see Redis Documentation: EXPIRE */ @Nullable Boolean expire(byte[] key, long seconds); @@ -170,7 +170,7 @@ default Boolean exists(byte[] key) { * @param key must not be {@literal null}. * @param millis * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: PEXPIRE + * @see Redis Documentation: PEXPIRE */ @Nullable Boolean pExpire(byte[] key, long millis); @@ -181,7 +181,7 @@ default Boolean exists(byte[] key) { * @param key must not be {@literal null}. * @param unixTime * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: EXPIREAT + * @see Redis Documentation: EXPIREAT */ @Nullable Boolean expireAt(byte[] key, long unixTime); @@ -192,7 +192,7 @@ default Boolean exists(byte[] key) { * @param key must not be {@literal null}. * @param unixTimeInMillis * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: PEXPIREAT + * @see Redis Documentation: PEXPIREAT */ @Nullable Boolean pExpireAt(byte[] key, long unixTimeInMillis); @@ -202,7 +202,7 @@ default Boolean exists(byte[] key) { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: PERSIST + * @see Redis Documentation: PERSIST */ @Nullable Boolean persist(byte[] key); @@ -213,7 +213,7 @@ default Boolean exists(byte[] key) { * @param key must not be {@literal null}. * @param dbIndex * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: MOVE + * @see Redis Documentation: MOVE */ @Nullable Boolean move(byte[] key, int dbIndex); @@ -223,7 +223,7 @@ default Boolean exists(byte[] key) { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: TTL + * @see Redis Documentation: TTL */ @Nullable Long ttl(byte[] key); @@ -235,7 +235,7 @@ default Boolean exists(byte[] key) { * @param timeUnit must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 1.8 - * @see Redis Documentation: TTL + * @see Redis Documentation: TTL */ @Nullable Long ttl(byte[] key, TimeUnit timeUnit); @@ -245,7 +245,7 @@ default Boolean exists(byte[] key) { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: PTTL + * @see Redis Documentation: PTTL */ @Nullable Long pTtl(byte[] key); @@ -257,7 +257,7 @@ default Boolean exists(byte[] key) { * @param timeUnit must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 1.8 - * @see Redis Documentation: PTTL + * @see Redis Documentation: PTTL */ @Nullable Long pTtl(byte[] key, TimeUnit timeUnit); @@ -268,7 +268,7 @@ default Boolean exists(byte[] key) { * @param key must not be {@literal null}. * @param params must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SORT + * @see Redis Documentation: SORT */ @Nullable List sort(byte[] key, SortParameters params); @@ -280,7 +280,7 @@ default Boolean exists(byte[] key) { * @param params must not be {@literal null}. * @param storeKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SORT + * @see Redis Documentation: SORT */ @Nullable Long sort(byte[] key, SortParameters params, byte[] storeKey); @@ -290,7 +290,7 @@ default Boolean exists(byte[] key) { * * @param key must not be {@literal null}. * @return {@literal null} if key does not exist or when used in pipeline / transaction. - * @see Redis Documentation: DUMP + * @see Redis Documentation: DUMP */ @Nullable byte[] dump(byte[] key); @@ -301,7 +301,7 @@ default Boolean exists(byte[] key) { * @param key must not be {@literal null}. * @param ttlInMillis * @param serializedValue must not be {@literal null}. - * @see Redis Documentation: RESTORE + * @see Redis Documentation: RESTORE */ default void restore(byte[] key, long ttlInMillis, byte[] serializedValue) { restore(key, ttlInMillis, serializedValue, false); @@ -315,7 +315,7 @@ default void restore(byte[] key, long ttlInMillis, byte[] serializedValue) { * @param serializedValue must not be {@literal null}. * @param replace use {@literal true} to replace a potentially existing value instead of erroring. * @since 2.1 - * @see Redis Documentation: RESTORE + * @see Redis Documentation: RESTORE */ void restore(byte[] key, long ttlInMillis, byte[] serializedValue, boolean replace); @@ -326,7 +326,7 @@ default void restore(byte[] key, long ttlInMillis, byte[] serializedValue) { * @return {@link org.springframework.data.redis.connection.ValueEncoding.RedisValueEncoding#VACANT} if key does not * exist or {@literal null} when used in pipeline / transaction. * @throws IllegalArgumentException if {@code key} is {@literal null}. - * @see Redis Documentation: OBJECT ENCODING + * @see Redis Documentation: OBJECT ENCODING * @since 2.1 */ @Nullable @@ -338,7 +338,7 @@ default void restore(byte[] key, long ttlInMillis, byte[] serializedValue) { * @param key must not be {@literal null}. * @return {@literal null} if key does not exist or when used in pipeline / transaction. * @throws IllegalArgumentException if {@code key} is {@literal null}. - * @see Redis Documentation: OBJECT IDLETIME + * @see Redis Documentation: OBJECT IDLETIME * @since 2.1 */ @Nullable @@ -350,7 +350,7 @@ default void restore(byte[] key, long ttlInMillis, byte[] serializedValue) { * @param key must not be {@literal null}. * @return {@literal null} if key does not exist or when used in pipeline / transaction. * @throws IllegalArgumentException if {@code key} is {@literal null}. - * @see Redis Documentation: OBJECT REFCOUNT + * @see Redis Documentation: OBJECT REFCOUNT * @since 2.1 */ @Nullable diff --git a/src/main/java/org/springframework/data/redis/connection/RedisListCommands.java b/src/main/java/org/springframework/data/redis/connection/RedisListCommands.java index d7f6c8b683..0171f5c67a 100644 --- a/src/main/java/org/springframework/data/redis/connection/RedisListCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/RedisListCommands.java @@ -41,7 +41,7 @@ enum Position { * @param key must not be {@literal null}. * @param values must not be empty. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: RPUSH + * @see Redis Documentation: RPUSH */ @Nullable Long rPush(byte[] key, byte[]... values); @@ -52,7 +52,7 @@ enum Position { * @param key must not be {@literal null}. * @param values must not be empty. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: LPUSH + * @see Redis Documentation: LPUSH */ @Nullable Long lPush(byte[] key, byte[]... values); @@ -63,7 +63,7 @@ enum Position { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: RPUSHX + * @see Redis Documentation: RPUSHX */ @Nullable Long rPushX(byte[] key, byte[] value); @@ -74,7 +74,7 @@ enum Position { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: LPUSHX + * @see Redis Documentation: LPUSHX */ @Nullable Long lPushX(byte[] key, byte[] value); @@ -84,7 +84,7 @@ enum Position { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: LLEN + * @see Redis Documentation: LLEN */ @Nullable Long lLen(byte[] key); @@ -97,7 +97,7 @@ enum Position { * @param end * @return empty {@link List} if key does not exists or range does not contain values. {@literal null} when used in * pipeline / transaction. - * @see Redis Documentation: LRANGE + * @see Redis Documentation: LRANGE */ @Nullable List lRange(byte[] key, long start, long end); @@ -108,7 +108,7 @@ enum Position { * @param key must not be {@literal null}. * @param start * @param end - * @see Redis Documentation: LTRIM + * @see Redis Documentation: LTRIM */ void lTrim(byte[] key, long start, long end); @@ -118,7 +118,7 @@ enum Position { * @param key must not be {@literal null}. * @param index zero based index value. Use negative number to designate elements starting at the tail. * @return {@literal null} when index is out of range or when used in pipeline / transaction. - * @see Redis Documentation: LINDEX + * @see Redis Documentation: LINDEX */ @Nullable byte[] lIndex(byte[] key, long index); @@ -131,7 +131,7 @@ enum Position { * @param pivot must not be {@literal null}. * @param value must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: LINSERT + * @see Redis Documentation: LINSERT */ @Nullable Long lInsert(byte[] key, Position where, byte[] pivot, byte[] value); @@ -142,7 +142,7 @@ enum Position { * @param key must not be {@literal null}. * @param index * @param value - * @see Redis Documentation: LSET + * @see Redis Documentation: LSET */ void lSet(byte[] key, long index, byte[] value); @@ -153,7 +153,7 @@ enum Position { * @param count * @param value * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: LREM + * @see Redis Documentation: LREM */ @Nullable Long lRem(byte[] key, long count, byte[] value); @@ -163,7 +163,7 @@ enum Position { * * @param key must not be {@literal null}. * @return {@literal null} when key does not exist or used in pipeline / transaction. - * @see Redis Documentation: LPOP + * @see Redis Documentation: LPOP */ @Nullable byte[] lPop(byte[] key); @@ -173,7 +173,7 @@ enum Position { * * @param key must not be {@literal null}. * @return {@literal null} when key does not exist or used in pipeline / transaction. - * @see Redis Documentation: RPOP + * @see Redis Documentation: RPOP */ @Nullable byte[] rPop(byte[] key); @@ -186,7 +186,7 @@ enum Position { * @param keys must not be {@literal null}. * @return empty {@link List} when no element could be popped and the timeout was reached. {@literal null} when used * in pipeline / transaction. - * @see Redis Documentation: BLPOP + * @see Redis Documentation: BLPOP * @see #lPop(byte[]) */ @Nullable @@ -200,7 +200,7 @@ enum Position { * @param keys must not be {@literal null}. * @return empty {@link List} when no element could be popped and the timeout was reached. {@literal null} when used * in pipeline / transaction. - * @see Redis Documentation: BRPOP + * @see Redis Documentation: BRPOP * @see #rPop(byte[]) */ @Nullable @@ -212,7 +212,7 @@ enum Position { * @param srcKey must not be {@literal null}. * @param dstKey must not be {@literal null}. * @return can be {@literal null}. - * @see Redis Documentation: RPOPLPUSH + * @see Redis Documentation: RPOPLPUSH */ @Nullable byte[] rPopLPush(byte[] srcKey, byte[] dstKey); @@ -225,7 +225,7 @@ enum Position { * @param srcKey must not be {@literal null}. * @param dstKey must not be {@literal null}. * @return can be {@literal null}. - * @see Redis Documentation: BRPOPLPUSH + * @see Redis Documentation: BRPOPLPUSH * @see #rPopLPush(byte[], byte[]) */ @Nullable diff --git a/src/main/java/org/springframework/data/redis/connection/RedisPubSubCommands.java b/src/main/java/org/springframework/data/redis/connection/RedisPubSubCommands.java index bd6f463323..fff1f65332 100644 --- a/src/main/java/org/springframework/data/redis/connection/RedisPubSubCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/RedisPubSubCommands.java @@ -47,7 +47,7 @@ public interface RedisPubSubCommands { * @param channel the channel to publish to. Must not be {@literal null}. * @param message message to publish. Must not be {@literal null}. * @return the number of clients that received the message or {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: PUBLISH + * @see Redis Documentation: PUBLISH */ @Nullable Long publish(byte[] channel, byte[] message); @@ -60,7 +60,7 @@ public interface RedisPubSubCommands { * * @param listener message listener, must not be {@literal null}. * @param channels channel names, must not be {@literal null}. - * @see Redis Documentation: SUBSCRIBE + * @see Redis Documentation: SUBSCRIBE */ void subscribe(MessageListener listener, byte[]... channels); @@ -73,7 +73,7 @@ public interface RedisPubSubCommands { * * @param listener message listener, must not be {@literal null}. * @param patterns channel name patterns, must not be {@literal null}. - * @see Redis Documentation: PSUBSCRIBE + * @see Redis Documentation: PSUBSCRIBE */ void pSubscribe(MessageListener listener, byte[]... patterns); } diff --git a/src/main/java/org/springframework/data/redis/connection/RedisScriptingCommands.java b/src/main/java/org/springframework/data/redis/connection/RedisScriptingCommands.java index d9decec605..6bf0bb86ef 100644 --- a/src/main/java/org/springframework/data/redis/connection/RedisScriptingCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/RedisScriptingCommands.java @@ -32,14 +32,14 @@ public interface RedisScriptingCommands { /** * Flush lua script cache. * - * @see Redis Documentation: SCRIPT FLUSH + * @see Redis Documentation: SCRIPT FLUSH */ void scriptFlush(); /** * Kill current lua script execution. * - * @see Redis Documentation: SCRIPT KILL + * @see Redis Documentation: SCRIPT KILL */ void scriptKill(); @@ -49,7 +49,7 @@ public interface RedisScriptingCommands { * * @param script must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SCRIPT LOAD + * @see Redis Documentation: SCRIPT LOAD */ @Nullable String scriptLoad(byte[] script); @@ -60,7 +60,7 @@ public interface RedisScriptingCommands { * @param scriptShas * @return one entry per given scriptSha in returned {@link List} or {@literal null} when used in pipeline / * transaction. - * @see Redis Documentation: SCRIPT EXISTS + * @see Redis Documentation: SCRIPT EXISTS */ @Nullable List scriptExists(String... scriptShas); @@ -73,7 +73,7 @@ public interface RedisScriptingCommands { * @param numKeys * @param keysAndArgs must not be {@literal null}. * @return script result. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: EVAL + * @see Redis Documentation: EVAL */ @Nullable T eval(byte[] script, ReturnType returnType, int numKeys, byte[]... keysAndArgs); @@ -86,7 +86,7 @@ public interface RedisScriptingCommands { * @param numKeys * @param keysAndArgs must not be {@literal null}. * @return script result. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: EVALSHA + * @see Redis Documentation: EVALSHA */ @Nullable T evalSha(String scriptSha, ReturnType returnType, int numKeys, byte[]... keysAndArgs); @@ -100,7 +100,7 @@ public interface RedisScriptingCommands { * @param keysAndArgs must not be {@literal null}. * @return script result. {@literal null} when used in pipeline / transaction. * @since 1.5 - * @see Redis Documentation: EVALSHA + * @see Redis Documentation: EVALSHA */ @Nullable T evalSha(byte[] scriptSha, ReturnType returnType, int numKeys, byte[]... keysAndArgs); diff --git a/src/main/java/org/springframework/data/redis/connection/RedisSentinelConfiguration.java b/src/main/java/org/springframework/data/redis/connection/RedisSentinelConfiguration.java index 0fa0100bd8..a1f33aa8ce 100644 --- a/src/main/java/org/springframework/data/redis/connection/RedisSentinelConfiguration.java +++ b/src/main/java/org/springframework/data/redis/connection/RedisSentinelConfiguration.java @@ -34,7 +34,7 @@ /** * Configuration class used for setting up {@link RedisConnection} via {@link RedisConnectionFactory} using connecting - * to Redis Sentinel(s). Useful when setting up a high availability Redis + * to Redis Sentinel(s). Useful when setting up a high availability Redis * environment. * * @author Christoph Strobl diff --git a/src/main/java/org/springframework/data/redis/connection/RedisServerCommands.java b/src/main/java/org/springframework/data/redis/connection/RedisServerCommands.java index 448694b477..f278dd37a2 100644 --- a/src/main/java/org/springframework/data/redis/connection/RedisServerCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/RedisServerCommands.java @@ -46,7 +46,7 @@ enum MigrateOption { * Start an {@literal Append Only File} rewrite process on server. * * @deprecated As of 1.3, use {@link #bgReWriteAof}. - * @see Redis Documentation: BGREWRITEAOF + * @see Redis Documentation: BGREWRITEAOF */ @Deprecated default void bgWriteAof() { @@ -57,14 +57,14 @@ default void bgWriteAof() { * Start an {@literal Append Only File} rewrite process on server. * * @since 1.3 - * @see Redis Documentation: BGREWRITEAOF + * @see Redis Documentation: BGREWRITEAOF */ void bgReWriteAof(); /** * Start background saving of db on server. * - * @see Redis Documentation: BGSAVE + * @see Redis Documentation: BGSAVE */ void bgSave(); @@ -72,7 +72,7 @@ default void bgWriteAof() { * Get time of last {@link #bgSave()} operation in seconds. * * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: LASTSAVE + * @see Redis Documentation: LASTSAVE */ @Nullable Long lastSave(); @@ -80,7 +80,7 @@ default void bgWriteAof() { /** * Synchronous save current db snapshot on server. * - * @see Redis Documentation: SAVE + * @see Redis Documentation: SAVE */ void save(); @@ -88,7 +88,7 @@ default void bgWriteAof() { * Get the total number of available keys in currently selected database. * * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: DBSIZE + * @see Redis Documentation: DBSIZE */ @Nullable Long dbSize(); @@ -96,14 +96,14 @@ default void bgWriteAof() { /** * Delete all keys of the currently selected database. * - * @see Redis Documentation: FLUSHDB + * @see Redis Documentation: FLUSHDB */ void flushDb(); /** * Delete all all keys from all databases. * - * @see Redis Documentation: FLUSHALL + * @see Redis Documentation: FLUSHALL */ void flushAll(); @@ -117,7 +117,7 @@ default void bgWriteAof() { *

* * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: INFO + * @see Redis Documentation: INFO */ @Nullable Properties info(); @@ -126,7 +126,7 @@ default void bgWriteAof() { * Load server information for given {@code selection}. * * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: INFO + * @see Redis Documentation: INFO */ @Nullable Properties info(String section); @@ -134,14 +134,14 @@ default void bgWriteAof() { /** * Shutdown server. * - * @see Redis Documentation: SHUTDOWN + * @see Redis Documentation: SHUTDOWN */ void shutdown(); /** * Shutdown server. * - * @see Redis Documentation: SHUTDOWN + * @see Redis Documentation: SHUTDOWN * @since 1.3 */ void shutdown(ShutdownOption option); @@ -151,7 +151,7 @@ default void bgWriteAof() { * * @param pattern must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: CONFIG GET + * @see Redis Documentation: CONFIG GET */ @Nullable Properties getConfig(String pattern); @@ -161,7 +161,7 @@ default void bgWriteAof() { * * @param param must not be {@literal null}. * @param value must not be {@literal null}. - * @see Redis Documentation: CONFIG SET + * @see Redis Documentation: CONFIG SET */ void setConfig(String param, String value); @@ -169,7 +169,7 @@ default void bgWriteAof() { * Reset statistic counters on server.
* Counters can be retrieved using {@link #info()}. * - * @see Redis Documentation: CONFIG RESETSTAT + * @see Redis Documentation: CONFIG RESETSTAT */ void resetConfigStats(); @@ -178,7 +178,7 @@ default void bgWriteAof() { * * @return current server time in milliseconds or {@literal null} when used in pipeline / transaction. * @since 1.1 - * @see Redis Documentation: TIME + * @see Redis Documentation: TIME */ @Nullable Long time(); @@ -189,7 +189,7 @@ default void bgWriteAof() { * @param host of connection to close. * @param port of connection to close * @since 1.3 - * @see Redis Documentation: CLIENT KILL + * @see Redis Documentation: CLIENT KILL */ void killClient(String host, int port); @@ -198,14 +198,14 @@ default void bgWriteAof() { * * @param name * @since 1.3 - * @see Redis Documentation: CLIENT SETNAME + * @see Redis Documentation: CLIENT SETNAME */ void setClientName(byte[] name); /** * Returns the name of the current connection. * - * @see Redis Documentation: CLIENT GETNAME + * @see Redis Documentation: CLIENT GETNAME * @return {@literal null} when used in pipeline / transaction. * @since 1.3 */ @@ -217,7 +217,7 @@ default void bgWriteAof() { * * @return {@link List} of {@link RedisClientInfo} objects or {@literal null} when used in pipeline / transaction. * @since 1.3 - * @see Redis Documentation: CLIENT LIST + * @see Redis Documentation: CLIENT LIST */ @Nullable List getClientList(); @@ -228,7 +228,7 @@ default void bgWriteAof() { * @param host must not be {@literal null}. * @param port * @since 1.3 - * @see Redis Documentation: SLAVEOF + * @see Redis Documentation: SLAVEOF */ void slaveOf(String host, int port); @@ -236,7 +236,7 @@ default void bgWriteAof() { * Change server into master. * * @since 1.3 - * @see Redis Documentation: SLAVEOF + * @see Redis Documentation: SLAVEOF */ void slaveOfNoOne(); @@ -249,7 +249,7 @@ default void bgWriteAof() { * @param dbIndex * @param option can be {@literal null}. Defaulted to {@link MigrateOption#COPY}. * @since 1.7 - * @see Redis Documentation: MIGRATE + * @see Redis Documentation: MIGRATE */ void migrate(byte[] key, RedisNode target, int dbIndex, @Nullable MigrateOption option); @@ -263,7 +263,7 @@ default void bgWriteAof() { * @param option can be {@literal null}. Defaulted to {@link MigrateOption#COPY}. * @param timeout * @since 1.7 - * @see Redis Documentation: MIGRATE + * @see Redis Documentation: MIGRATE */ void migrate(byte[] key, RedisNode target, int dbIndex, @Nullable MigrateOption option, long timeout); } diff --git a/src/main/java/org/springframework/data/redis/connection/RedisSetCommands.java b/src/main/java/org/springframework/data/redis/connection/RedisSetCommands.java index 41e0ae049b..f7ae920d78 100644 --- a/src/main/java/org/springframework/data/redis/connection/RedisSetCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/RedisSetCommands.java @@ -37,7 +37,7 @@ public interface RedisSetCommands { * @param key must not be {@literal null}. * @param values must not be empty. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SADD + * @see Redis Documentation: SADD */ @Nullable Long sAdd(byte[] key, byte[]... values); @@ -48,7 +48,7 @@ public interface RedisSetCommands { * @param key must not be {@literal null}. * @param values must not be empty. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SREM + * @see Redis Documentation: SREM */ @Nullable Long sRem(byte[] key, byte[]... values); @@ -58,7 +58,7 @@ public interface RedisSetCommands { * * @param key must not be {@literal null}. * @return {@literal null} when key does not exist or used in pipeline / transaction. - * @see Redis Documentation: SPOP + * @see Redis Documentation: SPOP */ @Nullable byte[] sPop(byte[] key); @@ -69,7 +69,7 @@ public interface RedisSetCommands { * @param key must not be {@literal null}. * @param count number of random members to pop from the set. * @return empty {@link List} if set does not exist. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SPOP + * @see Redis Documentation: SPOP * @since 2.0 */ @Nullable @@ -82,7 +82,7 @@ public interface RedisSetCommands { * @param destKey must not be {@literal null}. * @param value must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SMOVE + * @see Redis Documentation: SMOVE */ @Nullable Boolean sMove(byte[] srcKey, byte[] destKey, byte[] value); @@ -92,7 +92,7 @@ public interface RedisSetCommands { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SCARD + * @see Redis Documentation: SCARD */ @Nullable Long sCard(byte[] key); @@ -103,7 +103,7 @@ public interface RedisSetCommands { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SISMEMBER + * @see Redis Documentation: SISMEMBER */ @Nullable Boolean sIsMember(byte[] key, byte[] value); @@ -113,7 +113,7 @@ public interface RedisSetCommands { * * @param keys must not be {@literal null}. * @return empty {@link Set} if no intersection found. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SINTER + * @see Redis Documentation: SINTER */ @Nullable Set sInter(byte[]... keys); @@ -124,7 +124,7 @@ public interface RedisSetCommands { * @param destKey must not be {@literal null}. * @param keys must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SINTERSTORE + * @see Redis Documentation: SINTERSTORE */ @Nullable Long sInterStore(byte[] destKey, byte[]... keys); @@ -134,7 +134,7 @@ public interface RedisSetCommands { * * @param keys must not be {@literal null}. * @return empty {@link Set} if keys do not exist. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SUNION + * @see Redis Documentation: SUNION */ @Nullable Set sUnion(byte[]... keys); @@ -145,7 +145,7 @@ public interface RedisSetCommands { * @param destKey must not be {@literal null}. * @param keys must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SUNIONSTORE + * @see Redis Documentation: SUNIONSTORE */ @Nullable Long sUnionStore(byte[] destKey, byte[]... keys); @@ -155,7 +155,7 @@ public interface RedisSetCommands { * * @param keys must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SDIFF + * @see Redis Documentation: SDIFF */ @Nullable Set sDiff(byte[]... keys); @@ -166,7 +166,7 @@ public interface RedisSetCommands { * @param destKey must not be {@literal null}. * @param keys must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SDIFFSTORE + * @see Redis Documentation: SDIFFSTORE */ @Nullable Long sDiffStore(byte[] destKey, byte[]... keys); @@ -176,7 +176,7 @@ public interface RedisSetCommands { * * @param key must not be {@literal null}. * @return empty {@link Set} when key does not exist. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SMEMBERS + * @see Redis Documentation: SMEMBERS */ @Nullable Set sMembers(byte[] key); @@ -186,7 +186,7 @@ public interface RedisSetCommands { * * @param key must not be {@literal null}. * @return can be {@literal null}. - * @see Redis Documentation: SRANDMEMBER + * @see Redis Documentation: SRANDMEMBER */ @Nullable byte[] sRandMember(byte[] key); @@ -197,7 +197,7 @@ public interface RedisSetCommands { * @param key must not be {@literal null}. * @param count * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SRANDMEMBER + * @see Redis Documentation: SRANDMEMBER */ @Nullable List sRandMember(byte[] key, long count); @@ -209,7 +209,7 @@ public interface RedisSetCommands { * @param options must not be {@literal null}. * @return never {@literal null}. * @since 1.4 - * @see Redis Documentation: SCAN + * @see Redis Documentation: SCAN */ Cursor sScan(byte[] key, ScanOptions options); } diff --git a/src/main/java/org/springframework/data/redis/connection/RedisSocketConfiguration.java b/src/main/java/org/springframework/data/redis/connection/RedisSocketConfiguration.java index 024fac9527..389c199940 100644 --- a/src/main/java/org/springframework/data/redis/connection/RedisSocketConfiguration.java +++ b/src/main/java/org/springframework/data/redis/connection/RedisSocketConfiguration.java @@ -20,7 +20,7 @@ /** * Configuration class used for setting up {@link RedisConnection} via {@link RedisConnectionFactory} connecting to - * single Redis using a local unix domain socket. + * single Redis using a local unix domain socket. * * @author Mark Paluch * @author Christoph Strobl diff --git a/src/main/java/org/springframework/data/redis/connection/RedisStandaloneConfiguration.java b/src/main/java/org/springframework/data/redis/connection/RedisStandaloneConfiguration.java index 60e34feeec..b1490751e8 100644 --- a/src/main/java/org/springframework/data/redis/connection/RedisStandaloneConfiguration.java +++ b/src/main/java/org/springframework/data/redis/connection/RedisStandaloneConfiguration.java @@ -22,7 +22,7 @@ /** * Configuration class used for setting up {@link RedisConnection} via {@link RedisConnectionFactory} using connecting - * to a single node Redis installation. + * to a single node Redis installation. * * @author Mark Paluch * @author Christoph Strobl diff --git a/src/main/java/org/springframework/data/redis/connection/RedisStreamCommands.java b/src/main/java/org/springframework/data/redis/connection/RedisStreamCommands.java index 7f014b02a3..8d347db5e3 100644 --- a/src/main/java/org/springframework/data/redis/connection/RedisStreamCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/RedisStreamCommands.java @@ -41,7 +41,7 @@ public interface RedisStreamCommands { * @param group name of the consumer group. * @param recordIds the String representation of the {@literal id's} of the records to acknowledge. * @return length of acknowledged messages. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XACK + * @see Redis Documentation: XACK */ @Nullable default Long xAck(byte[] key, String group, String... recordIds) { @@ -55,7 +55,7 @@ default Long xAck(byte[] key, String group, String... recordIds) { * @param group name of the consumer group. * @param recordIds the {@literal id's} of the records to acknowledge. * @return length of acknowledged messages. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XACK + * @see Redis Documentation: XACK */ @Nullable Long xAck(byte[] key, String group, RecordId... recordIds); @@ -66,7 +66,7 @@ default Long xAck(byte[] key, String group, String... recordIds) { * @param key the {@literal key} the stream is stored at. * @param content the records content modeled as {@link Map field/value pairs}. * @return the server generated {@link RecordId id}. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XADD + * @see Redis Documentation: XADD */ @Nullable default RecordId xAdd(byte[] key, Map content) { @@ -90,7 +90,7 @@ default RecordId xAdd(byte[] key, Map content) { * @param key the {@literal key} the stream is stored at. * @param recordIds the id's of the records to remove. * @return number of removed entries. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XDEL + * @see Redis Documentation: XDEL */ @Nullable default Long xDel(byte[] key, String... recordIds) { @@ -104,7 +104,7 @@ default Long xDel(byte[] key, String... recordIds) { * @param key the {@literal key} the stream is stored at. * @param recordIds the id's of the records to remove. * @return number of removed entries. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XDEL + * @see Redis Documentation: XDEL */ Long xDel(byte[] key, RecordId... recordIds); @@ -157,7 +157,7 @@ default Boolean xGroupDelConsumer(byte[] key, String groupName, String consumerN * * @param key the {@literal key} the stream is stored at. * @return length of the stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XLEN + * @see Redis Documentation: XLEN */ @Nullable Long xLen(byte[] key); @@ -170,7 +170,7 @@ default Boolean xGroupDelConsumer(byte[] key, String groupName, String consumerN * @param key the {@literal key} the stream is stored at. * @param range must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XRANGE + * @see Redis Documentation: XRANGE */ @Nullable default List xRange(byte[] key, Range range) { @@ -187,7 +187,7 @@ default List xRange(byte[] key, Range range) { * @param range must not be {@literal null}. * @param limit must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XRANGE + * @see Redis Documentation: XRANGE */ @Nullable List xRange(byte[] key, Range range, Limit limit); @@ -197,7 +197,7 @@ default List xRange(byte[] key, Range range) { * * @param streams the streams to read from. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XREAD + * @see Redis Documentation: XREAD */ @Nullable default List xRead(StreamOffset... streams) { @@ -210,7 +210,7 @@ default List xRead(StreamOffset... streams) { * @param readOptions read arguments. * @param streams the streams to read from. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XREAD + * @see Redis Documentation: XREAD */ @Nullable List xRead(StreamReadOptions readOptions, StreamOffset... streams); @@ -221,7 +221,7 @@ default List xRead(StreamOffset... streams) { * @param consumer consumer/group. * @param streams the streams to read from. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XREADGROUP + * @see Redis Documentation: XREADGROUP */ @Nullable default List xReadGroup(Consumer consumer, StreamOffset... streams) { @@ -235,7 +235,7 @@ default List xReadGroup(Consumer consumer, StreamOffset... s * @param readOptions read arguments. * @param streams the streams to read from. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XREADGROUP + * @see Redis Documentation: XREADGROUP */ @Nullable List xReadGroup(Consumer consumer, StreamReadOptions readOptions, StreamOffset... streams); @@ -246,7 +246,7 @@ default List xReadGroup(Consumer consumer, StreamOffset... s * @param key the stream key. * @param range must not be {@literal null}. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XREVRANGE + * @see Redis Documentation: XREVRANGE */ @Nullable default List xRevRange(byte[] key, Range range) { @@ -260,7 +260,7 @@ default List xRevRange(byte[] key, Range range) { * @param range must not be {@literal null}. * @param limit must not be {@literal null}. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XREVRANGE + * @see Redis Documentation: XREVRANGE */ @Nullable List xRevRange(byte[] key, Range range, Limit limit); @@ -271,7 +271,7 @@ default List xRevRange(byte[] key, Range range) { * @param key the stream key. * @param count length of the stream. * @return number of removed entries. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XTRIM + * @see Redis Documentation: XTRIM */ @Nullable Long xTrim(byte[] key, long count); diff --git a/src/main/java/org/springframework/data/redis/connection/RedisStringCommands.java b/src/main/java/org/springframework/data/redis/connection/RedisStringCommands.java index c87782d664..ff715f8744 100644 --- a/src/main/java/org/springframework/data/redis/connection/RedisStringCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/RedisStringCommands.java @@ -40,7 +40,7 @@ enum BitOperation { * * @param key must not be {@literal null}. * @return {@literal null} when key does not exist or used in pipeline / transaction. - * @see Redis Documentation: GET + * @see Redis Documentation: GET */ @Nullable byte[] get(byte[] key); @@ -51,7 +51,7 @@ enum BitOperation { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return {@literal null} if key did not exist before or when used in pipeline / transaction. - * @see Redis Documentation: GETSET + * @see Redis Documentation: GETSET */ @Nullable byte[] getSet(byte[] key, byte[] value); @@ -61,7 +61,7 @@ enum BitOperation { * * @param keys must not be {@literal null}. * @return empty {@link List} if keys do not exist or when used in pipeline / transaction. - * @see Redis Documentation: MGET + * @see Redis Documentation: MGET */ @Nullable List mGet(byte[]... keys); @@ -72,7 +72,7 @@ enum BitOperation { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SET + * @see Redis Documentation: SET */ @Nullable Boolean set(byte[] key, byte[] value); @@ -87,7 +87,7 @@ enum BitOperation { * @param option must not be {@literal null}. Use {@link SetOption#upsert()} to add non existing. * @return {@literal null} when used in pipeline / transaction. * @since 1.7 - * @see Redis Documentation: SET + * @see Redis Documentation: SET */ @Nullable Boolean set(byte[] key, byte[] value, Expiration expiration, SetOption option); @@ -98,7 +98,7 @@ enum BitOperation { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SETNX + * @see Redis Documentation: SETNX */ @Nullable Boolean setNX(byte[] key, byte[] value); @@ -110,7 +110,7 @@ enum BitOperation { * @param seconds * @param value must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SETEX + * @see Redis Documentation: SETEX */ @Nullable Boolean setEx(byte[] key, long seconds, byte[] value); @@ -123,7 +123,7 @@ enum BitOperation { * @param value must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 1.3 - * @see Redis Documentation: PSETEX + * @see Redis Documentation: PSETEX */ @Nullable Boolean pSetEx(byte[] key, long milliseconds, byte[] value); @@ -133,7 +133,7 @@ enum BitOperation { * * @param tuple must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: MSET + * @see Redis Documentation: MSET */ @Nullable Boolean mSet(Map tuple); @@ -144,7 +144,7 @@ enum BitOperation { * * @param tuple must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: MSETNX + * @see Redis Documentation: MSETNX */ @Nullable Boolean mSetNX(Map tuple); @@ -154,7 +154,7 @@ enum BitOperation { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: INCR + * @see Redis Documentation: INCR */ @Nullable Long incr(byte[] key); @@ -165,7 +165,7 @@ enum BitOperation { * @param key must not be {@literal null}. * @param value * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: INCRBY + * @see Redis Documentation: INCRBY */ @Nullable Long incrBy(byte[] key, long value); @@ -176,7 +176,7 @@ enum BitOperation { * @param key must not be {@literal null}. * @param value * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: INCRBYFLOAT + * @see Redis Documentation: INCRBYFLOAT */ @Nullable Double incrBy(byte[] key, double value); @@ -186,7 +186,7 @@ enum BitOperation { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: DECR + * @see Redis Documentation: DECR */ @Nullable Long decr(byte[] key); @@ -197,7 +197,7 @@ enum BitOperation { * @param key must not be {@literal null}. * @param value * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: DECRBY + * @see Redis Documentation: DECRBY */ @Nullable Long decrBy(byte[] key, long value); @@ -208,7 +208,7 @@ enum BitOperation { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: APPEND + * @see Redis Documentation: APPEND */ @Nullable Long append(byte[] key, byte[] value); @@ -220,7 +220,7 @@ enum BitOperation { * @param start * @param end * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GETRANGE + * @see Redis Documentation: GETRANGE */ @Nullable byte[] getRange(byte[] key, long start, long end); @@ -231,7 +231,7 @@ enum BitOperation { * @param key must not be {@literal null}. * @param value * @param offset - * @see Redis Documentation: SETRANGE + * @see Redis Documentation: SETRANGE */ void setRange(byte[] key, byte[] value, long offset); @@ -241,7 +241,7 @@ enum BitOperation { * @param key must not be {@literal null}. * @param offset * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GETBIT + * @see Redis Documentation: GETBIT */ @Nullable Boolean getBit(byte[] key, long offset); @@ -253,7 +253,7 @@ enum BitOperation { * @param offset * @param value * @return the original bit value stored at {@code offset} or {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SETBIT + * @see Redis Documentation: SETBIT */ @Nullable Boolean setBit(byte[] key, long offset, boolean value); @@ -263,7 +263,7 @@ enum BitOperation { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: BITCOUNT + * @see Redis Documentation: BITCOUNT */ @Nullable Long bitCount(byte[] key); @@ -276,7 +276,7 @@ enum BitOperation { * @param start * @param end * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: BITCOUNT + * @see Redis Documentation: BITCOUNT */ @Nullable Long bitCount(byte[] key, long start, long end); @@ -300,7 +300,7 @@ enum BitOperation { * @param destination must not be {@literal null}. * @param keys must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: BITOP + * @see Redis Documentation: BITOP */ @Nullable Long bitOp(BitOperation op, byte[] destination, byte[]... keys); @@ -312,7 +312,7 @@ enum BitOperation { * @param bit the bit value to look for. * @return {@literal null} when used in pipeline / transaction. The position of the first bit set to 1 or 0 according * to the request. - * @see Redis Documentation: BITPOS + * @see Redis Documentation: BITPOS * @since 2.1 */ @Nullable @@ -330,7 +330,7 @@ default Long bitPos(byte[] key, boolean bit) { * @param range must not be {@literal null}. Use {@link Range#unbounded()} to not limit search. * @return {@literal null} when used in pipeline / transaction. The position of the first bit set to 1 or 0 according * to the request. - * @see Redis Documentation: BITPOS + * @see Redis Documentation: BITPOS * @since 2.1 */ @Nullable @@ -341,7 +341,7 @@ default Long bitPos(byte[] key, boolean bit) { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: STRLEN + * @see Redis Documentation: STRLEN */ @Nullable Long strLen(byte[] key); diff --git a/src/main/java/org/springframework/data/redis/connection/RedisTxCommands.java b/src/main/java/org/springframework/data/redis/connection/RedisTxCommands.java index 42988b2b75..78d7d93a97 100644 --- a/src/main/java/org/springframework/data/redis/connection/RedisTxCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/RedisTxCommands.java @@ -31,7 +31,7 @@ public interface RedisTxCommands { * Commands will be queued and can then be executed by calling {@link #exec()} or rolled back using {@link #discard()} *

* - * @see Redis Documentation: MULTI + * @see Redis Documentation: MULTI */ void multi(); @@ -40,14 +40,14 @@ public interface RedisTxCommands { * If used along with {@link #watch(byte[]...)} the operation will fail if any of watched keys has been modified. * * @return List of replies for each executed command. - * @see Redis Documentation: EXEC + * @see Redis Documentation: EXEC */ List exec(); /** * Discard all commands issued after {@link #multi()}. * - * @see Redis Documentation: DISCARD + * @see Redis Documentation: DISCARD */ void discard(); @@ -55,14 +55,14 @@ public interface RedisTxCommands { * Watch given {@code keys} for modifications during transaction started with {@link #multi()}. * * @param keys must not be {@literal null}. - * @see Redis Documentation: WATCH + * @see Redis Documentation: WATCH */ void watch(byte[]... keys); /** * Flushes all the previously {@link #watch(byte[]...)} keys. * - * @see Redis Documentation: UNWATCH + * @see Redis Documentation: UNWATCH */ void unwatch(); } diff --git a/src/main/java/org/springframework/data/redis/connection/RedisZSetCommands.java b/src/main/java/org/springframework/data/redis/connection/RedisZSetCommands.java index b058f60874..64cd69c12a 100644 --- a/src/main/java/org/springframework/data/redis/connection/RedisZSetCommands.java +++ b/src/main/java/org/springframework/data/redis/connection/RedisZSetCommands.java @@ -402,7 +402,7 @@ public static Limit unlimited() { * @param score the score. * @param value the value. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZADD + * @see Redis Documentation: ZADD */ @Nullable Boolean zAdd(byte[] key, double score, byte[] value); @@ -413,7 +413,7 @@ public static Limit unlimited() { * @param key must not be {@literal null}. * @param tuples must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZADD + * @see Redis Documentation: ZADD */ @Nullable Long zAdd(byte[] key, Set tuples); @@ -424,7 +424,7 @@ public static Limit unlimited() { * @param key must not be {@literal null}. * @param values must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREM + * @see Redis Documentation: ZREM */ @Nullable Long zRem(byte[] key, byte[]... values); @@ -436,7 +436,7 @@ public static Limit unlimited() { * @param increment * @param value the value. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZINCRBY + * @see Redis Documentation: ZINCRBY */ @Nullable Double zIncrBy(byte[] key, double increment, byte[] value); @@ -447,7 +447,7 @@ public static Limit unlimited() { * @param key must not be {@literal null}. * @param value the value. Must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZRANK + * @see Redis Documentation: ZRANK */ @Nullable Long zRank(byte[] key, byte[] value); @@ -458,7 +458,7 @@ public static Limit unlimited() { * @param key must not be {@literal null}. * @param value the value. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREVRANK + * @see Redis Documentation: ZREVRANK */ @Nullable Long zRevRank(byte[] key, byte[] value); @@ -471,7 +471,7 @@ public static Limit unlimited() { * @param end * @return empty {@link Set} when key does not exists or no members in range. {@literal null} when used in pipeline / * transaction. - * @see Redis Documentation: ZRANGE + * @see Redis Documentation: ZRANGE */ @Nullable Set zRange(byte[] key, long start, long end); @@ -484,7 +484,7 @@ public static Limit unlimited() { * @param end * @return empty {@link Set} when key does not exists or no members in range. {@literal null} when used in pipeline / * transaction. - * @see Redis Documentation: ZRANGE + * @see Redis Documentation: ZRANGE */ @Nullable Set zRangeWithScores(byte[] key, long start, long end); @@ -497,7 +497,7 @@ public static Limit unlimited() { * @param max * @return empty {@link Set} when key does not exists or no members in range. {@literal null} when used in pipeline / * transaction. - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE */ @Nullable default Set zRangeByScore(byte[] key, double min, double max) { @@ -512,7 +512,7 @@ default Set zRangeByScore(byte[] key, double min, double max) { * @return empty {@link Set} when key does not exists or no members in range. {@literal null} when used in pipeline / * transaction. * @since 1.6 - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE */ @Nullable default Set zRangeByScoreWithScores(byte[] key, Range range) { @@ -527,7 +527,7 @@ default Set zRangeByScoreWithScores(byte[] key, Range range) { * @param max * @return empty {@link Set} when key does not exists or no members in range. {@literal null} when used in pipeline / * transaction. - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE */ @Nullable default Set zRangeByScoreWithScores(byte[] key, double min, double max) { @@ -545,7 +545,7 @@ default Set zRangeByScoreWithScores(byte[] key, double min, double max) { * @param count * @return empty {@link Set} when key does not exists or no members in range. {@literal null} when used in pipeline / * transaction. - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE */ @Nullable default Set zRangeByScore(byte[] key, double min, double max, long offset, long count) { @@ -564,7 +564,7 @@ default Set zRangeByScore(byte[] key, double min, double max, long offse * @param count * @return empty {@link Set} when key does not exists or no members in range. {@literal null} when used in pipeline / * transaction. - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE */ @Nullable default Set zRangeByScoreWithScores(byte[] key, double min, double max, long offset, long count) { @@ -582,7 +582,7 @@ default Set zRangeByScoreWithScores(byte[] key, double min, double max, l * @return empty {@link Set} when key does not exists or no members in range. {@literal null} when used in pipeline / * transaction. * @since 1.6 - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE */ @Nullable Set zRangeByScoreWithScores(byte[] key, Range range, Limit limit); @@ -595,7 +595,7 @@ default Set zRangeByScoreWithScores(byte[] key, double min, double max, l * @param end * @return empty {@link Set} when key does not exists or no members in range. {@literal null} when used in pipeline / * transaction. - * @see Redis Documentation: ZREVRANGE + * @see Redis Documentation: ZREVRANGE */ @Nullable Set zRevRange(byte[] key, long start, long end); @@ -608,7 +608,7 @@ default Set zRangeByScoreWithScores(byte[] key, double min, double max, l * @param end * @return empty {@link Set} when key does not exists or no members in range. {@literal null} when used in pipeline / * transaction. - * @see Redis Documentation: ZREVRANGE + * @see Redis Documentation: ZREVRANGE */ @Nullable Set zRevRangeWithScores(byte[] key, long start, long end); @@ -621,7 +621,7 @@ default Set zRangeByScoreWithScores(byte[] key, double min, double max, l * @param max * @return empty {@link Set} when key does not exists or no members in range. {@literal null} when used in pipeline / * transaction. - * @see Redis Documentation: ZREVRANGE + * @see Redis Documentation: ZREVRANGE */ @Nullable default Set zRevRangeByScore(byte[] key, double min, double max) { @@ -637,7 +637,7 @@ default Set zRevRangeByScore(byte[] key, double min, double max) { * @return empty {@link Set} when key does not exists or no members in range. {@literal null} when used in pipeline / * transaction. * @since 1.6 - * @see Redis Documentation: ZREVRANGEBYSCORE + * @see Redis Documentation: ZREVRANGEBYSCORE */ @Nullable default Set zRevRangeByScore(byte[] key, Range range) { @@ -653,7 +653,7 @@ default Set zRevRangeByScore(byte[] key, Range range) { * @param max * @return empty {@link Set} when key does not exists or no members in range. {@literal null} when used in pipeline / * transaction. - * @see Redis Documentation: ZREVRANGEBYSCORE + * @see Redis Documentation: ZREVRANGEBYSCORE */ @Nullable default Set zRevRangeByScoreWithScores(byte[] key, double min, double max) { @@ -670,7 +670,7 @@ default Set zRevRangeByScoreWithScores(byte[] key, double min, double max * @param offset * @param count * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREVRANGEBYSCORE + * @see Redis Documentation: ZREVRANGEBYSCORE */ @Nullable default Set zRevRangeByScore(byte[] key, double min, double max, long offset, long count) { @@ -688,7 +688,7 @@ default Set zRevRangeByScore(byte[] key, double min, double max, long of * @param limit must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 1.6 - * @see Redis Documentation: ZREVRANGEBYSCORE + * @see Redis Documentation: ZREVRANGEBYSCORE */ @Nullable Set zRevRangeByScore(byte[] key, Range range, Limit limit); @@ -703,7 +703,7 @@ default Set zRevRangeByScore(byte[] key, double min, double max, long of * @param offset * @param count * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREVRANGEBYSCORE + * @see Redis Documentation: ZREVRANGEBYSCORE */ @Nullable default Set zRevRangeByScoreWithScores(byte[] key, double min, double max, long offset, long count) { @@ -720,7 +720,7 @@ default Set zRevRangeByScoreWithScores(byte[] key, double min, double max * @param range must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 1.6 - * @see Redis Documentation: ZREVRANGEBYSCORE + * @see Redis Documentation: ZREVRANGEBYSCORE */ @Nullable default Set zRevRangeByScoreWithScores(byte[] key, Range range) { @@ -736,7 +736,7 @@ default Set zRevRangeByScoreWithScores(byte[] key, Range range) { * @param limit must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 1.6 - * @see Redis Documentation: ZREVRANGEBYSCORE + * @see Redis Documentation: ZREVRANGEBYSCORE */ @Nullable Set zRevRangeByScoreWithScores(byte[] key, Range range, Limit limit); @@ -748,7 +748,7 @@ default Set zRevRangeByScoreWithScores(byte[] key, Range range) { * @param min * @param max * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZCOUNT + * @see Redis Documentation: ZCOUNT */ @Nullable default Long zCount(byte[] key, double min, double max) { @@ -762,7 +762,7 @@ default Long zCount(byte[] key, double min, double max) { * @param range must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 1.6 - * @see Redis Documentation: ZCOUNT + * @see Redis Documentation: ZCOUNT */ @Nullable Long zCount(byte[] key, Range range); @@ -772,7 +772,7 @@ default Long zCount(byte[] key, double min, double max) { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZCARD + * @see Redis Documentation: ZCARD */ @Nullable Long zCard(byte[] key); @@ -783,7 +783,7 @@ default Long zCount(byte[] key, double min, double max) { * @param key must not be {@literal null}. * @param value the value. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZSCORE + * @see Redis Documentation: ZSCORE */ @Nullable Double zScore(byte[] key, byte[] value); @@ -795,7 +795,7 @@ default Long zCount(byte[] key, double min, double max) { * @param start * @param end * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREMRANGEBYRANK + * @see Redis Documentation: ZREMRANGEBYRANK */ @Nullable Long zRemRange(byte[] key, long start, long end); @@ -807,7 +807,7 @@ default Long zCount(byte[] key, double min, double max) { * @param min * @param max * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREMRANGEBYSCORE + * @see Redis Documentation: ZREMRANGEBYSCORE */ @Nullable default Long zRemRangeByScore(byte[] key, double min, double max) { @@ -821,7 +821,7 @@ default Long zRemRangeByScore(byte[] key, double min, double max) { * @param range must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 1.6 - * @see Redis Documentation: ZREMRANGEBYSCORE + * @see Redis Documentation: ZREMRANGEBYSCORE */ @Nullable Long zRemRangeByScore(byte[] key, Range range); @@ -832,7 +832,7 @@ default Long zRemRangeByScore(byte[] key, double min, double max) { * @param destKey must not be {@literal null}. * @param sets must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZUNIONSTORE + * @see Redis Documentation: ZUNIONSTORE */ @Nullable Long zUnionStore(byte[] destKey, byte[]... sets); @@ -845,7 +845,7 @@ default Long zRemRangeByScore(byte[] key, double min, double max) { * @param weights must not be {@literal null}. * @param sets must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZUNIONSTORE + * @see Redis Documentation: ZUNIONSTORE */ @Nullable default Long zUnionStore(byte[] destKey, Aggregate aggregate, int[] weights, byte[]... sets) { @@ -861,7 +861,7 @@ default Long zUnionStore(byte[] destKey, Aggregate aggregate, int[] weights, byt * @param sets must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 2.1 - * @see Redis Documentation: ZUNIONSTORE + * @see Redis Documentation: ZUNIONSTORE */ @Nullable Long zUnionStore(byte[] destKey, Aggregate aggregate, Weights weights, byte[]... sets); @@ -872,7 +872,7 @@ default Long zUnionStore(byte[] destKey, Aggregate aggregate, int[] weights, byt * @param destKey must not be {@literal null}. * @param sets must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZINTERSTORE + * @see Redis Documentation: ZINTERSTORE */ @Nullable Long zInterStore(byte[] destKey, byte[]... sets); @@ -885,7 +885,7 @@ default Long zUnionStore(byte[] destKey, Aggregate aggregate, int[] weights, byt * @param weights * @param sets must not be {@literal null}. * @return - * @see Redis Documentation: ZINTERSTORE + * @see Redis Documentation: ZINTERSTORE */ @Nullable default Long zInterStore(byte[] destKey, Aggregate aggregate, int[] weights, byte[]... sets) { @@ -901,7 +901,7 @@ default Long zInterStore(byte[] destKey, Aggregate aggregate, int[] weights, byt * @param sets must not be {@literal null}. * @return * @since 2.1 - * @see Redis Documentation: ZINTERSTORE + * @see Redis Documentation: ZINTERSTORE */ @Nullable Long zInterStore(byte[] destKey, Aggregate aggregate, Weights weights, byte[]... sets); @@ -913,7 +913,7 @@ default Long zInterStore(byte[] destKey, Aggregate aggregate, int[] weights, byt * @param options must not be {@literal null}. * @return * @since 1.4 - * @see Redis Documentation: ZSCAN + * @see Redis Documentation: ZSCAN */ Cursor zScan(byte[] key, ScanOptions options); @@ -925,7 +925,7 @@ default Long zInterStore(byte[] destKey, Aggregate aggregate, int[] weights, byt * @param max * @return {@literal null} when used in pipeline / transaction. * @since 1.5 - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE */ @Nullable default Set zRangeByScore(byte[] key, String min, String max) { @@ -939,7 +939,7 @@ default Set zRangeByScore(byte[] key, String min, String max) { * @param range must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 1.6 - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE */ @Nullable default Set zRangeByScore(byte[] key, Range range) { @@ -957,7 +957,7 @@ default Set zRangeByScore(byte[] key, Range range) { * @param count * @return {@literal null} when used in pipeline / transaction. * @since 1.5 - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE */ @Nullable Set zRangeByScore(byte[] key, String min, String max, long offset, long count); @@ -971,7 +971,7 @@ default Set zRangeByScore(byte[] key, Range range) { * @param limit must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 1.6 - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE */ @Nullable Set zRangeByScore(byte[] key, Range range, Limit limit); @@ -982,7 +982,7 @@ default Set zRangeByScore(byte[] key, Range range) { * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 1.6 - * @see Redis Documentation: ZRANGEBYLEX + * @see Redis Documentation: ZRANGEBYLEX */ @Nullable default Set zRangeByLex(byte[] key) { @@ -996,7 +996,7 @@ default Set zRangeByLex(byte[] key) { * @param range must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 1.6 - * @see Redis Documentation: ZRANGEBYLEX + * @see Redis Documentation: ZRANGEBYLEX */ @Nullable default Set zRangeByLex(byte[] key, Range range) { @@ -1012,7 +1012,7 @@ default Set zRangeByLex(byte[] key, Range range) { * @param limit must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 1.6 - * @see Redis Documentation: ZRANGEBYLEX + * @see Redis Documentation: ZRANGEBYLEX */ @Nullable Set zRangeByLex(byte[] key, Range range, Limit limit); diff --git a/src/main/java/org/springframework/data/redis/connection/StringRedisConnection.java b/src/main/java/org/springframework/data/redis/connection/StringRedisConnection.java index 8fd448cd3b..eeaad40372 100644 --- a/src/main/java/org/springframework/data/redis/connection/StringRedisConnection.java +++ b/src/main/java/org/springframework/data/redis/connection/StringRedisConnection.java @@ -95,7 +95,7 @@ interface StringTuple extends Tuple { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: EXISTS + * @see Redis Documentation: EXISTS * @see RedisKeyCommands#exists(byte[]) */ Boolean exists(String key); @@ -105,7 +105,7 @@ interface StringTuple extends Tuple { * * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: EXISTS + * @see Redis Documentation: EXISTS * @see RedisKeyCommands#exists(byte[][]) * @since 2.1 */ @@ -117,7 +117,7 @@ interface StringTuple extends Tuple { * * @param keys must not be {@literal null}. * @return The number of keys that were removed. - * @see Redis Documentation: DEL + * @see Redis Documentation: DEL * @see RedisKeyCommands#del(byte[]...) */ Long del(String... keys); @@ -128,7 +128,7 @@ interface StringTuple extends Tuple { * * @param keys must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: UNLINK + * @see Redis Documentation: UNLINK * @since 2.1 */ @Nullable @@ -139,7 +139,7 @@ interface StringTuple extends Tuple { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: TYPE + * @see Redis Documentation: TYPE * @see RedisKeyCommands#type(byte[]) */ DataType type(String key); @@ -149,7 +149,7 @@ interface StringTuple extends Tuple { * * @param keys must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: TOUCH + * @see Redis Documentation: TOUCH * @since 2.1 */ @Nullable @@ -160,7 +160,7 @@ interface StringTuple extends Tuple { * * @param pattern must not be {@literal null}. * @return - * @see Redis Documentation: KEYS + * @see Redis Documentation: KEYS * @see RedisKeyCommands#keys(byte[]) */ Collection keys(String pattern); @@ -170,7 +170,7 @@ interface StringTuple extends Tuple { * * @param oldName must not be {@literal null}. * @param newName must not be {@literal null}. - * @see Redis Documentation: RENAME + * @see Redis Documentation: RENAME * @see RedisKeyCommands#rename(byte[], byte[]) */ void rename(String oldName, String newName); @@ -181,7 +181,7 @@ interface StringTuple extends Tuple { * @param oldName must not be {@literal null}. * @param newName must not be {@literal null}. * @return - * @see Redis Documentation: RENAMENX + * @see Redis Documentation: RENAMENX * @see RedisKeyCommands#renameNX(byte[], byte[]) */ Boolean renameNX(String oldName, String newName); @@ -192,7 +192,7 @@ interface StringTuple extends Tuple { * @param key must not be {@literal null}. * @param seconds * @return - * @see Redis Documentation: EXPIRE + * @see Redis Documentation: EXPIRE * @see RedisKeyCommands#expire(byte[], long) */ Boolean expire(String key, long seconds); @@ -203,7 +203,7 @@ interface StringTuple extends Tuple { * @param key must not be {@literal null}. * @param millis * @return - * @see Redis Documentation: PEXPIRE + * @see Redis Documentation: PEXPIRE * @see RedisKeyCommands#pExpire(byte[], long) */ Boolean pExpire(String key, long millis); @@ -214,7 +214,7 @@ interface StringTuple extends Tuple { * @param key must not be {@literal null}. * @param unixTime * @return - * @see Redis Documentation: EXPIREAT + * @see Redis Documentation: EXPIREAT * @see RedisKeyCommands#expireAt(byte[], long) */ Boolean expireAt(String key, long unixTime); @@ -225,7 +225,7 @@ interface StringTuple extends Tuple { * @param key must not be {@literal null}. * @param unixTimeInMillis * @return - * @see Redis Documentation: PEXPIREAT + * @see Redis Documentation: PEXPIREAT * @see RedisKeyCommands#pExpireAt(byte[], long) */ Boolean pExpireAt(String key, long unixTimeInMillis); @@ -235,7 +235,7 @@ interface StringTuple extends Tuple { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: PERSIST + * @see Redis Documentation: PERSIST * @see RedisKeyCommands#persist(byte[]) */ Boolean persist(String key); @@ -246,7 +246,7 @@ interface StringTuple extends Tuple { * @param key must not be {@literal null}. * @param dbIndex * @return - * @see Redis Documentation: MOVE + * @see Redis Documentation: MOVE * @see RedisKeyCommands#move(byte[], int) */ Boolean move(String key, int dbIndex); @@ -256,7 +256,7 @@ interface StringTuple extends Tuple { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: TTL + * @see Redis Documentation: TTL * @see RedisKeyCommands#ttl(byte[]) */ Long ttl(String key); @@ -268,7 +268,7 @@ interface StringTuple extends Tuple { * @param timeUnit must not be {@literal null}. * @return * @since 1.8 - * @see Redis Documentation: TTL + * @see Redis Documentation: TTL * @see RedisKeyCommands#ttl(byte[], TimeUnit) */ Long ttl(String key, TimeUnit timeUnit); @@ -278,7 +278,7 @@ interface StringTuple extends Tuple { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: PTTL + * @see Redis Documentation: PTTL * @see RedisKeyCommands#pTtl(byte[]) */ Long pTtl(String key); @@ -290,7 +290,7 @@ interface StringTuple extends Tuple { * @param timeUnit must not be {@literal null}. * @return * @since 1.8 - * @see Redis Documentation: PTTL + * @see Redis Documentation: PTTL * @see RedisKeyCommands#pTtl(byte[], TimeUnit) */ Long pTtl(String key, TimeUnit timeUnit); @@ -300,7 +300,7 @@ interface StringTuple extends Tuple { * * @param message the message to echo. * @return - * @see Redis Documentation: ECHO + * @see Redis Documentation: ECHO * @see RedisConnectionCommands#echo(byte[]) */ String echo(String message); @@ -311,7 +311,7 @@ interface StringTuple extends Tuple { * @param key must not be {@literal null}. * @param params must not be {@literal null}. * @return - * @see Redis Documentation: SORT + * @see Redis Documentation: SORT */ List sort(String key, SortParameters params); @@ -322,7 +322,7 @@ interface StringTuple extends Tuple { * @param params must not be {@literal null}. * @param storeKey must not be {@literal null}. * @return - * @see Redis Documentation: SORT + * @see Redis Documentation: SORT */ Long sort(String key, SortParameters params, String storeKey); @@ -368,7 +368,7 @@ interface StringTuple extends Tuple { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: GET + * @see Redis Documentation: GET * @see RedisStringCommands#get(byte[]) */ String get(String key); @@ -379,7 +379,7 @@ interface StringTuple extends Tuple { * @param key must not be {@literal null}. * @param value * @return - * @see Redis Documentation: GETSET + * @see Redis Documentation: GETSET * @see RedisStringCommands#getSet(byte[], byte[]) */ String getSet(String key, String value); @@ -389,7 +389,7 @@ interface StringTuple extends Tuple { * * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: MGET + * @see Redis Documentation: MGET * @see RedisStringCommands#mGet(byte[]...) */ List mGet(String... keys); @@ -399,7 +399,7 @@ interface StringTuple extends Tuple { * * @param key must not be {@literal null}. * @param value must not be {@literal null}. - * @see Redis Documentation: SET + * @see Redis Documentation: SET * @see RedisStringCommands#set(byte[], byte[]) */ @Nullable @@ -414,7 +414,7 @@ interface StringTuple extends Tuple { * @param expiration can be {@literal null}. Defaulted to {@link Expiration#persistent()}. * @param option can be {@literal null}. Defaulted to {@link SetOption#UPSERT}. * @since 1.7 - * @see Redis Documentation: SET + * @see Redis Documentation: SET * @see RedisStringCommands#set(byte[], byte[], Expiration, SetOption) */ @Nullable @@ -426,7 +426,7 @@ interface StringTuple extends Tuple { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return - * @see Redis Documentation: SETNX + * @see Redis Documentation: SETNX * @see RedisStringCommands#setNX(byte[], byte[]) */ @Nullable @@ -438,7 +438,7 @@ interface StringTuple extends Tuple { * @param key must not be {@literal null}. * @param seconds * @param value must not be {@literal null}. - * @see Redis Documentation: SETEX + * @see Redis Documentation: SETEX * @see RedisStringCommands#setEx(byte[], long, byte[]) */ @Nullable @@ -451,7 +451,7 @@ interface StringTuple extends Tuple { * @param milliseconds * @param value must not be {@literal null}. * @since 1.3 - * @see Redis Documentation: PSETEX + * @see Redis Documentation: PSETEX * @see RedisStringCommands#pSetEx(byte[], long, byte[]) */ @Nullable @@ -461,7 +461,7 @@ interface StringTuple extends Tuple { * Set multiple keys to multiple values using key-value pairs provided in {@code tuple}. * * @param tuple must not be {@literal null}. - * @see Redis Documentation: MSET + * @see Redis Documentation: MSET * @see RedisStringCommands#mSet(Map) */ @Nullable @@ -472,7 +472,7 @@ interface StringTuple extends Tuple { * not exist. * * @param tuple must not be {@literal null}. - * @see Redis Documentation: MSETNX + * @see Redis Documentation: MSETNX * @see RedisStringCommands#mSetNX(Map) */ Boolean mSetNXString(Map tuple); @@ -482,7 +482,7 @@ interface StringTuple extends Tuple { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: INCR + * @see Redis Documentation: INCR * @see RedisStringCommands#incr(byte[]) */ Long incr(String key); @@ -493,7 +493,7 @@ interface StringTuple extends Tuple { * @param key must not be {@literal null}. * @param value * @return - * @see Redis Documentation: INCRBY + * @see Redis Documentation: INCRBY * @see RedisStringCommands#incrBy(byte[], long) */ Long incrBy(String key, long value); @@ -504,7 +504,7 @@ interface StringTuple extends Tuple { * @param key must not be {@literal null}. * @param value * @return - * @see Redis Documentation: INCRBYFLOAT + * @see Redis Documentation: INCRBYFLOAT * @see RedisStringCommands#incrBy(byte[], double) */ Double incrBy(String key, double value); @@ -514,7 +514,7 @@ interface StringTuple extends Tuple { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: DECR + * @see Redis Documentation: DECR * @see RedisStringCommands#decr(byte[]) */ Long decr(String key); @@ -525,7 +525,7 @@ interface StringTuple extends Tuple { * @param key must not be {@literal null}. * @param value * @return - * @see Redis Documentation: DECRBY + * @see Redis Documentation: DECRBY * @see RedisStringCommands#decrBy(byte[], long) */ Long decrBy(String key, long value); @@ -536,7 +536,7 @@ interface StringTuple extends Tuple { * @param key must not be {@literal null}. * @param value * @return - * @see Redis Documentation: APPEND + * @see Redis Documentation: APPEND * @see RedisStringCommands#append(byte[], byte[]) */ Long append(String key, String value); @@ -548,7 +548,7 @@ interface StringTuple extends Tuple { * @param start * @param end * @return - * @see Redis Documentation: GETRANGE + * @see Redis Documentation: GETRANGE * @see RedisStringCommands#getRange(byte[], long, long) */ String getRange(String key, long start, long end); @@ -559,7 +559,7 @@ interface StringTuple extends Tuple { * @param key must not be {@literal null}. * @param value * @param offset - * @see Redis Documentation: SETRANGE + * @see Redis Documentation: SETRANGE * @see RedisStringCommands#setRange(byte[], byte[], long) */ void setRange(String key, String value, long offset); @@ -570,7 +570,7 @@ interface StringTuple extends Tuple { * @param key must not be {@literal null}. * @param offset * @return - * @see Redis Documentation: GETBIT + * @see Redis Documentation: GETBIT * @see RedisStringCommands#getBit(byte[], long) */ Boolean getBit(String key, long offset); @@ -582,7 +582,7 @@ interface StringTuple extends Tuple { * @param offset * @param value * @return the original bit value stored at {@code offset}. - * @see Redis Documentation: SETBIT + * @see Redis Documentation: SETBIT * @see RedisStringCommands#setBit(byte[], long, boolean) */ Boolean setBit(String key, long offset, boolean value); @@ -592,7 +592,7 @@ interface StringTuple extends Tuple { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: BITCOUNT + * @see Redis Documentation: BITCOUNT * @see RedisStringCommands#bitCount(byte[]) */ Long bitCount(String key); @@ -605,7 +605,7 @@ interface StringTuple extends Tuple { * @param start * @param end * @return - * @see Redis Documentation: BITCOUNT + * @see Redis Documentation: BITCOUNT * @see RedisStringCommands#bitCount(byte[], long, long) */ Long bitCount(String key, long start, long end); @@ -617,7 +617,7 @@ interface StringTuple extends Tuple { * @param destination must not be {@literal null}. * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: BITOP + * @see Redis Documentation: BITOP * @see RedisStringCommands#bitOp(BitOperation, byte[], byte[]...) */ Long bitOp(BitOperation op, String destination, String... keys); @@ -629,7 +629,7 @@ interface StringTuple extends Tuple { * @param bit the bit value to look for. * @return {@literal null} when used in pipeline / transaction. The position of the first bit set to 1 or 0 according * to the request. - * @see Redis Documentation: BITPOS + * @see Redis Documentation: BITPOS * @since 2.1 */ default Long bitPos(String key, boolean bit) { @@ -647,7 +647,7 @@ default Long bitPos(String key, boolean bit) { * @param range must not be {@literal null}. Use {@link Range#unbounded()} to not limit search. * @return {@literal null} when used in pipeline / transaction. The position of the first bit set to 1 or 0 according * to the request. - * @see Redis Documentation: BITPOS + * @see Redis Documentation: BITPOS * @since 2.1 */ @Nullable @@ -658,7 +658,7 @@ default Long bitPos(String key, boolean bit) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: STRLEN + * @see Redis Documentation: STRLEN * @see RedisStringCommands#strLen(byte[]) */ Long strLen(String key); @@ -673,7 +673,7 @@ default Long bitPos(String key, boolean bit) { * @param key must not be {@literal null}. * @param values * @return - * @see Redis Documentation: RPUSH + * @see Redis Documentation: RPUSH * @see RedisListCommands#rPush(byte[], byte[]...) */ Long rPush(String key, String... values); @@ -684,7 +684,7 @@ default Long bitPos(String key, boolean bit) { * @param key must not be {@literal null}. * @param values * @return - * @see Redis Documentation: LPUSH + * @see Redis Documentation: LPUSH * @see RedisListCommands#lPush(byte[], byte[]...) */ Long lPush(String key, String... values); @@ -695,7 +695,7 @@ default Long bitPos(String key, boolean bit) { * @param key must not be {@literal null}. * @param value * @return - * @see Redis Documentation: RPUSHX + * @see Redis Documentation: RPUSHX * @see RedisListCommands#rPushX(byte[], byte[]) */ Long rPushX(String key, String value); @@ -706,7 +706,7 @@ default Long bitPos(String key, boolean bit) { * @param key must not be {@literal null}. * @param value * @return - * @see Redis Documentation: LPUSHX + * @see Redis Documentation: LPUSHX * @see RedisListCommands#lPushX(byte[], byte[]) */ Long lPushX(String key, String value); @@ -716,7 +716,7 @@ default Long bitPos(String key, boolean bit) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: LLEN + * @see Redis Documentation: LLEN * @see RedisListCommands#lLen(byte[]) */ Long lLen(String key); @@ -728,7 +728,7 @@ default Long bitPos(String key, boolean bit) { * @param start * @param end * @return - * @see Redis Documentation: LRANGE + * @see Redis Documentation: LRANGE * @see RedisListCommands#lRange(byte[], long, long) */ List lRange(String key, long start, long end); @@ -739,7 +739,7 @@ default Long bitPos(String key, boolean bit) { * @param key must not be {@literal null}. * @param start * @param end - * @see Redis Documentation: LTRIM + * @see Redis Documentation: LTRIM * @see RedisListCommands#lTrim(byte[], long, long) */ void lTrim(String key, long start, long end); @@ -750,7 +750,7 @@ default Long bitPos(String key, boolean bit) { * @param key must not be {@literal null}. * @param index * @return - * @see Redis Documentation: LINDEX + * @see Redis Documentation: LINDEX * @see RedisListCommands#lIndex(byte[], long) */ String lIndex(String key, long index); @@ -763,7 +763,7 @@ default Long bitPos(String key, boolean bit) { * @param pivot * @param value * @return - * @see Redis Documentation: LINSERT + * @see Redis Documentation: LINSERT * @see RedisListCommands#lIndex(byte[], long) */ Long lInsert(String key, Position where, String pivot, String value); @@ -774,7 +774,7 @@ default Long bitPos(String key, boolean bit) { * @param key must not be {@literal null}. * @param index * @param value - * @see Redis Documentation: LSET + * @see Redis Documentation: LSET * @see RedisListCommands#lSet(byte[], long, byte[]) */ void lSet(String key, long index, String value); @@ -786,7 +786,7 @@ default Long bitPos(String key, boolean bit) { * @param count * @param value * @return - * @see Redis Documentation: LREM + * @see Redis Documentation: LREM * @see RedisListCommands#lRem(byte[], long, byte[]) */ Long lRem(String key, long count, String value); @@ -796,7 +796,7 @@ default Long bitPos(String key, boolean bit) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: LPOP + * @see Redis Documentation: LPOP * @see RedisListCommands#lPop(byte[]) */ String lPop(String key); @@ -806,7 +806,7 @@ default Long bitPos(String key, boolean bit) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: RPOP + * @see Redis Documentation: RPOP * @see RedisListCommands#rPop(byte[]) */ String rPop(String key); @@ -818,7 +818,7 @@ default Long bitPos(String key, boolean bit) { * @param timeout * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: BLPOP + * @see Redis Documentation: BLPOP * @see RedisListCommands#bLPop(int, byte[]...) */ List bLPop(int timeout, String... keys); @@ -830,7 +830,7 @@ default Long bitPos(String key, boolean bit) { * @param timeout * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: BRPOP + * @see Redis Documentation: BRPOP * @see RedisListCommands#bRPop(int, byte[]...) */ List bRPop(int timeout, String... keys); @@ -841,7 +841,7 @@ default Long bitPos(String key, boolean bit) { * @param srcKey must not be {@literal null}. * @param dstKey must not be {@literal null}. * @return - * @see Redis Documentation: RPOPLPUSH + * @see Redis Documentation: RPOPLPUSH * @see RedisListCommands#rPopLPush(byte[], byte[]) */ String rPopLPush(String srcKey, String dstKey); @@ -855,7 +855,7 @@ default Long bitPos(String key, boolean bit) { * @param srcKey must not be {@literal null}. * @param dstKey must not be {@literal null}. * @return - * @see Redis Documentation: BRPOPLPUSH + * @see Redis Documentation: BRPOPLPUSH * @see RedisListCommands#bRPopLPush(int, byte[], byte[]) */ String bRPopLPush(int timeout, String srcKey, String dstKey); @@ -870,7 +870,7 @@ default Long bitPos(String key, boolean bit) { * @param key must not be {@literal null}. * @param values * @return - * @see Redis Documentation: SADD + * @see Redis Documentation: SADD * @see RedisSetCommands#sAdd(byte[], byte[]...) */ Long sAdd(String key, String... values); @@ -881,7 +881,7 @@ default Long bitPos(String key, boolean bit) { * @param key must not be {@literal null}. * @param values * @return - * @see Redis Documentation: SREM + * @see Redis Documentation: SREM * @see RedisSetCommands#sRem(byte[], byte[]...) */ Long sRem(String key, String... values); @@ -891,7 +891,7 @@ default Long bitPos(String key, boolean bit) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: SPOP + * @see Redis Documentation: SPOP * @see RedisSetCommands#sPop(byte[]) */ String sPop(String key); @@ -902,7 +902,7 @@ default Long bitPos(String key, boolean bit) { * @param key must not be {@literal null}. * @param count the number of random members to return. * @return empty {@link List} if {@literal key} does not exist. - * @see Redis Documentation: SPOP + * @see Redis Documentation: SPOP * @see RedisSetCommands#sPop(byte[], long) * @since 2.0 */ @@ -915,7 +915,7 @@ default Long bitPos(String key, boolean bit) { * @param destKey must not be {@literal null}. * @param value * @return - * @see Redis Documentation: SMOVE + * @see Redis Documentation: SMOVE * @see RedisSetCommands#sMove(byte[], byte[], byte[]) */ Boolean sMove(String srcKey, String destKey, String value); @@ -925,7 +925,7 @@ default Long bitPos(String key, boolean bit) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: SCARD + * @see Redis Documentation: SCARD * @see RedisSetCommands#sCard(byte[]) */ Long sCard(String key); @@ -936,7 +936,7 @@ default Long bitPos(String key, boolean bit) { * @param key must not be {@literal null}. * @param value * @return - * @see Redis Documentation: SISMEMBER + * @see Redis Documentation: SISMEMBER * @see RedisSetCommands#sIsMember(byte[], byte[]) */ Boolean sIsMember(String key, String value); @@ -946,7 +946,7 @@ default Long bitPos(String key, boolean bit) { * * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: SINTER + * @see Redis Documentation: SINTER * @see RedisSetCommands#sInter(byte[]...) */ Set sInter(String... keys); @@ -957,7 +957,7 @@ default Long bitPos(String key, boolean bit) { * @param destKey must not be {@literal null}. * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: SINTERSTORE + * @see Redis Documentation: SINTERSTORE * @see RedisSetCommands#sInterStore(byte[], byte[]...) */ Long sInterStore(String destKey, String... keys); @@ -967,7 +967,7 @@ default Long bitPos(String key, boolean bit) { * * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: SUNION + * @see Redis Documentation: SUNION * @see RedisSetCommands#sUnion(byte[]...) */ Set sUnion(String... keys); @@ -978,7 +978,7 @@ default Long bitPos(String key, boolean bit) { * @param destKey must not be {@literal null}. * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: SUNIONSTORE + * @see Redis Documentation: SUNIONSTORE * @see RedisSetCommands#sUnionStore(byte[], byte[]...) */ Long sUnionStore(String destKey, String... keys); @@ -988,7 +988,7 @@ default Long bitPos(String key, boolean bit) { * * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: SDIFF + * @see Redis Documentation: SDIFF * @see RedisSetCommands#sDiff(byte[]...) */ Set sDiff(String... keys); @@ -999,7 +999,7 @@ default Long bitPos(String key, boolean bit) { * @param destKey must not be {@literal null}. * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: SDIFFSTORE + * @see Redis Documentation: SDIFFSTORE * @see RedisSetCommands#sDiffStore(byte[], byte[]...) */ Long sDiffStore(String destKey, String... keys); @@ -1009,7 +1009,7 @@ default Long bitPos(String key, boolean bit) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: SMEMBERS + * @see Redis Documentation: SMEMBERS * @see RedisSetCommands#sMembers(byte[]) */ Set sMembers(String key); @@ -1019,7 +1019,7 @@ default Long bitPos(String key, boolean bit) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: SRANDMEMBER + * @see Redis Documentation: SRANDMEMBER * @see RedisSetCommands#sRandMember(byte[]) */ String sRandMember(String key); @@ -1030,7 +1030,7 @@ default Long bitPos(String key, boolean bit) { * @param key must not be {@literal null}. * @param count * @return - * @see Redis Documentation: SRANDMEMBER + * @see Redis Documentation: SRANDMEMBER * @see RedisSetCommands#sRem(byte[], byte[]...) */ List sRandMember(String key, long count); @@ -1042,7 +1042,7 @@ default Long bitPos(String key, boolean bit) { * @param options must not be {@literal null}. * @return * @since 1.4 - * @see Redis Documentation: SCAN + * @see Redis Documentation: SCAN * @see RedisSetCommands#sScan(byte[], ScanOptions) */ Cursor sScan(String key, ScanOptions options); @@ -1058,7 +1058,7 @@ default Long bitPos(String key, boolean bit) { * @param score the score. * @param value the value. * @return - * @see Redis Documentation: ZADD + * @see Redis Documentation: ZADD * @see RedisZSetCommands#zAdd(byte[], double, byte[]) */ Boolean zAdd(String key, double score, String value); @@ -1069,7 +1069,7 @@ default Long bitPos(String key, boolean bit) { * @param key must not be {@literal null}. * @param tuples the tuples. * @return - * @see Redis Documentation: ZADD + * @see Redis Documentation: ZADD * @see RedisZSetCommands#zAdd(byte[], Set) */ Long zAdd(String key, Set tuples); @@ -1080,7 +1080,7 @@ default Long bitPos(String key, boolean bit) { * @param key must not be {@literal null}. * @param values must not be {@literal null}. * @return - * @see Redis Documentation: ZREM + * @see Redis Documentation: ZREM * @see RedisZSetCommands#zRem(byte[], byte[]...) */ Long zRem(String key, String... values); @@ -1092,7 +1092,7 @@ default Long bitPos(String key, boolean bit) { * @param increment * @param value the value. * @return - * @see Redis Documentation: ZINCRBY + * @see Redis Documentation: ZINCRBY * @see RedisZSetCommands#zIncrBy(byte[], double, byte[]) */ Double zIncrBy(String key, double increment, String value); @@ -1103,7 +1103,7 @@ default Long bitPos(String key, boolean bit) { * @param key must not be {@literal null}. * @param value the value. * @return - * @see Redis Documentation: ZRANK + * @see Redis Documentation: ZRANK * @see RedisZSetCommands#zRank(byte[], byte[]) */ Long zRank(String key, String value); @@ -1114,7 +1114,7 @@ default Long bitPos(String key, boolean bit) { * @param key must not be {@literal null}. * @param value the value. * @return - * @see Redis Documentation: ZREVRANK + * @see Redis Documentation: ZREVRANK * @see RedisZSetCommands#zRevRank(byte[], byte[]) */ Long zRevRank(String key, String value); @@ -1126,7 +1126,7 @@ default Long bitPos(String key, boolean bit) { * @param start * @param end * @return - * @see Redis Documentation: ZRANGE + * @see Redis Documentation: ZRANGE * @see RedisZSetCommands#zRange(byte[], long, long) */ Set zRange(String key, long start, long end); @@ -1138,7 +1138,7 @@ default Long bitPos(String key, boolean bit) { * @param start * @param end * @return - * @see Redis Documentation: ZRANGE + * @see Redis Documentation: ZRANGE * @see RedisZSetCommands#zRangeWithScores(byte[], long, long) */ Set zRangeWithScores(String key, long start, long end); @@ -1150,7 +1150,7 @@ default Long bitPos(String key, boolean bit) { * @param min * @param max * @return - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE * @see RedisZSetCommands#zRangeByScore(byte[], double, double) */ Set zRangeByScore(String key, double min, double max); @@ -1162,7 +1162,7 @@ default Long bitPos(String key, boolean bit) { * @param min * @param max * @return - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE * @see RedisZSetCommands#zRangeByScoreWithScores(byte[], double, double) */ Set zRangeByScoreWithScores(String key, double min, double max); @@ -1177,7 +1177,7 @@ default Long bitPos(String key, boolean bit) { * @param offset * @param count * @return - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE * @see RedisZSetCommands#zRangeByScore(byte[], double, double, long, long) */ Set zRangeByScore(String key, double min, double max, long offset, long count); @@ -1192,7 +1192,7 @@ default Long bitPos(String key, boolean bit) { * @param offset * @param count * @return - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE * @see RedisZSetCommands#zRangeByScoreWithScores(byte[], double, double, long, long) */ Set zRangeByScoreWithScores(String key, double min, double max, long offset, long count); @@ -1204,7 +1204,7 @@ default Long bitPos(String key, boolean bit) { * @param start * @param end * @return - * @see Redis Documentation: ZREVRANGE + * @see Redis Documentation: ZREVRANGE * @see RedisZSetCommands#zRevRange(byte[], long, long) */ Set zRevRange(String key, long start, long end); @@ -1216,7 +1216,7 @@ default Long bitPos(String key, boolean bit) { * @param start * @param end * @return - * @see Redis Documentation: ZREVRANGE + * @see Redis Documentation: ZREVRANGE * @see RedisZSetCommands#zRevRangeWithScores(byte[], long, long) */ Set zRevRangeWithScores(String key, long start, long end); @@ -1228,7 +1228,7 @@ default Long bitPos(String key, boolean bit) { * @param min * @param max * @return - * @see Redis Documentation: ZREVRANGE + * @see Redis Documentation: ZREVRANGE * @see RedisZSetCommands#zRevRangeByScore(byte[], double, double) */ Set zRevRangeByScore(String key, double min, double max); @@ -1241,7 +1241,7 @@ default Long bitPos(String key, boolean bit) { * @param min * @param max * @return - * @see Redis Documentation: ZREVRANGEBYSCORE + * @see Redis Documentation: ZREVRANGEBYSCORE * @see RedisZSetCommands#zRevRangeByScoreWithScores(byte[], double, double) */ Set zRevRangeByScoreWithScores(String key, double min, double max); @@ -1256,7 +1256,7 @@ default Long bitPos(String key, boolean bit) { * @param offset * @param count * @return - * @see Redis Documentation: ZREVRANGEBYSCORE + * @see Redis Documentation: ZREVRANGEBYSCORE * @see RedisZSetCommands#zRevRangeByScore(byte[], double, double, long, long) */ Set zRevRangeByScore(String key, double min, double max, long offset, long count); @@ -1271,7 +1271,7 @@ default Long bitPos(String key, boolean bit) { * @param offset * @param count * @return - * @see Redis Documentation: ZREVRANGEBYSCORE + * @see Redis Documentation: ZREVRANGEBYSCORE * @see RedisZSetCommands#zRevRangeByScoreWithScores(byte[], double, double, long, long) */ Set zRevRangeByScoreWithScores(String key, double min, double max, long offset, long count); @@ -1283,7 +1283,7 @@ default Long bitPos(String key, boolean bit) { * @param min * @param max * @return - * @see Redis Documentation: ZCOUNT + * @see Redis Documentation: ZCOUNT * @see RedisZSetCommands#zCount(byte[], double, double) */ Long zCount(String key, double min, double max); @@ -1293,7 +1293,7 @@ default Long bitPos(String key, boolean bit) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: ZCARD + * @see Redis Documentation: ZCARD * @see RedisZSetCommands#zCard(byte[]) */ Long zCard(String key); @@ -1304,7 +1304,7 @@ default Long bitPos(String key, boolean bit) { * @param key must not be {@literal null}. * @param value the value. * @return - * @see Redis Documentation: ZSCORE + * @see Redis Documentation: ZSCORE * @see RedisZSetCommands#zScore(byte[], byte[]) */ Double zScore(String key, String value); @@ -1316,7 +1316,7 @@ default Long bitPos(String key, boolean bit) { * @param start * @param end * @return - * @see Redis Documentation: ZREMRANGEBYRANK + * @see Redis Documentation: ZREMRANGEBYRANK * @see RedisZSetCommands#zRemRange(byte[], long, long) */ Long zRemRange(String key, long start, long end); @@ -1328,7 +1328,7 @@ default Long bitPos(String key, boolean bit) { * @param min * @param max * @return - * @see Redis Documentation: ZREMRANGEBYSCORE + * @see Redis Documentation: ZREMRANGEBYSCORE * @see RedisZSetCommands#zRemRangeByScore(byte[], double, double) */ Long zRemRangeByScore(String key, double min, double max); @@ -1339,7 +1339,7 @@ default Long bitPos(String key, boolean bit) { * @param destKey must not be {@literal null}. * @param sets must not be {@literal null}. * @return - * @see Redis Documentation: ZUNIONSTORE + * @see Redis Documentation: ZUNIONSTORE * @see RedisZSetCommands#zUnionStore(byte[], byte[]...) */ Long zUnionStore(String destKey, String... sets); @@ -1352,7 +1352,7 @@ default Long bitPos(String key, boolean bit) { * @param weights * @param sets must not be {@literal null}. * @return - * @see Redis Documentation: ZUNIONSTORE + * @see Redis Documentation: ZUNIONSTORE * @see RedisZSetCommands#zUnionStore(byte[], Aggregate, int[], byte[]...) */ Long zUnionStore(String destKey, Aggregate aggregate, int[] weights, String... sets); @@ -1363,7 +1363,7 @@ default Long bitPos(String key, boolean bit) { * @param destKey must not be {@literal null}. * @param sets must not be {@literal null}. * @return - * @see Redis Documentation: ZINTERSTORE + * @see Redis Documentation: ZINTERSTORE * @see RedisZSetCommands#zInterStore(byte[], byte[]...) */ Long zInterStore(String destKey, String... sets); @@ -1376,7 +1376,7 @@ default Long bitPos(String key, boolean bit) { * @param weights * @param sets must not be {@literal null}. * @return - * @see Redis Documentation: ZINTERSTORE + * @see Redis Documentation: ZINTERSTORE * @see RedisZSetCommands#zInterStore(byte[], Aggregate, int[], byte[]...) */ Long zInterStore(String destKey, Aggregate aggregate, int[] weights, String... sets); @@ -1388,7 +1388,7 @@ default Long bitPos(String key, boolean bit) { * @param options must not be {@literal null}. * @return * @since 1.4 - * @see Redis Documentation: ZSCAN + * @see Redis Documentation: ZSCAN * @see RedisZSetCommands#zScan(byte[], ScanOptions) */ Cursor zScan(String key, ScanOptions options); @@ -1401,7 +1401,7 @@ default Long bitPos(String key, boolean bit) { * @param max must not be {@literal null}. * @return * @since 1.5 - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE * @see RedisZSetCommands#zRangeByScore(byte[], String, String) */ Set zRangeByScore(String key, String min, String max); @@ -1417,7 +1417,7 @@ default Long bitPos(String key, boolean bit) { * @param count * @return * @since 1.5 - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE * @see RedisZSetCommands#zRangeByScore(byte[], double, double, long, long) */ Set zRangeByScore(String key, String min, String max, long offset, long count); @@ -1428,7 +1428,7 @@ default Long bitPos(String key, boolean bit) { * @param key must not be {@literal null}. * @return * @since 1.6 - * @see Redis Documentation: ZRANGEBYLEX + * @see Redis Documentation: ZRANGEBYLEX * @see RedisZSetCommands#zRangeByLex(byte[]) */ Set zRangeByLex(String key); @@ -1440,7 +1440,7 @@ default Long bitPos(String key, boolean bit) { * @param range must not be {@literal null}. * @return * @since 1.6 - * @see Redis Documentation: ZRANGEBYLEX + * @see Redis Documentation: ZRANGEBYLEX * @see RedisZSetCommands#zRangeByLex(byte[], Range) */ Set zRangeByLex(String key, Range range); @@ -1454,7 +1454,7 @@ default Long bitPos(String key, boolean bit) { * @param range can be {@literal null}. * @return * @since 1.6 - * @see Redis Documentation: ZRANGEBYLEX + * @see Redis Documentation: ZRANGEBYLEX * @see RedisZSetCommands#zRangeByLex(byte[], Range, Limit) */ Set zRangeByLex(String key, Range range, Limit limit); @@ -1470,7 +1470,7 @@ default Long bitPos(String key, boolean bit) { * @param field must not be {@literal null}. * @param value * @return - * @see Redis Documentation: HSET + * @see Redis Documentation: HSET * @see RedisHashCommands#hSet(byte[], byte[], byte[]) */ Boolean hSet(String key, String field, String value); @@ -1482,7 +1482,7 @@ default Long bitPos(String key, boolean bit) { * @param field must not be {@literal null}. * @param value * @return - * @see Redis Documentation: HSETNX + * @see Redis Documentation: HSETNX * @see RedisHashCommands#hSetNX(byte[], byte[], byte[]) */ Boolean hSetNX(String key, String field, String value); @@ -1493,7 +1493,7 @@ default Long bitPos(String key, boolean bit) { * @param key must not be {@literal null}. * @param field must not be {@literal null}. * @return - * @see Redis Documentation: HGET + * @see Redis Documentation: HGET * @see RedisHashCommands#hGet(byte[], byte[]) */ String hGet(String key, String field); @@ -1504,7 +1504,7 @@ default Long bitPos(String key, boolean bit) { * @param key must not be {@literal null}. * @param fields must not be {@literal null}. * @return - * @see Redis Documentation: HMGET + * @see Redis Documentation: HMGET * @see RedisHashCommands#hMGet(byte[], byte[]...) */ List hMGet(String key, String... fields); @@ -1514,7 +1514,7 @@ default Long bitPos(String key, boolean bit) { * * @param key must not be {@literal null}. * @param hashes must not be {@literal null}. - * @see Redis Documentation: HMSET + * @see Redis Documentation: HMSET * @see RedisHashCommands#hMGet(byte[], byte[]...) */ void hMSet(String key, Map hashes); @@ -1526,7 +1526,7 @@ default Long bitPos(String key, boolean bit) { * @param field must not be {@literal null}. * @param delta * @return - * @see Redis Documentation: HINCRBY + * @see Redis Documentation: HINCRBY * @see RedisHashCommands#hIncrBy(byte[], byte[], long) */ Long hIncrBy(String key, String field, long delta); @@ -1538,7 +1538,7 @@ default Long bitPos(String key, boolean bit) { * @param field * @param delta * @return - * @see Redis Documentation: HINCRBYFLOAT + * @see Redis Documentation: HINCRBYFLOAT * @see RedisHashCommands#hIncrBy(byte[], byte[], double) */ Double hIncrBy(String key, String field, double delta); @@ -1549,7 +1549,7 @@ default Long bitPos(String key, boolean bit) { * @param key must not be {@literal null}. * @param field must not be {@literal null}. * @return - * @see Redis Documentation: HEXISTS + * @see Redis Documentation: HEXISTS * @see RedisHashCommands#hExists(byte[], byte[]) */ Boolean hExists(String key, String field); @@ -1560,7 +1560,7 @@ default Long bitPos(String key, boolean bit) { * @param key must not be {@literal null}. * @param fields must not be {@literal null}. * @return - * @see Redis Documentation: HDEL + * @see Redis Documentation: HDEL * @see RedisHashCommands#hDel(byte[], byte[]...) */ Long hDel(String key, String... fields); @@ -1570,7 +1570,7 @@ default Long bitPos(String key, boolean bit) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: HLEN + * @see Redis Documentation: HLEN * @see RedisHashCommands#hLen(byte[]) */ Long hLen(String key); @@ -1580,7 +1580,7 @@ default Long bitPos(String key, boolean bit) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: HKEYS? + * @see Redis Documentation: HKEYS? * @see RedisHashCommands#hKeys(byte[]) */ Set hKeys(String key); @@ -1590,7 +1590,7 @@ default Long bitPos(String key, boolean bit) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: HVALS + * @see Redis Documentation: HVALS * @see RedisHashCommands#hVals(byte[]) */ List hVals(String key); @@ -1600,7 +1600,7 @@ default Long bitPos(String key, boolean bit) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: HGETALL + * @see Redis Documentation: HGETALL * @see RedisHashCommands#hGetAll(byte[]) */ Map hGetAll(String key); @@ -1612,7 +1612,7 @@ default Long bitPos(String key, boolean bit) { * @param options must not be {@literal null}. * @return * @since 1.4 - * @see Redis Documentation: HSCAN + * @see Redis Documentation: HSCAN * @see RedisHashCommands#hScan(byte[], ScanOptions) */ Cursor> hScan(String key, ScanOptions options); @@ -1640,7 +1640,7 @@ default Long bitPos(String key, boolean bit) { * @param values must not be {@literal null}. * @return * @since 1.5 - * @see Redis Documentation: PFADD + * @see Redis Documentation: PFADD * @see RedisHyperLogLogCommands#pfAdd(byte[], byte[]...) */ Long pfAdd(String key, String... values); @@ -1650,7 +1650,7 @@ default Long bitPos(String key, boolean bit) { * * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: PFCOUNT + * @see Redis Documentation: PFCOUNT * @see RedisHyperLogLogCommands#pfCount(byte[]...) */ Long pfCount(String... keys); @@ -1660,7 +1660,7 @@ default Long bitPos(String key, boolean bit) { * * @param destinationKey must not be {@literal null}. * @param sourceKeys must not be {@literal null}. - * @see Redis Documentation: PFMERGE + * @see Redis Documentation: PFMERGE * @see RedisHyperLogLogCommands#pfMerge(byte[], byte[]...) */ void pfMerge(String destinationKey, String... sourceKeys); @@ -1677,7 +1677,7 @@ default Long bitPos(String key, boolean bit) { * @param member must not be {@literal null}. * @return Number of elements added. * @since 1.8 - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD * @see RedisGeoCommands#geoAdd(byte[], Point, byte[]) */ Long geoAdd(String key, Point point, String member); @@ -1689,7 +1689,7 @@ default Long bitPos(String key, boolean bit) { * @param location must not be {@literal null}. * @return Number of elements added. * @since 1.8 - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD * @see RedisGeoCommands#geoAdd(byte[], GeoLocation) */ Long geoAdd(String key, GeoLocation location); @@ -1701,7 +1701,7 @@ default Long bitPos(String key, boolean bit) { * @param memberCoordinateMap must not be {@literal null}. * @return Number of elements added. * @since 1.8 - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD * @see RedisGeoCommands#geoAdd(byte[], Map) */ Long geoAdd(String key, Map memberCoordinateMap); @@ -1713,7 +1713,7 @@ default Long bitPos(String key, boolean bit) { * @param locations must not be {@literal null}. * @return Number of elements added. * @since 1.8 - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD * @see RedisGeoCommands#geoAdd(byte[], Iterable) */ Long geoAdd(String key, Iterable> locations); @@ -1726,7 +1726,7 @@ default Long bitPos(String key, boolean bit) { * @param member2 must not be {@literal null}. * @return can be {@literal null}. * @since 1.8 - * @see Redis Documentation: GEODIST + * @see Redis Documentation: GEODIST * @see RedisGeoCommands#geoDist(byte[], byte[], byte[]) */ Distance geoDist(String key, String member1, String member2); @@ -1740,7 +1740,7 @@ default Long bitPos(String key, boolean bit) { * @param metric must not be {@literal null}. * @return can be {@literal null}. * @since 1.8 - * @see Redis Documentation: GEODIST + * @see Redis Documentation: GEODIST * @see RedisGeoCommands#geoDist(byte[], byte[], byte[], Metric) */ Distance geoDist(String key, String member1, String member2, Metric metric); @@ -1752,7 +1752,7 @@ default Long bitPos(String key, boolean bit) { * @param members must not be {@literal null}. * @return never {@literal null}. * @since 1.8 - * @see Redis Documentation: GEOHASH + * @see Redis Documentation: GEOHASH * @see RedisGeoCommands#geoHash(byte[], byte[]...) */ List geoHash(String key, String... members); @@ -1764,7 +1764,7 @@ default Long bitPos(String key, boolean bit) { * @param members must not be {@literal null}. * @return never {@literal null}. * @since 1.8 - * @see Redis Documentation: GEOPOS + * @see Redis Documentation: GEOPOS * @see RedisGeoCommands#geoPos(byte[], byte[]...) */ List geoPos(String key, String... members); @@ -1776,7 +1776,7 @@ default Long bitPos(String key, boolean bit) { * @param within must not be {@literal null}. * @return never {@literal null}. * @since 1.8 - * @see Redis Documentation: GEORADIUS + * @see Redis Documentation: GEORADIUS * @see RedisGeoCommands#geoRadius(byte[], Circle) */ GeoResults> geoRadius(String key, Circle within); @@ -1789,7 +1789,7 @@ default Long bitPos(String key, boolean bit) { * @param args must not be {@literal null}. * @return never {@literal null}. * @since 1.8 - * @see Redis Documentation: GEORADIUS + * @see Redis Documentation: GEORADIUS * @see RedisGeoCommands#geoRadius(byte[], Circle, GeoRadiusCommandArgs) */ GeoResults> geoRadius(String key, Circle within, GeoRadiusCommandArgs args); @@ -1803,7 +1803,7 @@ default Long bitPos(String key, boolean bit) { * @param radius * @return never {@literal null}. * @since 1.8 - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER * @see RedisGeoCommands#geoRadiusByMember(byte[], byte[], double) */ GeoResults> geoRadiusByMember(String key, String member, double radius); @@ -1817,7 +1817,7 @@ default Long bitPos(String key, boolean bit) { * @param radius must not be {@literal null}. * @return never {@literal null}. * @since 1.8 - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER * @see RedisGeoCommands#geoRadiusByMember(byte[], byte[], Distance) */ GeoResults> geoRadiusByMember(String key, String member, Distance radius); @@ -1832,7 +1832,7 @@ default Long bitPos(String key, boolean bit) { * @param args must not be {@literal null}. * @return never {@literal null}. * @since 1.8 - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER * @see RedisGeoCommands#geoRadiusByMember(byte[], byte[], Distance, GeoRadiusCommandArgs) */ GeoResults> geoRadiusByMember(String key, String member, Distance radius, @@ -1845,7 +1845,7 @@ GeoResults> geoRadiusByMember(String key, String member, Dis * @param members must not be {@literal null}. * @since 1.8 * @return Number of members elements removed. - * @see Redis Documentation: ZREM + * @see Redis Documentation: ZREM * @see RedisGeoCommands#geoRemove(byte[], byte[]...) */ Long geoRemove(String key, String... members); @@ -1860,7 +1860,7 @@ GeoResults> geoRadiusByMember(String key, String member, Dis * @param channel the channel to publish to, must not be {@literal null}. * @param message message to publish * @return the number of clients that received the message - * @see Redis Documentation: PUBLISH + * @see Redis Documentation: PUBLISH * @see RedisPubSubCommands#publish(byte[], byte[]) */ Long publish(String channel, String message); @@ -1873,7 +1873,7 @@ GeoResults> geoRadiusByMember(String key, String member, Dis * * @param listener message listener, must not be {@literal null}. * @param channels channel names, must not be {@literal null}. - * @see Redis Documentation: SUBSCRIBE + * @see Redis Documentation: SUBSCRIBE * @see RedisPubSubCommands#subscribe(MessageListener, byte[]...) */ void subscribe(MessageListener listener, String... channels); @@ -1887,7 +1887,7 @@ GeoResults> geoRadiusByMember(String key, String member, Dis * * @param listener message listener, must not be {@literal null}. * @param patterns channel name patterns, must not be {@literal null}. - * @see Redis Documentation: PSUBSCRIBE + * @see Redis Documentation: PSUBSCRIBE * @see RedisPubSubCommands#pSubscribe(MessageListener, byte[]...) */ void pSubscribe(MessageListener listener, String... patterns); @@ -1902,7 +1902,7 @@ GeoResults> geoRadiusByMember(String key, String member, Dis * * @param script must not be {@literal null}. * @return - * @see Redis Documentation: SCRIPT LOAD + * @see Redis Documentation: SCRIPT LOAD * @see RedisScriptingCommands#scriptLoad(byte[]) */ String scriptLoad(String script); @@ -1915,7 +1915,7 @@ GeoResults> geoRadiusByMember(String key, String member, Dis * @param numKeys * @param keysAndArgs must not be {@literal null}. * @return - * @see Redis Documentation: EVAL + * @see Redis Documentation: EVAL * @see RedisScriptingCommands#eval(byte[], ReturnType, int, byte[]...) */ T eval(String script, ReturnType returnType, int numKeys, String... keysAndArgs); @@ -1928,7 +1928,7 @@ GeoResults> geoRadiusByMember(String key, String member, Dis * @param numKeys * @param keysAndArgs must not be {@literal null}. * @return - * @see Redis Documentation: EVALSHA + * @see Redis Documentation: EVALSHA * @see RedisScriptingCommands#evalSha(String, ReturnType, int, byte[]...) */ T evalSha(String scriptSha, ReturnType returnType, int numKeys, String... keysAndArgs); @@ -1938,7 +1938,7 @@ GeoResults> geoRadiusByMember(String key, String member, Dis * * @param name * @since 1.3 - * @see Redis Documentation: CLIENT SETNAME + * @see Redis Documentation: CLIENT SETNAME * @see RedisServerCommands#setClientName(byte[]) */ void setClientName(String name); @@ -1948,7 +1948,7 @@ GeoResults> geoRadiusByMember(String key, String member, Dis * * @return {@link List} of {@link RedisClientInfo} objects. * @since 1.3 - * @see Redis Documentation: CLIENT LIST + * @see Redis Documentation: CLIENT LIST * @see RedisServerCommands#getClientList() */ List getClientList(); @@ -1984,7 +1984,7 @@ static RecordId[] entryIds(String... entryIds) { * @param entryIds record Id's to acknowledge. * @return length of acknowledged records. {@literal null} when used in pipeline / transaction. * @since 2.2 - * @see Redis Documentation: XACK + * @see Redis Documentation: XACK */ @Nullable default Long xAck(String key, String group, String... entryIds) { @@ -2000,7 +2000,7 @@ default Long xAck(String key, String group, String... entryIds) { * @param body record body. * @return the record Id. {@literal null} when used in pipeline / transaction. * @since 2.2 - * @see Redis Documentation: XADD + * @see Redis Documentation: XADD */ @Nullable default RecordId xAdd(String key, Map body) { @@ -2017,7 +2017,7 @@ default RecordId xAdd(String key, Map body) { * @param entryIds stream record Id's. * @return number of removed entries. {@literal null} when used in pipeline / transaction. * @since 2.2 - * @see Redis Documentation: XDEL + * @see Redis Documentation: XDEL */ @Nullable default Long xDel(String key, String... entryIds) { @@ -2066,7 +2066,7 @@ default Long xDel(String key, String... entryIds) { * @param key the stream key. * @return length of the stream. {@literal null} when used in pipeline / transaction. * @since 2.2 - * @see Redis Documentation: XLEN + * @see Redis Documentation: XLEN */ @Nullable Long xLen(String key); @@ -2078,7 +2078,7 @@ default Long xDel(String key, String... entryIds) { * @param range must not be {@literal null}. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. * @since 2.2 - * @see Redis Documentation: XRANGE + * @see Redis Documentation: XRANGE */ @Nullable default List xRange(String key, org.springframework.data.domain.Range range) { @@ -2093,7 +2093,7 @@ default List xRange(String key, org.springframework.data.domain.Ra * @param limit must not be {@literal null}. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. * @since 2.2 - * @see Redis Documentation: XRANGE + * @see Redis Documentation: XRANGE */ @Nullable List xRange(String key, org.springframework.data.domain.Range range, Limit limit); @@ -2104,7 +2104,7 @@ default List xRange(String key, org.springframework.data.domain.Ra * @param stream the streams to read from. * @return list ith members of the resulting stream. {@literal null} when used in pipeline / transaction. * @since 2.2 - * @see Redis Documentation: XREAD + * @see Redis Documentation: XREAD */ @Nullable default List xReadAsString(StreamOffset stream) { @@ -2117,7 +2117,7 @@ default List xReadAsString(StreamOffset stream) { * @param streams the streams to read from. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. * @since 2.2 - * @see Redis Documentation: XREAD + * @see Redis Documentation: XREAD */ @Nullable default List xReadAsString(StreamOffset... streams) { @@ -2131,7 +2131,7 @@ default List xReadAsString(StreamOffset... streams) { * @param stream the streams to read from. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. * @since 2.2 - * @see Redis Documentation: XREAD + * @see Redis Documentation: XREAD */ @Nullable default List xReadAsString(StreamReadOptions readOptions, StreamOffset stream) { @@ -2145,7 +2145,7 @@ default List xReadAsString(StreamReadOptions readOptions, StreamOf * @param streams the streams to read from. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. * @since 2.2 - * @see Redis Documentation: XREAD + * @see Redis Documentation: XREAD */ @Nullable List xReadAsString(StreamReadOptions readOptions, StreamOffset... streams); @@ -2157,7 +2157,7 @@ default List xReadAsString(StreamReadOptions readOptions, StreamOf * @param stream the streams to read from. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. * @since 2.2 - * @see Redis Documentation: XREADGROUP + * @see Redis Documentation: XREADGROUP */ @Nullable default List xReadGroupAsString(Consumer consumer, StreamOffset stream) { @@ -2171,7 +2171,7 @@ default List xReadGroupAsString(Consumer consumer, StreamOffsetRedis Documentation: XREADGROUP + * @see Redis Documentation: XREADGROUP */ @Nullable default List xReadGroupAsString(Consumer consumer, StreamOffset... streams) { @@ -2186,7 +2186,7 @@ default List xReadGroupAsString(Consumer consumer, StreamOffsetRedis Documentation: XREADGROUP + * @see Redis Documentation: XREADGROUP */ @Nullable default List xReadGroupAsString(Consumer consumer, StreamReadOptions readOptions, @@ -2202,7 +2202,7 @@ default List xReadGroupAsString(Consumer consumer, StreamReadOptio * @param streams the streams to read from. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. * @since 2.2 - * @see Redis Documentation: XREADGROUP + * @see Redis Documentation: XREADGROUP */ @Nullable List xReadGroupAsString(Consumer consumer, StreamReadOptions readOptions, @@ -2215,7 +2215,7 @@ List xReadGroupAsString(Consumer consumer, StreamReadOptions readO * @param range must not be {@literal null}. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. * @since 2.2 - * @see Redis Documentation: XREVRANGE + * @see Redis Documentation: XREVRANGE */ @Nullable default List xRevRange(String key, org.springframework.data.domain.Range range) { @@ -2230,7 +2230,7 @@ default List xRevRange(String key, org.springframework.data.domain * @param limit must not be {@literal null}. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. * @since 2.2 - * @see Redis Documentation: XREVRANGE + * @see Redis Documentation: XREVRANGE */ @Nullable List xRevRange(String key, org.springframework.data.domain.Range range, Limit limit); @@ -2242,7 +2242,7 @@ default List xRevRange(String key, org.springframework.data.domain * @param count length of the stream. * @return number of removed entries. {@literal null} when used in pipeline / transaction. * @since 2.2 - * @see Redis Documentation: XTRIM + * @see Redis Documentation: XTRIM */ @Nullable Long xTrim(String key, long count); diff --git a/src/main/java/org/springframework/data/redis/connection/jedis/JedisConnection.java b/src/main/java/org/springframework/data/redis/connection/jedis/JedisConnection.java index 7b97f5e2d3..8f2563725f 100644 --- a/src/main/java/org/springframework/data/redis/connection/jedis/JedisConnection.java +++ b/src/main/java/org/springframework/data/redis/connection/jedis/JedisConnection.java @@ -49,7 +49,7 @@ import org.springframework.util.StringUtils; /** - * {@code RedisConnection} implementation on top of Jedis library. + * {@code RedisConnection} implementation on top of Jedis library. * * @author Costin Leau * @author Jennifer Hickey diff --git a/src/main/java/org/springframework/data/redis/connection/jedis/JedisConnectionFactory.java b/src/main/java/org/springframework/data/redis/connection/jedis/JedisConnectionFactory.java index 311a89b995..09ac1c5f70 100644 --- a/src/main/java/org/springframework/data/redis/connection/jedis/JedisConnectionFactory.java +++ b/src/main/java/org/springframework/data/redis/connection/jedis/JedisConnectionFactory.java @@ -61,7 +61,7 @@ import org.springframework.util.StringUtils; /** - * Connection factory creating Jedis based connections. + * Connection factory creating Jedis based connections. *

* {@link JedisConnectionFactory} should be configured using an environmental configuration and the * {@link JedisClientConfiguration client configuration}. Jedis supports the following environmental configurations: diff --git a/src/main/java/org/springframework/data/redis/connection/jedis/package-info.java b/src/main/java/org/springframework/data/redis/connection/jedis/package-info.java index 6e91ceb334..e3a02a2823 100644 --- a/src/main/java/org/springframework/data/redis/connection/jedis/package-info.java +++ b/src/main/java/org/springframework/data/redis/connection/jedis/package-info.java @@ -1,5 +1,5 @@ /** - * Connection package for Jedis library. + * Connection package for Jedis library. */ @org.springframework.lang.NonNullApi @org.springframework.lang.NonNullFields diff --git a/src/main/java/org/springframework/data/redis/connection/lettuce/LettuceConnectionFactory.java b/src/main/java/org/springframework/data/redis/connection/lettuce/LettuceConnectionFactory.java index c1b4d2b4ba..77b244feeb 100644 --- a/src/main/java/org/springframework/data/redis/connection/lettuce/LettuceConnectionFactory.java +++ b/src/main/java/org/springframework/data/redis/connection/lettuce/LettuceConnectionFactory.java @@ -58,7 +58,7 @@ import org.springframework.util.ClassUtils; /** - * Connection factory creating Lettuce-based connections. + * Connection factory creating Lettuce-based connections. *

* This factory creates a new {@link LettuceConnection} on each call to {@link #getConnection()}. Multiple * {@link LettuceConnection}s share a single thread-safe native connection by default. diff --git a/src/main/java/org/springframework/data/redis/core/BoundGeoOperations.java b/src/main/java/org/springframework/data/redis/core/BoundGeoOperations.java index 8eddcb4d79..d4d7d2c637 100644 --- a/src/main/java/org/springframework/data/redis/core/BoundGeoOperations.java +++ b/src/main/java/org/springframework/data/redis/core/BoundGeoOperations.java @@ -44,7 +44,7 @@ public interface BoundGeoOperations extends BoundKeyOperations { * @param member must not be {@literal null}. * @return Number of elements added. {@literal null} when used in pipeline / transaction. * @since 2.0 - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD */ @Nullable Long add(Point point, M member); @@ -55,7 +55,7 @@ public interface BoundGeoOperations extends BoundKeyOperations { * @param point must not be {@literal null}. * @param member must not be {@literal null}. * @return Number of elements added. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD * @deprecated since 2.0, use {@link #add(Point, Object)}. */ @Deprecated @@ -70,7 +70,7 @@ default Long geoAdd(Point point, M member) { * @param location must not be {@literal null}. * @return Number of elements added. {@literal null} when used in pipeline / transaction. * @since 2.0 - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD */ @Nullable Long add(GeoLocation location); @@ -80,7 +80,7 @@ default Long geoAdd(Point point, M member) { * * @param location must not be {@literal null}. * @return Number of elements added. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD * @deprecated since 2.0, use {@link #add(GeoLocation)}. */ @Deprecated @@ -95,7 +95,7 @@ default Long geoAdd(GeoLocation location) { * @param memberCoordinateMap must not be {@literal null}. * @return Number of elements added. {@literal null} when used in pipeline / transaction. * @since 2.0 - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD */ @Nullable Long add(Map memberCoordinateMap); @@ -105,7 +105,7 @@ default Long geoAdd(GeoLocation location) { * * @param memberCoordinateMap must not be {@literal null}. * @return Number of elements added. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD * @deprecated since 2.0, use {@link #add(Map)}. */ @Deprecated @@ -120,7 +120,7 @@ default Long geoAdd(Map memberCoordinateMap) { * @param locations must not be {@literal null}. * @return Number of elements added. {@literal null} when used in pipeline / transaction. * @since 2.0 - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD */ @Nullable Long add(Iterable> locations); @@ -130,7 +130,7 @@ default Long geoAdd(Map memberCoordinateMap) { * * @param locations must not be {@literal null}. * @return Number of elements added. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD * @deprecated since 2.0, use {@link #add(Iterable)}. */ @Deprecated @@ -146,7 +146,7 @@ default Long geoAdd(Iterable> locations) { * @param member2 must not be {@literal null}. * @return can be {@literal null}. * @since 2.0 - * @see Redis Documentation: GEODIST + * @see Redis Documentation: GEODIST */ @Nullable Distance distance(M member1, M member2); @@ -157,7 +157,7 @@ default Long geoAdd(Iterable> locations) { * @param member1 must not be {@literal null}. * @param member2 must not be {@literal null}. * @return can be {@literal null}. - * @see Redis Documentation: GEODIST + * @see Redis Documentation: GEODIST * @deprecated since 2.0, use {@link #distance(Object, Object)}. */ @Deprecated @@ -174,7 +174,7 @@ default Distance geoDist(M member1, M member2) { * @param metric must not be {@literal null}. * @return can be {@literal null}. * @since 2.0 - * @see Redis Documentation: GEODIST + * @see Redis Documentation: GEODIST */ @Nullable Distance distance(M member1, M member2, Metric metric); @@ -186,7 +186,7 @@ default Distance geoDist(M member1, M member2) { * @param member2 must not be {@literal null}. * @param metric must not be {@literal null}. * @return can be {@literal null}. - * @see Redis Documentation: GEODIST + * @see Redis Documentation: GEODIST * @deprecated since 2.0, use {@link #distance(Object, Object, Metric)}. */ @Deprecated @@ -201,7 +201,7 @@ default Distance geoDist(M member1, M member2, Metric metric) { * @param members must not be {@literal null}. * @return never {@literal null} unless used in pipeline / transaction. * @since 2.0 - * @see Redis Documentation: GEOHASH + * @see Redis Documentation: GEOHASH */ @Nullable List hash(M... members); @@ -211,7 +211,7 @@ default Distance geoDist(M member1, M member2, Metric metric) { * * @param members must not be {@literal null}. * @return never {@literal null} unless used in pipeline / transaction. - * @see Redis Documentation: GEOHASH + * @see Redis Documentation: GEOHASH * @deprecated since 2.0, use {@link #hash(Object[])}. */ @Deprecated @@ -226,7 +226,7 @@ default List geoHash(M... members) { * @param members must not be {@literal null}. * @return never {@literal null} unless used in pipeline / transaction. * @since 2.0 - * @see Redis Documentation: GEOPOS + * @see Redis Documentation: GEOPOS */ @Nullable List position(M... members); @@ -236,7 +236,7 @@ default List geoHash(M... members) { * * @param members must not be {@literal null}. * @return never {@literal null} unless used in pipeline / transaction. - * @see Redis Documentation: GEOPOS + * @see Redis Documentation: GEOPOS * @deprecated since 2.0, use {@link #position(Object[])}. */ @Deprecated @@ -251,7 +251,7 @@ default List geoPos(M... members) { * @param within must not be {@literal null}. * @return never {@literal null} unless used in pipeline / transaction. * @since 2.0 - * @see Redis Documentation: GEORADIUS + * @see Redis Documentation: GEORADIUS */ @Nullable GeoResults> radius(Circle within); @@ -261,7 +261,7 @@ default List geoPos(M... members) { * * @param within must not be {@literal null}. * @return never {@literal null} unless used in pipeline / transaction. - * @see Redis Documentation: GEORADIUS + * @see Redis Documentation: GEORADIUS * @deprecated since 2.0, use {@link #radius(Circle)}. */ @Deprecated @@ -277,7 +277,7 @@ default GeoResults> geoRadius(Circle within) { * @param args must not be {@literal null}. * @return never {@literal null} unless used in pipeline / transaction. * @since 2.0 - * @see Redis Documentation: GEORADIUS + * @see Redis Documentation: GEORADIUS */ @Nullable GeoResults> radius(Circle within, GeoRadiusCommandArgs args); @@ -288,7 +288,7 @@ default GeoResults> geoRadius(Circle within) { * @param within must not be {@literal null}. * @param args must not be {@literal null}. * @return never {@literal null} unless used in pipeline / transaction. - * @see Redis Documentation: GEORADIUS + * @see Redis Documentation: GEORADIUS * @deprecated since 2.0, use {@link #radius(Circle, GeoRadiusCommandArgs)}. */ @Deprecated @@ -305,7 +305,7 @@ default GeoResults> geoRadius(Circle within, GeoRadiusCommandArgs * @param radius * @return never {@literal null} unless used in pipeline / transaction. * @since 2.0 - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER */ @Nullable GeoResults> radius(K key, M member, double radius); @@ -317,7 +317,7 @@ default GeoResults> geoRadius(Circle within, GeoRadiusCommandArgs * @param member must not be {@literal null}. * @param radius * @return never {@literal null} unless used in pipeline / transaction. - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER * @deprecated since 2.0, use {@link #radius(Object, Object, double)}. */ @Deprecated @@ -334,7 +334,7 @@ default GeoResults> geoRadiusByMember(K key, M member, double rad * @param distance must not be {@literal null}. * @return never {@literal null} unless used in pipeline / transaction. * @since 2.0 - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER */ @Nullable GeoResults> radius(M member, Distance distance); @@ -346,7 +346,7 @@ default GeoResults> geoRadiusByMember(K key, M member, double rad * @param member must not be {@literal null}. * @param distance must not be {@literal null}. * @return never {@literal null} unless used in pipeline / transaction. - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER * @deprecated since 2.0, use {@link #radius(Object, Distance)}. */ @Deprecated @@ -364,7 +364,7 @@ default GeoResults> geoRadiusByMember(M member, Distance distance * @param args must not be {@literal null}. * @return never {@literal null} unless used in pipeline / transaction. * @since 2.0 - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER */ @Nullable GeoResults> radius(M member, Distance distance, GeoRadiusCommandArgs args); @@ -377,7 +377,7 @@ default GeoResults> geoRadiusByMember(M member, Distance distance * @param distance must not be {@literal null}. * @param args must not be {@literal null}. * @return never {@literal null} unless used in pipeline / transaction. - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER * @deprecated since 2.0, use {@link #radius(Object, Distance, GeoRadiusCommandArgs)}. */ @Deprecated diff --git a/src/main/java/org/springframework/data/redis/core/BoundListOperations.java b/src/main/java/org/springframework/data/redis/core/BoundListOperations.java index 2781380034..4297172f15 100644 --- a/src/main/java/org/springframework/data/redis/core/BoundListOperations.java +++ b/src/main/java/org/springframework/data/redis/core/BoundListOperations.java @@ -34,7 +34,7 @@ public interface BoundListOperations extends BoundKeyOperations { * @param start * @param end * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: LRANGE + * @see Redis Documentation: LRANGE */ @Nullable List range(long start, long end); @@ -44,7 +44,7 @@ public interface BoundListOperations extends BoundKeyOperations { * * @param start * @param end - * @see Redis Documentation: LTRIM + * @see Redis Documentation: LTRIM */ void trim(long start, long end); @@ -52,7 +52,7 @@ public interface BoundListOperations extends BoundKeyOperations { * Get the size of list stored at the bound key. * * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: LLEN + * @see Redis Documentation: LLEN */ @Nullable Long size(); @@ -62,7 +62,7 @@ public interface BoundListOperations extends BoundKeyOperations { * * @param value * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: LPUSH + * @see Redis Documentation: LPUSH */ @Nullable Long leftPush(V value); @@ -72,7 +72,7 @@ public interface BoundListOperations extends BoundKeyOperations { * * @param values * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: LPUSH + * @see Redis Documentation: LPUSH */ @Nullable Long leftPushAll(V... values); @@ -82,7 +82,7 @@ public interface BoundListOperations extends BoundKeyOperations { * * @param value * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: LPUSHX + * @see Redis Documentation: LPUSHX */ @Nullable Long leftPushIfPresent(V value); @@ -92,7 +92,7 @@ public interface BoundListOperations extends BoundKeyOperations { * * @param value * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: LPUSH + * @see Redis Documentation: LPUSH */ @Nullable Long leftPush(V pivot, V value); @@ -102,7 +102,7 @@ public interface BoundListOperations extends BoundKeyOperations { * * @param value * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: RPUSH + * @see Redis Documentation: RPUSH */ @Nullable Long rightPush(V value); @@ -112,7 +112,7 @@ public interface BoundListOperations extends BoundKeyOperations { * * @param values * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: RPUSH + * @see Redis Documentation: RPUSH */ @Nullable Long rightPushAll(V... values); @@ -122,7 +122,7 @@ public interface BoundListOperations extends BoundKeyOperations { * * @param value * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: RPUSHX + * @see Redis Documentation: RPUSHX */ @Nullable Long rightPushIfPresent(V value); @@ -132,7 +132,7 @@ public interface BoundListOperations extends BoundKeyOperations { * * @param value * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: RPUSH + * @see Redis Documentation: RPUSH */ @Nullable Long rightPush(V pivot, V value); @@ -142,7 +142,7 @@ public interface BoundListOperations extends BoundKeyOperations { * * @param index * @param value - * @see Redis Documentation: LSET + * @see Redis Documentation: LSET */ void set(long index, V value); @@ -152,7 +152,7 @@ public interface BoundListOperations extends BoundKeyOperations { * @param count * @param value * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: LREM + * @see Redis Documentation: LREM */ @Nullable Long remove(long count, Object value); @@ -162,7 +162,7 @@ public interface BoundListOperations extends BoundKeyOperations { * * @param index * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: LINDEX + * @see Redis Documentation: LINDEX */ @Nullable V index(long index); @@ -171,7 +171,7 @@ public interface BoundListOperations extends BoundKeyOperations { * Removes and returns first element in list stored at the bound key. * * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: LPOP + * @see Redis Documentation: LPOP */ @Nullable V leftPop(); @@ -183,7 +183,7 @@ public interface BoundListOperations extends BoundKeyOperations { * @param timeout * @param unit must not be {@literal null}. * @return {@literal null} when timeout reached or used in pipeline / transaction. - * @see Redis Documentation: BLPOP + * @see Redis Documentation: BLPOP */ @Nullable V leftPop(long timeout, TimeUnit unit); @@ -192,7 +192,7 @@ public interface BoundListOperations extends BoundKeyOperations { * Removes and returns last element in list stored at the bound key. * * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: RPOP + * @see Redis Documentation: RPOP */ @Nullable V rightPop(); @@ -204,7 +204,7 @@ public interface BoundListOperations extends BoundKeyOperations { * @param timeout * @param unit must not be {@literal null}. * @return {@literal null} when timeout reached or used in pipeline / transaction. - * @see Redis Documentation: BRPOP + * @see Redis Documentation: BRPOP */ @Nullable V rightPop(long timeout, TimeUnit unit); diff --git a/src/main/java/org/springframework/data/redis/core/BoundSetOperations.java b/src/main/java/org/springframework/data/redis/core/BoundSetOperations.java index a79d6ea407..ddd0088a5e 100644 --- a/src/main/java/org/springframework/data/redis/core/BoundSetOperations.java +++ b/src/main/java/org/springframework/data/redis/core/BoundSetOperations.java @@ -34,7 +34,7 @@ public interface BoundSetOperations extends BoundKeyOperations { * * @param values * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SADD + * @see Redis Documentation: SADD */ @Nullable Long add(V... values); @@ -44,7 +44,7 @@ public interface BoundSetOperations extends BoundKeyOperations { * * @param values * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SREM + * @see Redis Documentation: SREM */ @Nullable Long remove(Object... values); @@ -53,7 +53,7 @@ public interface BoundSetOperations extends BoundKeyOperations { * Remove and return a random member from set at the bound key. * * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SPOP + * @see Redis Documentation: SPOP */ @Nullable V pop(); @@ -64,7 +64,7 @@ public interface BoundSetOperations extends BoundKeyOperations { * @param destKey must not be {@literal null}. * @param value * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SMOVE + * @see Redis Documentation: SMOVE */ @Nullable Boolean move(K destKey, V value); @@ -73,7 +73,7 @@ public interface BoundSetOperations extends BoundKeyOperations { * Get size of set at the bound key. * * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SCARD + * @see Redis Documentation: SCARD */ @Nullable Long size(); @@ -83,7 +83,7 @@ public interface BoundSetOperations extends BoundKeyOperations { * * @param o * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SISMEMBER + * @see Redis Documentation: SISMEMBER */ @Nullable Boolean isMember(Object o); @@ -93,7 +93,7 @@ public interface BoundSetOperations extends BoundKeyOperations { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SINTER + * @see Redis Documentation: SINTER */ @Nullable Set intersect(K key); @@ -103,7 +103,7 @@ public interface BoundSetOperations extends BoundKeyOperations { * * @param keys must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SINTER + * @see Redis Documentation: SINTER */ @Nullable Set intersect(Collection keys); @@ -113,7 +113,7 @@ public interface BoundSetOperations extends BoundKeyOperations { * * @param key must not be {@literal null}. * @param destKey must not be {@literal null}. - * @see Redis Documentation: SINTERSTORE + * @see Redis Documentation: SINTERSTORE */ void intersectAndStore(K key, K destKey); @@ -122,7 +122,7 @@ public interface BoundSetOperations extends BoundKeyOperations { * * @param keys must not be {@literal null}. * @param destKey must not be {@literal null}. - * @see Redis Documentation: SINTERSTORE + * @see Redis Documentation: SINTERSTORE */ void intersectAndStore(Collection keys, K destKey); @@ -131,7 +131,7 @@ public interface BoundSetOperations extends BoundKeyOperations { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SUNION + * @see Redis Documentation: SUNION */ @Nullable Set union(K key); @@ -141,7 +141,7 @@ public interface BoundSetOperations extends BoundKeyOperations { * * @param keys must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SUNION + * @see Redis Documentation: SUNION */ @Nullable Set union(Collection keys); @@ -151,7 +151,7 @@ public interface BoundSetOperations extends BoundKeyOperations { * * @param key must not be {@literal null}. * @param destKey must not be {@literal null}. - * @see Redis Documentation: SUNIONSTORE + * @see Redis Documentation: SUNIONSTORE */ void unionAndStore(K key, K destKey); @@ -160,7 +160,7 @@ public interface BoundSetOperations extends BoundKeyOperations { * * @param keys must not be {@literal null}. * @param destKey must not be {@literal null}. - * @see Redis Documentation: SUNIONSTORE + * @see Redis Documentation: SUNIONSTORE */ void unionAndStore(Collection keys, K destKey); @@ -169,7 +169,7 @@ public interface BoundSetOperations extends BoundKeyOperations { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SDIFF + * @see Redis Documentation: SDIFF */ @Nullable Set diff(K key); @@ -179,7 +179,7 @@ public interface BoundSetOperations extends BoundKeyOperations { * * @param keys must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SDIFF + * @see Redis Documentation: SDIFF */ @Nullable Set diff(Collection keys); @@ -189,7 +189,7 @@ public interface BoundSetOperations extends BoundKeyOperations { * * @param keys must not be {@literal null}. * @param destKey must not be {@literal null}. - * @see Redis Documentation: SDIFFSTORE + * @see Redis Documentation: SDIFFSTORE */ void diffAndStore(K keys, K destKey); @@ -198,7 +198,7 @@ public interface BoundSetOperations extends BoundKeyOperations { * * @param keys must not be {@literal null}. * @param destKey must not be {@literal null}. - * @see Redis Documentation: SDIFFSTORE + * @see Redis Documentation: SDIFFSTORE */ void diffAndStore(Collection keys, K destKey); @@ -206,7 +206,7 @@ public interface BoundSetOperations extends BoundKeyOperations { * Get all elements of set at the bound key. * * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SMEMBERS + * @see Redis Documentation: SMEMBERS */ @Nullable Set members(); @@ -215,7 +215,7 @@ public interface BoundSetOperations extends BoundKeyOperations { * Get random element from set at the bound key. * * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SRANDMEMBER + * @see Redis Documentation: SRANDMEMBER */ @Nullable V randomMember(); @@ -225,7 +225,7 @@ public interface BoundSetOperations extends BoundKeyOperations { * * @param count * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SRANDMEMBER + * @see Redis Documentation: SRANDMEMBER */ @Nullable Set distinctRandomMembers(long count); @@ -235,7 +235,7 @@ public interface BoundSetOperations extends BoundKeyOperations { * * @param count * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SRANDMEMBER + * @see Redis Documentation: SRANDMEMBER */ @Nullable List randomMembers(long count); diff --git a/src/main/java/org/springframework/data/redis/core/BoundStreamOperations.java b/src/main/java/org/springframework/data/redis/core/BoundStreamOperations.java index fe94b6c89c..7f3decc3b5 100644 --- a/src/main/java/org/springframework/data/redis/core/BoundStreamOperations.java +++ b/src/main/java/org/springframework/data/redis/core/BoundStreamOperations.java @@ -42,7 +42,7 @@ public interface BoundStreamOperations { * @param group name of the consumer group. * @param recordIds record Id's to acknowledge. * @return length of acknowledged records. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XACK + * @see Redis Documentation: XACK */ @Nullable Long acknowledge(String group, String... recordIds); @@ -52,7 +52,7 @@ public interface BoundStreamOperations { * * @param body record body. * @return the record Id. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XADD + * @see Redis Documentation: XADD */ @Nullable RecordId add(Map body); @@ -63,7 +63,7 @@ public interface BoundStreamOperations { * * @param recordIds stream record Id's. * @return number of removed entries. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XDEL + * @see Redis Documentation: XDEL */ @Nullable Long delete(String... recordIds); @@ -100,7 +100,7 @@ public interface BoundStreamOperations { * Get the length of a stream. * * @return length of the stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XLEN + * @see Redis Documentation: XLEN */ @Nullable Long size(); @@ -110,7 +110,7 @@ public interface BoundStreamOperations { * * @param range must not be {@literal null}. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XRANGE + * @see Redis Documentation: XRANGE */ @Nullable default List> range(Range range) { @@ -123,7 +123,7 @@ default List> range(Range range) { * @param range must not be {@literal null}. * @param limit must not be {@literal null}. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XRANGE + * @see Redis Documentation: XRANGE */ @Nullable List> range(Range range, Limit limit); @@ -133,7 +133,7 @@ default List> range(Range range) { * * @param readOffset the offset to read from. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XREAD + * @see Redis Documentation: XREAD */ @Nullable default List> read(ReadOffset readOffset) { @@ -146,7 +146,7 @@ default List> read(ReadOffset readOffset) { * @param readOptions read arguments. * @param readOffset the offset to read from. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XREAD + * @see Redis Documentation: XREAD */ @Nullable List> read(StreamReadOptions readOptions, ReadOffset readOffset); @@ -157,7 +157,7 @@ default List> read(ReadOffset readOffset) { * @param consumer consumer/group. * @param readOffset the offset to read from. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XREADGROUP + * @see Redis Documentation: XREADGROUP */ @Nullable default List> read(Consumer consumer, ReadOffset readOffset) { @@ -171,7 +171,7 @@ default List> read(Consumer consumer, ReadOffset readOffset * @param readOptions read arguments. * @param readOffset the offset to read from. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XREADGROUP + * @see Redis Documentation: XREADGROUP */ @Nullable List> read(Consumer consumer, StreamReadOptions readOptions, ReadOffset readOffset); @@ -181,7 +181,7 @@ default List> read(Consumer consumer, ReadOffset readOffset * * @param range must not be {@literal null}. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XREVRANGE + * @see Redis Documentation: XREVRANGE */ @Nullable default List> reverseRange(Range range) { @@ -194,7 +194,7 @@ default List> reverseRange(Range range) { * @param range must not be {@literal null}. * @param limit must not be {@literal null}. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XREVRANGE + * @see Redis Documentation: XREVRANGE */ @Nullable List> reverseRange(Range range, Limit limit); @@ -204,7 +204,7 @@ default List> reverseRange(Range range) { * * @param count length of the stream. * @return number of removed entries. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XTRIM + * @see Redis Documentation: XTRIM */ @Nullable Long trim(long count); diff --git a/src/main/java/org/springframework/data/redis/core/BoundValueOperations.java b/src/main/java/org/springframework/data/redis/core/BoundValueOperations.java index cb9b6db5d3..3d5d3b7f2d 100644 --- a/src/main/java/org/springframework/data/redis/core/BoundValueOperations.java +++ b/src/main/java/org/springframework/data/redis/core/BoundValueOperations.java @@ -35,7 +35,7 @@ public interface BoundValueOperations extends BoundKeyOperations { * Set {@code value} for the bound key. * * @param value must not be {@literal null}. - * @see Redis Documentation: SET + * @see Redis Documentation: SET */ void set(V value); @@ -45,7 +45,7 @@ public interface BoundValueOperations extends BoundKeyOperations { * @param value must not be {@literal null}. * @param timeout * @param unit must not be {@literal null}. - * @see Redis Documentation: SETEX + * @see Redis Documentation: SETEX */ void set(V value, long timeout, TimeUnit unit); @@ -55,7 +55,7 @@ public interface BoundValueOperations extends BoundKeyOperations { * @param value must not be {@literal null}. * @param timeout must not be {@literal null}. * @throws IllegalArgumentException if either {@code value} or {@code timeout} is not present. - * @see Redis Documentation: SETEX + * @see Redis Documentation: SETEX * @since 2.1 */ default void set(V value, Duration timeout) { @@ -74,7 +74,7 @@ default void set(V value, Duration timeout) { * * @param value must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SETNX + * @see Redis Documentation: SETNX */ @Nullable Boolean setIfAbsent(V value); @@ -87,7 +87,7 @@ default void set(V value, Duration timeout) { * @param unit must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 2.1 - * @see Redis Documentation: SET + * @see Redis Documentation: SET */ @Nullable Boolean setIfAbsent(V value, long timeout, TimeUnit unit); @@ -99,7 +99,7 @@ default void set(V value, Duration timeout) { * @param timeout must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @throws IllegalArgumentException if either {@code value} or {@code timeout} is not present. - * @see Redis Documentation: SET + * @see Redis Documentation: SET * @since 2.1 */ @Nullable @@ -120,7 +120,7 @@ default Boolean setIfAbsent(V value, Duration timeout) { * @param value must not be {@literal null}. * @return command result indicating if the key has been set. * @throws IllegalArgumentException if {@code value} is not present. - * @see Redis Documentation: SET + * @see Redis Documentation: SET * @since 2.1 */ @Nullable @@ -134,7 +134,7 @@ default Boolean setIfAbsent(V value, Duration timeout) { * @param unit must not be {@literal null}. * @return command result indicating if the key has been set. * @throws IllegalArgumentException if either {@code value} or {@code timeout} is not present. - * @see Redis Documentation: SET + * @see Redis Documentation: SET * @since 2.1 */ @Nullable @@ -147,7 +147,7 @@ default Boolean setIfAbsent(V value, Duration timeout) { * @param timeout must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @throws IllegalArgumentException if either {@code value} or {@code timeout} is not present. - * @see Redis Documentation: SET + * @see Redis Documentation: SET * @since 2.1 */ @Nullable @@ -166,7 +166,7 @@ default Boolean setIfPresent(V value, Duration timeout) { * Get the value of the bound key. * * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GET + * @see Redis Documentation: GET */ @Nullable V get(); @@ -175,7 +175,7 @@ default Boolean setIfPresent(V value, Duration timeout) { * Set {@code value} of the bound key and return its old value. * * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GETSET + * @see Redis Documentation: GETSET */ @Nullable V getAndSet(V value); @@ -185,7 +185,7 @@ default Boolean setIfPresent(V value, Duration timeout) { * * @return {@literal null} when used in pipeline / transaction. * @since 2.1 - * @see Redis Documentation: INCR + * @see Redis Documentation: INCR */ @Nullable Long increment(); @@ -195,7 +195,7 @@ default Boolean setIfPresent(V value, Duration timeout) { * * @param delta * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: INCRBY + * @see Redis Documentation: INCRBY */ @Nullable Long increment(long delta); @@ -205,7 +205,7 @@ default Boolean setIfPresent(V value, Duration timeout) { * * @param delta * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: INCRBYFLOAT + * @see Redis Documentation: INCRBYFLOAT */ @Nullable Double increment(double delta); @@ -215,7 +215,7 @@ default Boolean setIfPresent(V value, Duration timeout) { * * @return {@literal null} when used in pipeline / transaction. * @since 2.1 - * @see Redis Documentation: DECR + * @see Redis Documentation: DECR */ @Nullable Long decrement(); @@ -226,7 +226,7 @@ default Boolean setIfPresent(V value, Duration timeout) { * @param delta * @return {@literal null} when used in pipeline / transaction. * @since 2.1 - * @see Redis Documentation: DECRBY + * @see Redis Documentation: DECRBY */ @Nullable Long decrement(long delta); @@ -236,7 +236,7 @@ default Boolean setIfPresent(V value, Duration timeout) { * * @param value must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: APPEND + * @see Redis Documentation: APPEND */ @Nullable Integer append(String value); @@ -247,7 +247,7 @@ default Boolean setIfPresent(V value, Duration timeout) { * @param start * @param end * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GETRANGE + * @see Redis Documentation: GETRANGE */ @Nullable String get(long start, long end); @@ -257,7 +257,7 @@ default Boolean setIfPresent(V value, Duration timeout) { * * @param value must not be {@literal null}. * @param offset - * @see Redis Documentation: SETRANGE + * @see Redis Documentation: SETRANGE */ void set(V value, long offset); @@ -265,7 +265,7 @@ default Boolean setIfPresent(V value, Duration timeout) { * Get the length of the value stored at the bound key. * * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: STRLEN + * @see Redis Documentation: STRLEN */ @Nullable Long size(); diff --git a/src/main/java/org/springframework/data/redis/core/BoundZSetOperations.java b/src/main/java/org/springframework/data/redis/core/BoundZSetOperations.java index b07dbeac6e..f975ed209e 100644 --- a/src/main/java/org/springframework/data/redis/core/BoundZSetOperations.java +++ b/src/main/java/org/springframework/data/redis/core/BoundZSetOperations.java @@ -42,7 +42,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * @param score the score. * @param value the value. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZADD + * @see Redis Documentation: ZADD */ @Nullable Boolean add(V value, double score); @@ -52,7 +52,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * * @param tuples must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZADD + * @see Redis Documentation: ZADD */ @Nullable Long add(Set> tuples); @@ -62,7 +62,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * * @param values must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREM + * @see Redis Documentation: ZREM */ @Nullable Long remove(Object... values); @@ -73,7 +73,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * @param delta * @param value the value. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZINCRBY + * @see Redis Documentation: ZINCRBY */ @Nullable Double incrementScore(V value, double delta); @@ -83,7 +83,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * * @param o the value. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZRANK + * @see Redis Documentation: ZRANK */ @Nullable Long rank(Object o); @@ -93,7 +93,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * * @param o the value. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREVRANK + * @see Redis Documentation: ZREVRANK */ @Nullable Long reverseRank(Object o); @@ -104,7 +104,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * @param start * @param end * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZRANGE + * @see Redis Documentation: ZRANGE */ @Nullable Set range(long start, long end); @@ -115,7 +115,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * @param start * @param end * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZRANGE + * @see Redis Documentation: ZRANGE */ @Nullable Set> rangeWithScores(long start, long end); @@ -126,7 +126,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * @param min * @param max * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE */ @Nullable Set rangeByScore(double min, double max); @@ -137,7 +137,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * @param min * @param max * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE */ @Nullable Set> rangeByScoreWithScores(double min, double max); @@ -148,7 +148,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * @param start * @param end * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREVRANGE + * @see Redis Documentation: ZREVRANGE */ @Nullable Set reverseRange(long start, long end); @@ -159,7 +159,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * @param start * @param end * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREVRANGE + * @see Redis Documentation: ZREVRANGE */ @Nullable Set> reverseRangeWithScores(long start, long end); @@ -170,7 +170,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * @param min * @param max * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREVRANGE + * @see Redis Documentation: ZREVRANGE */ @Nullable Set reverseRangeByScore(double min, double max); @@ -182,7 +182,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * @param min * @param max * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREVRANGEBYSCORE + * @see Redis Documentation: ZREVRANGEBYSCORE */ @Nullable Set> reverseRangeByScoreWithScores(double min, double max); @@ -193,7 +193,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * @param min * @param max * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZCOUNT + * @see Redis Documentation: ZCOUNT */ @Nullable Long count(double min, double max); @@ -203,7 +203,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * * @see #zCard() * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZCARD + * @see Redis Documentation: ZCARD */ @Nullable Long size(); @@ -213,7 +213,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * * @return {@literal null} when used in pipeline / transaction. * @since 1.3 - * @see Redis Documentation: ZCARD + * @see Redis Documentation: ZCARD */ @Nullable Long zCard(); @@ -223,7 +223,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * * @param o the value. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZSCORE + * @see Redis Documentation: ZSCORE */ @Nullable Double score(Object o); @@ -234,7 +234,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * @param start * @param end * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREMRANGEBYRANK + * @see Redis Documentation: ZREMRANGEBYRANK */ @Nullable Long removeRange(long start, long end); @@ -245,7 +245,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * @param min * @param max * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREMRANGEBYSCORE + * @see Redis Documentation: ZREMRANGEBYSCORE */ @Nullable Long removeRangeByScore(double min, double max); @@ -256,7 +256,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * @param otherKey must not be {@literal null}. * @param destKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZUNIONSTORE + * @see Redis Documentation: ZUNIONSTORE */ @Nullable Long unionAndStore(K otherKey, K destKey); @@ -267,7 +267,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * @param otherKeys must not be {@literal null}. * @param destKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZUNIONSTORE + * @see Redis Documentation: ZUNIONSTORE */ @Nullable Long unionAndStore(Collection otherKeys, K destKey); @@ -280,7 +280,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * @param aggregate must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 2.1 - * @see Redis Documentation: ZUNIONSTORE + * @see Redis Documentation: ZUNIONSTORE */ @Nullable Long unionAndStore(Collection otherKeys, K destKey, Aggregate aggregate); @@ -294,7 +294,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * @param weights must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 2.1 - * @see Redis Documentation: ZUNIONSTORE + * @see Redis Documentation: ZUNIONSTORE */ @Nullable Long unionAndStore(Collection otherKeys, K destKey, Aggregate aggregate, Weights weights); @@ -305,7 +305,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * @param otherKey must not be {@literal null}. * @param destKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZINTERSTORE + * @see Redis Documentation: ZINTERSTORE */ @Nullable Long intersectAndStore(K otherKey, K destKey); @@ -316,7 +316,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * @param otherKeys must not be {@literal null}. * @param destKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZINTERSTORE + * @see Redis Documentation: ZINTERSTORE */ @Nullable Long intersectAndStore(Collection otherKeys, K destKey); @@ -329,7 +329,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * @param aggregate must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 2.1 - * @see Redis Documentation: ZINTERSTORE + * @see Redis Documentation: ZINTERSTORE */ @Nullable Long intersectAndStore(Collection otherKeys, K destKey, Aggregate aggregate); @@ -343,7 +343,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * @param weights must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 2.1 - * @see Redis Documentation: ZINTERSTORE + * @see Redis Documentation: ZINTERSTORE */ @Nullable Long intersectAndStore(Collection otherKeys, K destKey, Aggregate aggregate, Weights weights); @@ -365,7 +365,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * @param range must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 1.7 - * @see Redis Documentation: ZRANGEBYLEX + * @see Redis Documentation: ZRANGEBYLEX */ @Nullable Set rangeByLex(Range range); @@ -379,7 +379,7 @@ public interface BoundZSetOperations extends BoundKeyOperations { * @param limit can be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 1.7 - * @see Redis Documentation: ZRANGEBYLEX + * @see Redis Documentation: ZRANGEBYLEX */ @Nullable Set rangeByLex(Range range, Limit limit); diff --git a/src/main/java/org/springframework/data/redis/core/GeoOperations.java b/src/main/java/org/springframework/data/redis/core/GeoOperations.java index 7ae4a84426..f134509e32 100644 --- a/src/main/java/org/springframework/data/redis/core/GeoOperations.java +++ b/src/main/java/org/springframework/data/redis/core/GeoOperations.java @@ -33,7 +33,7 @@ * @author Ninad Divadkar * @author Christoph Strobl * @author Mark Paluch - * @see Redis Documentation: Geo Commands + * @see Redis Documentation: Geo Commands * @since 1.8 */ public interface GeoOperations { @@ -46,7 +46,7 @@ public interface GeoOperations { * @param member must not be {@literal null}. * @return Number of elements added. {@literal null} when used in pipeline / transaction. * @since 2.0 - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD */ @Nullable Long add(K key, Point point, M member); @@ -58,7 +58,7 @@ public interface GeoOperations { * @param point must not be {@literal null}. * @param member must not be {@literal null}. * @return Number of elements added. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD * @deprecated since 2.0, use {@link #add(Object, Point, Object)}. */ @Deprecated @@ -74,7 +74,7 @@ default Long geoAdd(K key, Point point, M member) { * @param location must not be {@literal null}. * @return Number of elements added. {@literal null} when used in pipeline / transaction. * @since 2.0 - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD */ @Nullable Long add(K key, GeoLocation location); @@ -85,7 +85,7 @@ default Long geoAdd(K key, Point point, M member) { * @param key must not be {@literal null}. * @param location must not be {@literal null}. * @return Number of elements added. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD * @deprecated since 2.0, use {@link #add(Object, GeoLocation)}. */ @Deprecated @@ -101,7 +101,7 @@ default Long geoAdd(K key, GeoLocation location) { * @param memberCoordinateMap must not be {@literal null}. * @return Number of elements added. {@literal null} when used in pipeline / transaction. * @since 2.0 - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD */ @Nullable Long add(K key, Map memberCoordinateMap); @@ -112,7 +112,7 @@ default Long geoAdd(K key, GeoLocation location) { * @param key must not be {@literal null}. * @param memberCoordinateMap must not be {@literal null}. * @return Number of elements added. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD * @deprecated since 2.0, use {@link #add(Object, Map)}. */ @Deprecated @@ -128,7 +128,7 @@ default Long geoAdd(K key, Map memberCoordinateMap) { * @param locations must not be {@literal null}. * @return Number of elements added. {@literal null} when used in pipeline / transaction. * @since 2.0 - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD */ @Nullable Long add(K key, Iterable> locations); @@ -139,7 +139,7 @@ default Long geoAdd(K key, Map memberCoordinateMap) { * @param key must not be {@literal null}. * @param locations must not be {@literal null}. * @return Number of elements added. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD * @deprecated since 2.0, use {@link #add(Object, Iterable)}. */ @Deprecated @@ -156,7 +156,7 @@ default Long geoAdd(K key, Iterable> locations) { * @param member2 must not be {@literal null}. * @return can be {@literal null}. * @since 2.0 - * @see Redis Documentation: GEODIST + * @see Redis Documentation: GEODIST */ @Nullable Distance distance(K key, M member1, M member2); @@ -168,7 +168,7 @@ default Long geoAdd(K key, Iterable> locations) { * @param member1 must not be {@literal null}. * @param member2 must not be {@literal null}. * @return can be {@literal null}. - * @see Redis Documentation: GEODIST + * @see Redis Documentation: GEODIST * @deprecated since 2.0, use {@link #distance(Object, Object, Object)}. */ @Deprecated @@ -186,7 +186,7 @@ default Distance geoDist(K key, M member1, M member2) { * @param metric must not be {@literal null}. * @return can be {@literal null}. * @since 2.0 - * @see Redis Documentation: GEODIST + * @see Redis Documentation: GEODIST */ @Nullable Distance distance(K key, M member1, M member2, Metric metric); @@ -199,7 +199,7 @@ default Distance geoDist(K key, M member1, M member2) { * @param member2 must not be {@literal null}. * @param metric must not be {@literal null}. * @return can be {@literal null}. - * @see Redis Documentation: GEODIST + * @see Redis Documentation: GEODIST * @deprecated since 2.0, use {@link #distance(Object, Object, Object, Metric)}. */ @Deprecated @@ -215,7 +215,7 @@ default Distance geoDist(K key, M member1, M member2, Metric metric) { * @param members must not be {@literal null}. * @return never {@literal null} unless used in pipeline / transaction. * @since 2.0 - * @see Redis Documentation: GEOHASH + * @see Redis Documentation: GEOHASH */ @Nullable List hash(K key, M... members); @@ -226,7 +226,7 @@ default Distance geoDist(K key, M member1, M member2, Metric metric) { * @param key must not be {@literal null}. * @param members must not be {@literal null}. * @return never {@literal null} unless used in pipeline / transaction. - * @see Redis Documentation: GEOHASH + * @see Redis Documentation: GEOHASH * @deprecated since 2.0, use {@link #hash(Object, Object[])}. */ @Deprecated @@ -242,7 +242,7 @@ default List geoHash(K key, M... members) { * @param members must not be {@literal null}. * @return never {@literal null} unless used in pipeline / transaction. * @since 2.0 - * @see Redis Documentation: GEOPOS + * @see Redis Documentation: GEOPOS */ @Nullable List position(K key, M... members); @@ -253,7 +253,7 @@ default List geoHash(K key, M... members) { * @param key must not be {@literal null}. * @param members must not be {@literal null}. * @return never {@literal null} unless used in pipeline / transaction. - * @see Redis Documentation: GEOPOS + * @see Redis Documentation: GEOPOS * @deprecated since 2.0, use {@link #position(Object, Object[])}. */ @Deprecated @@ -269,7 +269,7 @@ default List geoPos(K key, M... members) { * @param within must not be {@literal null}. * @return never {@literal null} unless used in pipeline / transaction. * @since 2.0 - * @see Redis Documentation: GEORADIUS + * @see Redis Documentation: GEORADIUS */ @Nullable GeoResults> radius(K key, Circle within); @@ -280,7 +280,7 @@ default List geoPos(K key, M... members) { * @param key must not be {@literal null}. * @param within must not be {@literal null}. * @return never {@literal null} unless used in pipeline / transaction. - * @see Redis Documentation: GEORADIUS + * @see Redis Documentation: GEORADIUS * @deprecated since 2.0, use {@link #radius(Object, Circle)}. */ @Deprecated @@ -297,7 +297,7 @@ default GeoResults> geoRadius(K key, Circle within) { * @param args must not be {@literal null}. * @return never {@literal null} unless used in pipeline / transaction. * @since 2.0 - * @see Redis Documentation: GEORADIUS + * @see Redis Documentation: GEORADIUS */ @Nullable GeoResults> radius(K key, Circle within, GeoRadiusCommandArgs args); @@ -309,7 +309,7 @@ default GeoResults> geoRadius(K key, Circle within) { * @param within must not be {@literal null}. * @param args must not be {@literal null}. * @return never {@literal null} unless used in pipeline / transaction. - * @see Redis Documentation: GEORADIUS + * @see Redis Documentation: GEORADIUS * @deprecated since 2.0, use {@link #radius(Object, Circle, GeoRadiusCommandArgs)}. */ @Deprecated @@ -327,7 +327,7 @@ default GeoResults> geoRadius(K key, Circle within, GeoRadiusComm * @param radius * @return never {@literal null} unless used in pipeline / transaction. * @since 2.0 - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER */ @Nullable GeoResults> radius(K key, M member, double radius); @@ -340,7 +340,7 @@ default GeoResults> geoRadius(K key, Circle within, GeoRadiusComm * @param member must not be {@literal null}. * @param radius * @return never {@literal null} unless used in pipeline / transaction. - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER * @deprecated since 2.0, use {@link #radius(Object, Object, double)}. */ @Deprecated @@ -358,7 +358,7 @@ default GeoResults> geoRadiusByMember(K key, M member, double rad * @param distance must not be {@literal null}. * @return never {@literal null} unless used in pipeline / transaction. * @since 2.0 - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER */ @Nullable GeoResults> radius(K key, M member, Distance distance); @@ -371,7 +371,7 @@ default GeoResults> geoRadiusByMember(K key, M member, double rad * @param member must not be {@literal null}. * @param distance must not be {@literal null}. * @return never {@literal null} unless used in pipeline / transaction. - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER * @deprecated since 2.0, use {@link #radius(Object, Object, Distance)}. */ @Deprecated @@ -390,7 +390,7 @@ default GeoResults> geoRadiusByMember(K key, M member, Distance d * @param args must not be {@literal null}. * @return never {@literal null} unless used in pipeline / transaction. * @since 2.0 - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER */ @Nullable GeoResults> radius(K key, M member, Distance distance, GeoRadiusCommandArgs args); @@ -404,7 +404,7 @@ default GeoResults> geoRadiusByMember(K key, M member, Distance d * @param distance must not be {@literal null}. * @param args must not be {@literal null}. * @return never {@literal null} unless used in pipeline / transaction. - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER * @deprecated since 2.0, use {@link #radius(Object, Object, Distance, GeoRadiusCommandArgs)}. */ @Deprecated diff --git a/src/main/java/org/springframework/data/redis/core/IndexWriter.java b/src/main/java/org/springframework/data/redis/core/IndexWriter.java index 7decb547af..5481dbc56c 100644 --- a/src/main/java/org/springframework/data/redis/core/IndexWriter.java +++ b/src/main/java/org/springframework/data/redis/core/IndexWriter.java @@ -32,7 +32,7 @@ import org.springframework.util.ObjectUtils; /** - * {@link IndexWriter} takes care of writing secondary index structures to + * {@link IndexWriter} takes care of writing secondary index structures to * Redis. Depending on the type of {@link IndexedData} it uses eg. Sets with specific names to add actually referenced * keys to. While doing so {@link IndexWriter} also keeps track of all indexes associated with the root types key, which * allows to remove the root key from all indexes in case of deletion. diff --git a/src/main/java/org/springframework/data/redis/core/ListOperations.java b/src/main/java/org/springframework/data/redis/core/ListOperations.java index f79259d89d..21e97e903c 100644 --- a/src/main/java/org/springframework/data/redis/core/ListOperations.java +++ b/src/main/java/org/springframework/data/redis/core/ListOperations.java @@ -39,7 +39,7 @@ public interface ListOperations { * @param start * @param end * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: LRANGE + * @see Redis Documentation: LRANGE */ @Nullable List range(K key, long start, long end); @@ -50,7 +50,7 @@ public interface ListOperations { * @param key must not be {@literal null}. * @param start * @param end - * @see Redis Documentation: LTRIM + * @see Redis Documentation: LTRIM */ void trim(K key, long start, long end); @@ -59,7 +59,7 @@ public interface ListOperations { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: LLEN + * @see Redis Documentation: LLEN */ @Nullable Long size(K key); @@ -70,7 +70,7 @@ public interface ListOperations { * @param key must not be {@literal null}. * @param value * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: LPUSH + * @see Redis Documentation: LPUSH */ @Nullable Long leftPush(K key, V value); @@ -81,7 +81,7 @@ public interface ListOperations { * @param key must not be {@literal null}. * @param values * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: LPUSH + * @see Redis Documentation: LPUSH */ @Nullable Long leftPushAll(K key, V... values); @@ -93,7 +93,7 @@ public interface ListOperations { * @param values must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 1.5 - * @see Redis Documentation: LPUSH + * @see Redis Documentation: LPUSH */ @Nullable Long leftPushAll(K key, Collection values); @@ -104,7 +104,7 @@ public interface ListOperations { * @param key must not be {@literal null}. * @param value * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: LPUSHX + * @see Redis Documentation: LPUSHX */ @Nullable Long leftPushIfPresent(K key, V value); @@ -115,7 +115,7 @@ public interface ListOperations { * @param key must not be {@literal null}. * @param value * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: LPUSH + * @see Redis Documentation: LPUSH */ @Nullable Long leftPush(K key, V pivot, V value); @@ -126,7 +126,7 @@ public interface ListOperations { * @param key must not be {@literal null}. * @param value * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: RPUSH + * @see Redis Documentation: RPUSH */ @Nullable Long rightPush(K key, V value); @@ -137,7 +137,7 @@ public interface ListOperations { * @param key must not be {@literal null}. * @param values * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: RPUSH + * @see Redis Documentation: RPUSH */ @Nullable Long rightPushAll(K key, V... values); @@ -149,7 +149,7 @@ public interface ListOperations { * @param values * @return {@literal null} when used in pipeline / transaction. * @since 1.5 - * @see Redis Documentation: RPUSH + * @see Redis Documentation: RPUSH */ @Nullable Long rightPushAll(K key, Collection values); @@ -160,7 +160,7 @@ public interface ListOperations { * @param key must not be {@literal null}. * @param value * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: RPUSHX + * @see Redis Documentation: RPUSHX */ @Nullable Long rightPushIfPresent(K key, V value); @@ -171,7 +171,7 @@ public interface ListOperations { * @param key must not be {@literal null}. * @param value * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: RPUSH + * @see Redis Documentation: RPUSH */ @Nullable Long rightPush(K key, V pivot, V value); @@ -182,7 +182,7 @@ public interface ListOperations { * @param key must not be {@literal null}. * @param index * @param value - * @see Redis Documentation: LSET + * @see Redis Documentation: LSET */ void set(K key, long index, V value); @@ -193,7 +193,7 @@ public interface ListOperations { * @param count * @param value * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: LREM + * @see Redis Documentation: LREM */ @Nullable Long remove(K key, long count, Object value); @@ -204,7 +204,7 @@ public interface ListOperations { * @param key must not be {@literal null}. * @param index * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: LINDEX + * @see Redis Documentation: LINDEX */ @Nullable V index(K key, long index); @@ -214,7 +214,7 @@ public interface ListOperations { * * @param key must not be {@literal null}. * @return can be {@literal null}. - * @see Redis Documentation: LPOP + * @see Redis Documentation: LPOP */ @Nullable V leftPop(K key); @@ -227,7 +227,7 @@ public interface ListOperations { * @param timeout * @param unit must not be {@literal null}. * @return can be {@literal null}. - * @see Redis Documentation: BLPOP + * @see Redis Documentation: BLPOP */ @Nullable V leftPop(K key, long timeout, TimeUnit unit); @@ -237,7 +237,7 @@ public interface ListOperations { * * @param key must not be {@literal null}. * @return can be {@literal null}. - * @see Redis Documentation: RPOP + * @see Redis Documentation: RPOP */ @Nullable V rightPop(K key); @@ -250,7 +250,7 @@ public interface ListOperations { * @param timeout * @param unit must not be {@literal null}. * @return can be {@literal null}. - * @see Redis Documentation: BRPOP + * @see Redis Documentation: BRPOP */ @Nullable V rightPop(K key, long timeout, TimeUnit unit); @@ -261,7 +261,7 @@ public interface ListOperations { * @param sourceKey must not be {@literal null}. * @param destinationKey must not be {@literal null}. * @return can be {@literal null}. - * @see Redis Documentation: RPOPLPUSH + * @see Redis Documentation: RPOPLPUSH */ @Nullable V rightPopAndLeftPush(K sourceKey, K destinationKey); @@ -275,7 +275,7 @@ public interface ListOperations { * @param timeout * @param unit must not be {@literal null}. * @return can be {@literal null}. - * @see Redis Documentation: BRPOPLPUSH + * @see Redis Documentation: BRPOPLPUSH */ @Nullable V rightPopAndLeftPush(K sourceKey, K destinationKey, long timeout, TimeUnit unit); diff --git a/src/main/java/org/springframework/data/redis/core/ReactiveGeoOperations.java b/src/main/java/org/springframework/data/redis/core/ReactiveGeoOperations.java index b1d002e093..9ca979fe54 100644 --- a/src/main/java/org/springframework/data/redis/core/ReactiveGeoOperations.java +++ b/src/main/java/org/springframework/data/redis/core/ReactiveGeoOperations.java @@ -36,7 +36,7 @@ * * @author Mark Paluch * @author Christoph Strobl - * @see Redis Documentation: Geo Commands + * @see Redis Documentation: Geo Commands * @since 2.0 */ public interface ReactiveGeoOperations { @@ -48,7 +48,7 @@ public interface ReactiveGeoOperations { * @param point must not be {@literal null}. * @param member must not be {@literal null}. * @return Number of elements added. - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD */ Mono add(K key, Point point, M member); @@ -58,7 +58,7 @@ public interface ReactiveGeoOperations { * @param key must not be {@literal null}. * @param location must not be {@literal null}. * @return Number of elements added. - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD */ Mono add(K key, GeoLocation location); @@ -68,7 +68,7 @@ public interface ReactiveGeoOperations { * @param key must not be {@literal null}. * @param memberCoordinateMap must not be {@literal null}. * @return Number of elements added. - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD */ Mono add(K key, Map memberCoordinateMap); @@ -78,7 +78,7 @@ public interface ReactiveGeoOperations { * @param key must not be {@literal null}. * @param locations must not be {@literal null}. * @return Number of elements added. - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD */ Mono add(K key, Iterable> locations); @@ -88,7 +88,7 @@ public interface ReactiveGeoOperations { * @param key must not be {@literal null}. * @param locations must not be {@literal null}. * @return Number of elements added. - * @see Redis Documentation: GEOADD + * @see Redis Documentation: GEOADD */ Flux add(K key, Publisher>> locations); @@ -99,7 +99,7 @@ public interface ReactiveGeoOperations { * @param member1 must not be {@literal null}. * @param member2 must not be {@literal null}. * @return can be {@literal null}. - * @see Redis Documentation: GEODIST + * @see Redis Documentation: GEODIST */ Mono distance(K key, M member1, M member2); @@ -111,7 +111,7 @@ public interface ReactiveGeoOperations { * @param member2 must not be {@literal null}. * @param metric must not be {@literal null}. * @return can be {@literal null}. - * @see Redis Documentation: GEODIST + * @see Redis Documentation: GEODIST */ Mono distance(K key, M member1, M member2, Metric metric); @@ -121,7 +121,7 @@ public interface ReactiveGeoOperations { * @param key must not be {@literal null}. * @param member must not be {@literal null}. * @return never {@literal null}. - * @see Redis Documentation: GEOHASH + * @see Redis Documentation: GEOHASH */ Mono hash(K key, M member); @@ -131,7 +131,7 @@ public interface ReactiveGeoOperations { * @param key must not be {@literal null}. * @param members must not be {@literal null}. * @return never {@literal null}. - * @see Redis Documentation: GEOHASH + * @see Redis Documentation: GEOHASH */ Mono> hash(K key, M... members); @@ -141,7 +141,7 @@ public interface ReactiveGeoOperations { * @param key must not be {@literal null}. * @param member must not be {@literal null}. * @return never {@literal null}. - * @see Redis Documentation: GEOPOS + * @see Redis Documentation: GEOPOS */ Mono position(K key, M member); @@ -151,7 +151,7 @@ public interface ReactiveGeoOperations { * @param key must not be {@literal null}. * @param members must not be {@literal null}. * @return never {@literal null}. - * @see Redis Documentation: GEOPOS + * @see Redis Documentation: GEOPOS */ Mono> position(K key, M... members); @@ -161,7 +161,7 @@ public interface ReactiveGeoOperations { * @param key must not be {@literal null}. * @param within must not be {@literal null}. * @return never {@literal null}. - * @see Redis Documentation: GEORADIUS + * @see Redis Documentation: GEORADIUS */ Flux>> radius(K key, Circle within); @@ -172,7 +172,7 @@ public interface ReactiveGeoOperations { * @param within must not be {@literal null}. * @param args must not be {@literal null}. * @return never {@literal null}. - * @see Redis Documentation: GEORADIUS + * @see Redis Documentation: GEORADIUS */ Flux>> radius(K key, Circle within, GeoRadiusCommandArgs args); @@ -184,7 +184,7 @@ public interface ReactiveGeoOperations { * @param member must not be {@literal null}. * @param radius * @return never {@literal null}. - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER */ Flux>> radius(K key, M member, double radius); @@ -196,7 +196,7 @@ public interface ReactiveGeoOperations { * @param member must not be {@literal null}. * @param distance must not be {@literal null}. * @return never {@literal null}. - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER */ Flux>> radius(K key, M member, Distance distance); @@ -209,7 +209,7 @@ public interface ReactiveGeoOperations { * @param distance must not be {@literal null}. * @param args must not be {@literal null}. * @return never {@literal null}. - * @see Redis Documentation: GEORADIUSBYMEMBER + * @see Redis Documentation: GEORADIUSBYMEMBER */ Flux>> radius(K key, M member, Distance distance, GeoRadiusCommandArgs args); diff --git a/src/main/java/org/springframework/data/redis/core/ReactiveHashOperations.java b/src/main/java/org/springframework/data/redis/core/ReactiveHashOperations.java index 76254b5103..727f145bdc 100644 --- a/src/main/java/org/springframework/data/redis/core/ReactiveHashOperations.java +++ b/src/main/java/org/springframework/data/redis/core/ReactiveHashOperations.java @@ -154,7 +154,7 @@ public interface ReactiveHashOperations { * @return the {@link Flux} emitting the {@link java.util.Map.Entry entries} on by one or an {@link Flux#empty() empty * flux} if the key does not exist. * @throws IllegalArgumentException when the given {@code key} is {@literal null}. - * @see Redis Documentation: HSCAN + * @see Redis Documentation: HSCAN * @since 2.1 */ default Flux> scan(H key) { @@ -170,7 +170,7 @@ default Flux> scan(H key) { * @return the {@link Flux} emitting the {@link java.util.Map.Entry entries} on by one or an {@link Flux#empty() empty * flux} if the key does not exist. * @throws IllegalArgumentException when one of the required arguments is {@literal null}. - * @see Redis Documentation: HSCAN + * @see Redis Documentation: HSCAN * @since 2.1 */ Flux> scan(H key, ScanOptions options); diff --git a/src/main/java/org/springframework/data/redis/core/ReactiveListOperations.java b/src/main/java/org/springframework/data/redis/core/ReactiveListOperations.java index 6ac05bc89a..8cf6262c0c 100644 --- a/src/main/java/org/springframework/data/redis/core/ReactiveListOperations.java +++ b/src/main/java/org/springframework/data/redis/core/ReactiveListOperations.java @@ -27,7 +27,7 @@ * * @author Mark Paluch * @author Christoph Strobl - * @see Redis Documentation: List Commands + * @see Redis Documentation: List Commands * @since 2.0 */ public interface ReactiveListOperations { @@ -39,7 +39,7 @@ public interface ReactiveListOperations { * @param start * @param end * @return - * @see Redis Documentation: LRANGE + * @see Redis Documentation: LRANGE */ Flux range(K key, long start, long end); @@ -49,7 +49,7 @@ public interface ReactiveListOperations { * @param key must not be {@literal null}. * @param start * @param end - * @see Redis Documentation: LTRIM + * @see Redis Documentation: LTRIM */ Mono trim(K key, long start, long end); @@ -58,7 +58,7 @@ public interface ReactiveListOperations { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: LLEN + * @see Redis Documentation: LLEN */ Mono size(K key); @@ -68,7 +68,7 @@ public interface ReactiveListOperations { * @param key must not be {@literal null}. * @param value * @return - * @see Redis Documentation: LPUSH + * @see Redis Documentation: LPUSH */ Mono leftPush(K key, V value); @@ -78,7 +78,7 @@ public interface ReactiveListOperations { * @param key must not be {@literal null}. * @param values * @return - * @see Redis Documentation: LPUSH + * @see Redis Documentation: LPUSH */ Mono leftPushAll(K key, V... values); @@ -89,7 +89,7 @@ public interface ReactiveListOperations { * @param values must not be {@literal null}. * @return * @since 1.5 - * @see Redis Documentation: LPUSH + * @see Redis Documentation: LPUSH */ Mono leftPushAll(K key, Collection values); @@ -99,7 +99,7 @@ public interface ReactiveListOperations { * @param key must not be {@literal null}. * @param value * @return - * @see Redis Documentation: LPUSHX + * @see Redis Documentation: LPUSHX */ Mono leftPushIfPresent(K key, V value); @@ -109,7 +109,7 @@ public interface ReactiveListOperations { * @param key must not be {@literal null}. * @param value * @return - * @see Redis Documentation: LPUSH + * @see Redis Documentation: LPUSH */ Mono leftPush(K key, V pivot, V value); @@ -119,7 +119,7 @@ public interface ReactiveListOperations { * @param key must not be {@literal null}. * @param value * @return - * @see Redis Documentation: RPUSH + * @see Redis Documentation: RPUSH */ Mono rightPush(K key, V value); @@ -129,7 +129,7 @@ public interface ReactiveListOperations { * @param key must not be {@literal null}. * @param values * @return - * @see Redis Documentation: RPUSH + * @see Redis Documentation: RPUSH */ Mono rightPushAll(K key, V... values); @@ -140,7 +140,7 @@ public interface ReactiveListOperations { * @param values * @return * @since 1.5 - * @see Redis Documentation: RPUSH + * @see Redis Documentation: RPUSH */ Mono rightPushAll(K key, Collection values); @@ -150,7 +150,7 @@ public interface ReactiveListOperations { * @param key must not be {@literal null}. * @param value * @return - * @see Redis Documentation: RPUSHX + * @see Redis Documentation: RPUSHX */ Mono rightPushIfPresent(K key, V value); @@ -160,7 +160,7 @@ public interface ReactiveListOperations { * @param key must not be {@literal null}. * @param value * @return - * @see Redis Documentation: RPUSH + * @see Redis Documentation: RPUSH */ Mono rightPush(K key, V pivot, V value); @@ -170,7 +170,7 @@ public interface ReactiveListOperations { * @param key must not be {@literal null}. * @param index * @param value - * @see Redis Documentation: LSET + * @see Redis Documentation: LSET */ Mono set(K key, long index, V value); @@ -181,7 +181,7 @@ public interface ReactiveListOperations { * @param count * @param value * @return - * @see Redis Documentation: LREM + * @see Redis Documentation: LREM */ Mono remove(K key, long count, Object value); @@ -191,7 +191,7 @@ public interface ReactiveListOperations { * @param key must not be {@literal null}. * @param index * @return - * @see Redis Documentation: LINDEX + * @see Redis Documentation: LINDEX */ Mono index(K key, long index); @@ -200,7 +200,7 @@ public interface ReactiveListOperations { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: LPOP + * @see Redis Documentation: LPOP */ Mono leftPop(K key); @@ -213,7 +213,7 @@ public interface ReactiveListOperations { * {@link Duration#ZERO} or greater {@link 1 second}, must not be {@literal null}. A timeout of zero can be * used to wait indefinitely. Durations between zero and one second are not supported. * @return - * @see Redis Documentation: BLPOP + * @see Redis Documentation: BLPOP */ Mono leftPop(K key, Duration timeout); @@ -222,7 +222,7 @@ public interface ReactiveListOperations { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: RPOP + * @see Redis Documentation: RPOP */ Mono rightPop(K key); @@ -235,7 +235,7 @@ public interface ReactiveListOperations { * {@link Duration#ZERO} or greater {@link 1 second}, must not be {@literal null}. A timeout of zero can be * used to wait indefinitely. Durations between zero and one second are not supported. * @return - * @see Redis Documentation: BRPOP + * @see Redis Documentation: BRPOP */ Mono rightPop(K key, Duration timeout); @@ -245,7 +245,7 @@ public interface ReactiveListOperations { * @param sourceKey must not be {@literal null}. * @param destinationKey must not be {@literal null}. * @return - * @see Redis Documentation: RPOPLPUSH + * @see Redis Documentation: RPOPLPUSH */ Mono rightPopAndLeftPush(K sourceKey, K destinationKey); @@ -259,7 +259,7 @@ public interface ReactiveListOperations { * either {@link Duration#ZERO} or greater {@link 1 second}, must not be {@literal null}. A timeout of zero * can be used to wait indefinitely. Durations between zero and one second are not supported. * @return - * @see Redis Documentation: BRPOPLPUSH + * @see Redis Documentation: BRPOPLPUSH */ Mono rightPopAndLeftPush(K sourceKey, K destinationKey, Duration timeout); diff --git a/src/main/java/org/springframework/data/redis/core/ReactiveRedisOperations.java b/src/main/java/org/springframework/data/redis/core/ReactiveRedisOperations.java index 4121843ab3..6732c007b4 100644 --- a/src/main/java/org/springframework/data/redis/core/ReactiveRedisOperations.java +++ b/src/main/java/org/springframework/data/redis/core/ReactiveRedisOperations.java @@ -74,7 +74,7 @@ public interface ReactiveRedisOperations { * @param message message to publish. Must not be {@literal null}. * @return the number of clients that received the message * @since 2.1 - * @see Redis Documentation: PUBLISH + * @see Redis Documentation: PUBLISH */ Mono convertAndSend(String destination, V message); @@ -125,7 +125,7 @@ default Flux> listenToPattern(String... patterns) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: EXISTS + * @see Redis Documentation: EXISTS */ Mono hasKey(K key); @@ -134,7 +134,7 @@ default Flux> listenToPattern(String... patterns) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: TYPE + * @see Redis Documentation: TYPE */ Mono type(K key); @@ -146,7 +146,7 @@ default Flux> listenToPattern(String... patterns) { * @param pattern must not be {@literal null}. * @return the {@link Flux} emitting matching keys one by one. * @throws IllegalArgumentException in case the pattern is {@literal null}. - * @see Redis Documentation: KEYS + * @see Redis Documentation: KEYS */ Flux keys(K pattern); @@ -156,7 +156,7 @@ default Flux> listenToPattern(String... patterns) { * * @return the {@link Flux} emitting the {@literal keys} one by one or an {@link Flux#empty() empty flux} if none * exist. - * @see Redis Documentation: SCAN + * @see Redis Documentation: SCAN * @since 2.1 */ default Flux scan() { @@ -171,7 +171,7 @@ default Flux scan() { * @return the {@link Flux} emitting the {@literal keys} one by one or an {@link Flux#empty() empty flux} if none * exist. * @throws IllegalArgumentException when the given {@code options} is {@literal null}. - * @see Redis Documentation: SCAN + * @see Redis Documentation: SCAN * @since 2.1 */ Flux scan(ScanOptions options); @@ -180,7 +180,7 @@ default Flux scan() { * Return a random key from the keyspace. * * @return - * @see Redis Documentation: RANDOMKEY + * @see Redis Documentation: RANDOMKEY */ Mono randomKey(); @@ -189,7 +189,7 @@ default Flux scan() { * * @param oldKey must not be {@literal null}. * @param newKey must not be {@literal null}. - * @see Redis Documentation: RENAME + * @see Redis Documentation: RENAME */ Mono rename(K oldKey, K newKey); @@ -199,7 +199,7 @@ default Flux scan() { * @param oldKey must not be {@literal null}. * @param newKey must not be {@literal null}. * @return - * @see Redis Documentation: RENAMENX + * @see Redis Documentation: RENAMENX */ Mono renameIfAbsent(K oldKey, K newKey); @@ -208,7 +208,7 @@ default Flux scan() { * * @param key must not be {@literal null}. * @return The number of keys that were removed. - * @see Redis Documentation: DEL + * @see Redis Documentation: DEL */ Mono delete(K... key); @@ -218,7 +218,7 @@ default Flux scan() { * * @param keys must not be {@literal null}. * @return The number of keys that were removed. - * @see Redis Documentation: DEL + * @see Redis Documentation: DEL */ Mono delete(Publisher keys); @@ -228,7 +228,7 @@ default Flux scan() { * * @param key must not be {@literal null}. * @return The number of keys that were removed. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: UNLINK + * @see Redis Documentation: UNLINK * @since 2.1 */ Mono unlink(K... key); @@ -240,7 +240,7 @@ default Flux scan() { * * @param keys must not be {@literal null}. * @return The number of keys that were removed. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: UNLINK + * @see Redis Documentation: UNLINK * @since 2.1 */ Mono unlink(Publisher keys); @@ -268,7 +268,7 @@ default Flux scan() { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: PERSIST + * @see Redis Documentation: PERSIST */ Mono persist(K key); @@ -278,7 +278,7 @@ default Flux scan() { * @param key must not be {@literal null}. * @param dbIndex * @return - * @see Redis Documentation: MOVE + * @see Redis Documentation: MOVE */ Mono move(K key, int dbIndex); @@ -288,7 +288,7 @@ default Flux scan() { * @param key must not be {@literal null}. * @return the {@link Duration} of the associated key. {@link Duration#ZERO} if no timeout associated or empty * {@link Mono} if the key does not exist. - * @see Redis Documentation: PTTL + * @see Redis Documentation: PTTL */ Mono getExpire(K key); diff --git a/src/main/java/org/springframework/data/redis/core/ReactiveSetOperations.java b/src/main/java/org/springframework/data/redis/core/ReactiveSetOperations.java index 6974b7cfa6..aacad6535c 100644 --- a/src/main/java/org/springframework/data/redis/core/ReactiveSetOperations.java +++ b/src/main/java/org/springframework/data/redis/core/ReactiveSetOperations.java @@ -26,7 +26,7 @@ * @author Mark Paluch * @author Christoph Strobl * @author Roman Bezpalko - * @see Redis Documentation: Set Commands + * @see Redis Documentation: Set Commands * @since 2.0 */ public interface ReactiveSetOperations { @@ -37,7 +37,7 @@ public interface ReactiveSetOperations { * @param key must not be {@literal null}. * @param values * @return - * @see Redis Documentation: SADD + * @see Redis Documentation: SADD */ Mono add(K key, V... values); @@ -47,7 +47,7 @@ public interface ReactiveSetOperations { * @param key must not be {@literal null}. * @param values * @return - * @see Redis Documentation: SREM + * @see Redis Documentation: SREM */ Mono remove(K key, Object... values); @@ -56,7 +56,7 @@ public interface ReactiveSetOperations { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: SPOP + * @see Redis Documentation: SPOP */ Mono pop(K key); @@ -66,7 +66,7 @@ public interface ReactiveSetOperations { * @param key must not be {@literal null}. * @param count number of random members to pop from the set. * @return {@link Flux} emitting random members. - * @see Redis Documentation: SPOP + * @see Redis Documentation: SPOP */ Flux pop(K key, long count); @@ -77,7 +77,7 @@ public interface ReactiveSetOperations { * @param value * @param destKey must not be {@literal null}. * @return - * @see Redis Documentation: SMOVE + * @see Redis Documentation: SMOVE */ Mono move(K sourceKey, V value, K destKey); @@ -86,7 +86,7 @@ public interface ReactiveSetOperations { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: SCARD + * @see Redis Documentation: SCARD */ Mono size(K key); @@ -96,7 +96,7 @@ public interface ReactiveSetOperations { * @param key must not be {@literal null}. * @param o * @return - * @see Redis Documentation: SISMEMBER + * @see Redis Documentation: SISMEMBER */ Mono isMember(K key, Object o); @@ -106,7 +106,7 @@ public interface ReactiveSetOperations { * @param key must not be {@literal null}. * @param otherKey must not be {@literal null}. * @return - * @see Redis Documentation: SINTER + * @see Redis Documentation: SINTER */ Flux intersect(K key, K otherKey); @@ -116,7 +116,7 @@ public interface ReactiveSetOperations { * @param key must not be {@literal null}. * @param otherKeys must not be {@literal null}. * @return - * @see Redis Documentation: SINTER + * @see Redis Documentation: SINTER */ Flux intersect(K key, Collection otherKeys); @@ -125,7 +125,7 @@ public interface ReactiveSetOperations { * * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: SINTER + * @see Redis Documentation: SINTER * @since 2.2 */ Flux intersect(Collection keys); @@ -137,7 +137,7 @@ public interface ReactiveSetOperations { * @param otherKey must not be {@literal null}. * @param destKey must not be {@literal null}. * @return - * @see Redis Documentation: SINTERSTORE + * @see Redis Documentation: SINTERSTORE */ Mono intersectAndStore(K key, K otherKey, K destKey); @@ -148,7 +148,7 @@ public interface ReactiveSetOperations { * @param otherKeys must not be {@literal null}. * @param destKey must not be {@literal null}. * @return - * @see Redis Documentation: SINTERSTORE + * @see Redis Documentation: SINTERSTORE */ Mono intersectAndStore(K key, Collection otherKeys, K destKey); @@ -158,7 +158,7 @@ public interface ReactiveSetOperations { * @param keys must not be {@literal null}. * @param destKey must not be {@literal null}. * @return - * @see Redis Documentation: SINTERSTORE + * @see Redis Documentation: SINTERSTORE * @since 2.2 */ Mono intersectAndStore(Collection keys, K destKey); @@ -169,7 +169,7 @@ public interface ReactiveSetOperations { * @param key must not be {@literal null}. * @param otherKey must not be {@literal null}. * @return - * @see Redis Documentation: SUNION + * @see Redis Documentation: SUNION */ Flux union(K key, K otherKey); @@ -179,7 +179,7 @@ public interface ReactiveSetOperations { * @param key must not be {@literal null}. * @param otherKeys must not be {@literal null}. * @return - * @see Redis Documentation: SUNION + * @see Redis Documentation: SUNION */ Flux union(K key, Collection otherKeys); @@ -188,7 +188,7 @@ public interface ReactiveSetOperations { * * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: SUNION + * @see Redis Documentation: SUNION * @since 2.2 */ Flux union(Collection keys); @@ -200,7 +200,7 @@ public interface ReactiveSetOperations { * @param otherKey must not be {@literal null}. * @param destKey must not be {@literal null}. * @return - * @see Redis Documentation: SUNIONSTORE + * @see Redis Documentation: SUNIONSTORE */ Mono unionAndStore(K key, K otherKey, K destKey); @@ -211,7 +211,7 @@ public interface ReactiveSetOperations { * @param otherKeys must not be {@literal null}. * @param destKey must not be {@literal null}. * @return - * @see Redis Documentation: SUNIONSTORE + * @see Redis Documentation: SUNIONSTORE */ Mono unionAndStore(K key, Collection otherKeys, K destKey); @@ -221,7 +221,7 @@ public interface ReactiveSetOperations { * @param keys must not be {@literal null}. * @param destKey must not be {@literal null}. * @return - * @see Redis Documentation: SUNIONSTORE + * @see Redis Documentation: SUNIONSTORE * @since 2.2 */ Mono unionAndStore(Collection keys, K destKey); @@ -232,7 +232,7 @@ public interface ReactiveSetOperations { * @param key must not be {@literal null}. * @param otherKey must not be {@literal null}. * @return - * @see Redis Documentation: SDIFF + * @see Redis Documentation: SDIFF */ Flux difference(K key, K otherKey); @@ -242,7 +242,7 @@ public interface ReactiveSetOperations { * @param key must not be {@literal null}. * @param otherKeys must not be {@literal null}. * @return - * @see Redis Documentation: SDIFF + * @see Redis Documentation: SDIFF */ Flux difference(K key, Collection otherKeys); @@ -251,7 +251,7 @@ public interface ReactiveSetOperations { * * @param keys must not be {@literal null}. * @return - * @see Redis Documentation: SDIFF + * @see Redis Documentation: SDIFF * @since 2.2 */ Flux difference(Collection keys); @@ -263,7 +263,7 @@ public interface ReactiveSetOperations { * @param otherKey must not be {@literal null}. * @param destKey must not be {@literal null}. * @return - * @see Redis Documentation: SDIFFSTORE + * @see Redis Documentation: SDIFFSTORE */ Mono differenceAndStore(K key, K otherKey, K destKey); @@ -274,7 +274,7 @@ public interface ReactiveSetOperations { * @param otherKeys must not be {@literal null}. * @param destKey must not be {@literal null}. * @return - * @see Redis Documentation: SDIFFSTORE + * @see Redis Documentation: SDIFFSTORE */ Mono differenceAndStore(K key, Collection otherKeys, K destKey); @@ -284,7 +284,7 @@ public interface ReactiveSetOperations { * @param keys must not be {@literal null}. * @param destKey must not be {@literal null}. * @return - * @see Redis Documentation: SDIFFSTORE + * @see Redis Documentation: SDIFFSTORE * @since 2.2 */ Mono differenceAndStore(Collection keys, K destKey); @@ -294,7 +294,7 @@ public interface ReactiveSetOperations { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: SMEMBERS + * @see Redis Documentation: SMEMBERS */ Flux members(K key); @@ -306,7 +306,7 @@ public interface ReactiveSetOperations { * @return the {@link Flux} emitting the {@literal values} one by one or an {@link Flux#empty() empty Flux} if none * exist. * @throws IllegalArgumentException when given {@code key} is {@literal null}. - * @see Redis Documentation: SSCAN + * @see Redis Documentation: SSCAN * @since 2.1 */ default Flux scan(K key) { @@ -322,7 +322,7 @@ default Flux scan(K key) { * @return the {@link Flux} emitting the {@literal values} one by one or an {@link Flux#empty() empty Flux} if the key * does not exist. * @throws IllegalArgumentException when one of the required arguments is {@literal null}. - * @see Redis Documentation: SSCAN + * @see Redis Documentation: SSCAN * @since 2.1 */ Flux scan(K key, ScanOptions options); @@ -332,7 +332,7 @@ default Flux scan(K key) { * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: SRANDMEMBER + * @see Redis Documentation: SRANDMEMBER */ Mono randomMember(K key); @@ -342,7 +342,7 @@ default Flux scan(K key) { * @param key must not be {@literal null}. * @param count number of members to return. * @return - * @see Redis Documentation: SRANDMEMBER + * @see Redis Documentation: SRANDMEMBER */ Flux distinctRandomMembers(K key, long count); @@ -352,7 +352,7 @@ default Flux scan(K key) { * @param key must not be {@literal null}. * @param count number of members to return. * @return - * @see Redis Documentation: SRANDMEMBER + * @see Redis Documentation: SRANDMEMBER */ Flux randomMembers(K key, long count); diff --git a/src/main/java/org/springframework/data/redis/core/ReactiveStreamOperations.java b/src/main/java/org/springframework/data/redis/core/ReactiveStreamOperations.java index 5a57c87d4a..e211e51c64 100644 --- a/src/main/java/org/springframework/data/redis/core/ReactiveStreamOperations.java +++ b/src/main/java/org/springframework/data/redis/core/ReactiveStreamOperations.java @@ -52,7 +52,7 @@ public interface ReactiveStreamOperations extends HashMapperProvider< * @param group name of the consumer group. * @param recordIds record Id's to acknowledge. * @return the {@link Mono} emitting the length of acknowledged records. - * @see Redis Documentation: XACK + * @see Redis Documentation: XACK */ default Mono acknowledge(K key, String group, String... recordIds) { return acknowledge(key, group, Arrays.stream(recordIds).map(RecordId::of).toArray(RecordId[]::new)); @@ -65,7 +65,7 @@ default Mono acknowledge(K key, String group, String... recordIds) { * @param group name of the consumer group. * @param recordIds record Id's to acknowledge. * @return the {@link Mono} emitting the length of acknowledged records. - * @see Redis Documentation: XACK + * @see Redis Documentation: XACK */ Mono acknowledge(K key, String group, RecordId... recordIds); @@ -75,7 +75,7 @@ default Mono acknowledge(K key, String group, String... recordIds) { * @param group name of the consumer group. * @param record the {@link Record} to acknowledge. * @return the {@link Mono} emitting the length of acknowledged records. - * @see Redis Documentation: XACK + * @see Redis Documentation: XACK */ default Mono acknowledge(String group, Record record) { return acknowledge(record.getStream(), group, record.getId()); @@ -87,7 +87,7 @@ default Mono acknowledge(String group, Record record) { * @param key the stream key. * @param bodyPublisher record body {@link Publisher}. * @return the record Ids. - * @see Redis Documentation: XADD + * @see Redis Documentation: XADD */ default Flux add(K key, Publisher> bodyPublisher) { return Flux.from(bodyPublisher).flatMap(it -> add(key, it)); @@ -99,7 +99,7 @@ default Flux add(K key, PublisherRedis Documentation: XADD + * @see Redis Documentation: XADD */ default Mono add(K key, Map content) { return add(StreamRecords.newRecord().in(key).ofMap(content)); @@ -110,7 +110,7 @@ default Mono add(K key, Map content) { * * @param record the record to append. * @return the {@link Mono} emitting the {@link RecordId}. - * @see Redis Documentation: XADD + * @see Redis Documentation: XADD */ @SuppressWarnings("unchecked") default Mono add(MapRecord record) { @@ -134,7 +134,7 @@ default Mono add(MapRecord record) { * @param key the stream key. * @param recordIds stream record Id's. * @return the {@link Mono} emitting the number of removed records. - * @see Redis Documentation: XDEL + * @see Redis Documentation: XDEL */ default Mono delete(K key, String... recordIds) { return delete(key, Arrays.stream(recordIds).map(RecordId::of).toArray(RecordId[]::new)); @@ -157,7 +157,7 @@ default Mono delete(Record record) { * @param key the stream key. * @param recordIds stream record Id's. * @return the {@link Mono} emitting the number of removed records. - * @see Redis Documentation: XDEL + * @see Redis Documentation: XDEL */ Mono delete(K key, RecordId... recordIds); @@ -206,7 +206,7 @@ default Mono createGroup(K key, String group) { * * @param key the stream key. * @return the {@link Mono} emitting the length of the stream. - * @see Redis Documentation: XLEN + * @see Redis Documentation: XLEN */ Mono size(K key); @@ -216,7 +216,7 @@ default Mono createGroup(K key, String group) { * @param key the stream key. * @param range must not be {@literal null}. * @return the {@link Flux} emitting records one by one. - * @see Redis Documentation: XRANGE + * @see Redis Documentation: XRANGE */ default Flux> range(K key, Range range) { return range(key, range, Limit.unlimited()); @@ -229,7 +229,7 @@ default Flux> range(K key, Range range) { * @param range must not be {@literal null}. * @param limit must not be {@literal null}. * @return lthe {@link Flux} emitting records one by one. - * @see Redis Documentation: XRANGE + * @see Redis Documentation: XRANGE */ Flux> range(K key, Range range, Limit limit); @@ -240,7 +240,7 @@ default Flux> range(K key, Range range) { * @param key the stream key. * @param range must not be {@literal null}. * @return the {@link Flux} emitting records one by one. - * @see Redis Documentation: XRANGE + * @see Redis Documentation: XRANGE */ default Flux> range(Class targetType, K key, Range range) { return range(targetType, key, range, Limit.unlimited()); @@ -254,7 +254,7 @@ default Flux> range(Class targetType, K key, RangeRedis Documentation: XRANGE + * @see Redis Documentation: XRANGE */ default Flux> range(Class targetType, K key, Range range, Limit limit) { @@ -268,7 +268,7 @@ default Flux> range(Class targetType, K key, RangeRedis Documentation: XREAD + * @see Redis Documentation: XREAD */ @SuppressWarnings("unchecked") default Flux> read(StreamOffset stream) { @@ -284,7 +284,7 @@ default Flux> read(StreamOffset stream) { * @param targetType the target type of the payload. * @param stream the stream to read from. * @return the {@link Flux} emitting records one by one. - * @see Redis Documentation: XREAD + * @see Redis Documentation: XREAD */ @SuppressWarnings("unchecked") default Flux> read(Class targetType, StreamOffset stream) { @@ -299,7 +299,7 @@ default Flux> read(Class targetType, StreamOffset s * * @param streams the streams to read from. * @return the {@link Flux} emitting records one by one. - * @see Redis Documentation: XREAD + * @see Redis Documentation: XREAD */ default Flux> read(StreamOffset... streams) { return read(StreamReadOptions.empty(), streams); @@ -311,7 +311,7 @@ default Flux> read(StreamOffset... streams) { * @param targetType the target type of the payload. * @param streams the streams to read from. * @return the {@link Flux} emitting records one by one. - * @see Redis Documentation: XREAD + * @see Redis Documentation: XREAD */ default Flux> read(Class targetType, StreamOffset... streams) { return read(targetType, StreamReadOptions.empty(), streams); @@ -323,7 +323,7 @@ default Flux> read(Class targetType, StreamOffset.. * @param readOptions read arguments. * @param streams the streams to read from. * @return the {@link Flux} emitting records one by one. - * @see Redis Documentation: XREAD + * @see Redis Documentation: XREAD */ Flux> read(StreamReadOptions readOptions, StreamOffset... streams); @@ -334,7 +334,7 @@ default Flux> read(Class targetType, StreamOffset.. * @param readOptions read arguments. * @param streams the streams to read from. * @return the {@link Flux} emitting records one by one. - * @see Redis Documentation: XREAD + * @see Redis Documentation: XREAD */ default Flux> read(Class targetType, StreamReadOptions readOptions, StreamOffset... streams) { @@ -350,7 +350,7 @@ default Flux> read(Class targetType, StreamReadOptions * @param consumer consumer/group. * @param streams the streams to read from. * @return the {@link Flux} emitting records one by one. - * @see Redis Documentation: XREADGROUP + * @see Redis Documentation: XREADGROUP */ default Flux> read(Consumer consumer, StreamOffset... streams) { return read(consumer, StreamReadOptions.empty(), streams); @@ -363,7 +363,7 @@ default Flux> read(Consumer consumer, StreamOffset... st * @param consumer consumer/group. * @param streams the streams to read from. * @return the {@link Flux} emitting records one by one. - * @see Redis Documentation: XREADGROUP + * @see Redis Documentation: XREADGROUP */ default Flux> read(Class targetType, Consumer consumer, StreamOffset... streams) { return read(targetType, consumer, StreamReadOptions.empty(), streams); @@ -376,7 +376,7 @@ default Flux> read(Class targetType, Consumer consumer * @param readOptions read arguments. * @param streams the streams to read from. * @return the {@link Flux} emitting records one by one. - * @see Redis Documentation: XREADGROUP + * @see Redis Documentation: XREADGROUP */ Flux> read(Consumer consumer, StreamReadOptions readOptions, StreamOffset... streams); @@ -388,7 +388,7 @@ default Flux> read(Class targetType, Consumer consumer * @param readOptions read arguments. * @param streams the streams to read from. * @return the {@link Flux} emitting records one by one. - * @see Redis Documentation: XREADGROUP + * @see Redis Documentation: XREADGROUP */ default Flux> read(Class targetType, Consumer consumer, StreamReadOptions readOptions, StreamOffset... streams) { @@ -404,7 +404,7 @@ default Flux> read(Class targetType, Consumer consumer * @param key the stream key. * @param range must not be {@literal null}. * @return the {@link Flux} emitting records one by one. - * @see Redis Documentation: XREVRANGE + * @see Redis Documentation: XREVRANGE */ default Flux> reverseRange(K key, Range range) { return reverseRange(key, range, Limit.unlimited()); @@ -417,7 +417,7 @@ default Flux> reverseRange(K key, Range range) { * @param range must not be {@literal null}. * @param limit must not be {@literal null}. * @return the {@link Flux} emitting records one by one. - * @see Redis Documentation: XREVRANGE + * @see Redis Documentation: XREVRANGE */ Flux> reverseRange(K key, Range range, Limit limit); @@ -428,7 +428,7 @@ default Flux> reverseRange(K key, Range range) { * @param key the stream key. * @param range must not be {@literal null}. * @return the {@link Flux} emitting records one by one. - * @see Redis Documentation: XREVRANGE + * @see Redis Documentation: XREVRANGE */ default Flux> reverseRange(Class targetType, K key, Range range) { return reverseRange(targetType, key, range, Limit.unlimited()); @@ -443,7 +443,7 @@ default Flux> reverseRange(Class targetType, K key, Ra * @param range must not be {@literal null}. * @param limit must not be {@literal null}. * @return the {@link Flux} emitting records one by one. - * @see Redis Documentation: XREVRANGE + * @see Redis Documentation: XREVRANGE */ default Flux> reverseRange(Class targetType, K key, Range range, Limit limit) { @@ -458,7 +458,7 @@ default Flux> reverseRange(Class targetType, K key, Ra * @param key the stream key. * @param count length of the stream. * @return number of removed entries. - * @see Redis Documentation: XTRIM + * @see Redis Documentation: XTRIM */ Mono trim(K key, long count); diff --git a/src/main/java/org/springframework/data/redis/core/ReactiveValueOperations.java b/src/main/java/org/springframework/data/redis/core/ReactiveValueOperations.java index 641d5580e7..aa98bf5770 100644 --- a/src/main/java/org/springframework/data/redis/core/ReactiveValueOperations.java +++ b/src/main/java/org/springframework/data/redis/core/ReactiveValueOperations.java @@ -38,7 +38,7 @@ public interface ReactiveValueOperations { * * @param key must not be {@literal null}. * @param value - * @see Redis Documentation: SET + * @see Redis Documentation: SET */ Mono set(K key, V value); @@ -48,7 +48,7 @@ public interface ReactiveValueOperations { * @param key must not be {@literal null}. * @param value * @param timeout must not be {@literal null}. - * @see Redis Documentation: SETEX + * @see Redis Documentation: SETEX */ Mono set(K key, V value, Duration timeout); @@ -57,7 +57,7 @@ public interface ReactiveValueOperations { * * @param key must not be {@literal null}. * @param value - * @see Redis Documentation: SETNX + * @see Redis Documentation: SETNX */ Mono setIfAbsent(K key, V value); @@ -68,7 +68,7 @@ public interface ReactiveValueOperations { * @param value * @param timeout must not be {@literal null}. * @since 2.1 - * @see Redis Documentation: SET + * @see Redis Documentation: SET */ Mono setIfAbsent(K key, V value, Duration timeout); @@ -77,7 +77,7 @@ public interface ReactiveValueOperations { * * @param key must not be {@literal null}. * @param value - * @see Redis Documentation: SET + * @see Redis Documentation: SET */ Mono setIfPresent(K key, V value); @@ -88,7 +88,7 @@ public interface ReactiveValueOperations { * @param value * @param timeout must not be {@literal null}. * @since 2.1 - * @see Redis Documentation: SET + * @see Redis Documentation: SET */ Mono setIfPresent(K key, V value, Duration timeout); @@ -96,7 +96,7 @@ public interface ReactiveValueOperations { * Set multiple keys to multiple values using key-value pairs provided in {@code tuple}. * * @param map must not be {@literal null}. - * @see Redis Documentation: MSET + * @see Redis Documentation: MSET */ Mono multiSet(Map map); @@ -105,7 +105,7 @@ public interface ReactiveValueOperations { * not exist. * * @param map must not be {@literal null}. - * @see Redis Documentation: MSETNX + * @see Redis Documentation: MSETNX */ Mono multiSetIfAbsent(Map map); @@ -113,7 +113,7 @@ public interface ReactiveValueOperations { * Get the value of {@code key}. * * @param key must not be {@literal null}. - * @see Redis Documentation: GET + * @see Redis Documentation: GET */ Mono get(Object key); @@ -121,7 +121,7 @@ public interface ReactiveValueOperations { * Set {@code value} of {@code key} and return its old value. * * @param key must not be {@literal null}. - * @see Redis Documentation: GETSET + * @see Redis Documentation: GETSET */ Mono getAndSet(K key, V value); @@ -129,7 +129,7 @@ public interface ReactiveValueOperations { * Get multiple {@code keys}. Values are returned in the order of the requested keys. * * @param keys must not be {@literal null}. - * @see Redis Documentation: MGET + * @see Redis Documentation: MGET */ Mono> multiGet(Collection keys); @@ -138,7 +138,7 @@ public interface ReactiveValueOperations { * * @param key must not be {@literal null}. * @since 2.1 - * @see Redis Documentation: INCR + * @see Redis Documentation: INCR */ Mono increment(K key); @@ -148,7 +148,7 @@ public interface ReactiveValueOperations { * @param key must not be {@literal null}. * @param delta * @since 2.1 - * @see Redis Documentation: INCRBY + * @see Redis Documentation: INCRBY */ Mono increment(K key, long delta); @@ -158,7 +158,7 @@ public interface ReactiveValueOperations { * @param key must not be {@literal null}. * @param delta * @since 2.1 - * @see Redis Documentation: INCRBYFLOAT + * @see Redis Documentation: INCRBYFLOAT */ Mono increment(K key, double delta); @@ -167,7 +167,7 @@ public interface ReactiveValueOperations { * * @param key must not be {@literal null}. * @since 2.1 - * @see Redis Documentation: DECR + * @see Redis Documentation: DECR */ Mono decrement(K key); @@ -177,7 +177,7 @@ public interface ReactiveValueOperations { * @param key must not be {@literal null}. * @param delta * @since 2.1 - * @see Redis Documentation: DECRBY + * @see Redis Documentation: DECRBY */ Mono decrement(K key, long delta); @@ -186,7 +186,7 @@ public interface ReactiveValueOperations { * * @param key must not be {@literal null}. * @param value - * @see Redis Documentation: APPEND + * @see Redis Documentation: APPEND */ Mono append(K key, String value); @@ -196,7 +196,7 @@ public interface ReactiveValueOperations { * @param key must not be {@literal null}. * @param start * @param end - * @see Redis Documentation: GETRANGE + * @see Redis Documentation: GETRANGE */ Mono get(K key, long start, long end); @@ -206,7 +206,7 @@ public interface ReactiveValueOperations { * @param key must not be {@literal null}. * @param value * @param offset - * @see Redis Documentation: SETRANGE + * @see Redis Documentation: SETRANGE */ Mono set(K key, V value, long offset); @@ -214,7 +214,7 @@ public interface ReactiveValueOperations { * Get the length of the value stored at {@code key}. * * @param key must not be {@literal null}. - * @see Redis Documentation: STRLEN + * @see Redis Documentation: STRLEN */ Mono size(K key); @@ -224,7 +224,7 @@ public interface ReactiveValueOperations { * @param key must not be {@literal null}. * @param offset * @param value - * @see Redis Documentation: SETBIT + * @see Redis Documentation: SETBIT */ Mono setBit(K key, long offset, boolean value); @@ -233,7 +233,7 @@ public interface ReactiveValueOperations { * * @param key must not be {@literal null}. * @param offset - * @see Redis Documentation: GETBIT + * @see Redis Documentation: GETBIT */ Mono getBit(K key, long offset); diff --git a/src/main/java/org/springframework/data/redis/core/ReactiveZSetOperations.java b/src/main/java/org/springframework/data/redis/core/ReactiveZSetOperations.java index 5c5d0fac39..f866f079b8 100644 --- a/src/main/java/org/springframework/data/redis/core/ReactiveZSetOperations.java +++ b/src/main/java/org/springframework/data/redis/core/ReactiveZSetOperations.java @@ -32,7 +32,7 @@ * * @author Mark Paluch * @author Christoph Strobl - * @see Redis Documentation: Sorted Set Commands + * @see Redis Documentation: Sorted Set Commands * @since 2.0 */ public interface ReactiveZSetOperations { @@ -44,7 +44,7 @@ public interface ReactiveZSetOperations { * @param score the score. * @param value the value. * @return - * @see Redis Documentation: ZADD + * @see Redis Documentation: ZADD */ Mono add(K key, V value, double score); @@ -54,7 +54,7 @@ public interface ReactiveZSetOperations { * @param key must not be {@literal null}. * @param tuples the score. * @return - * @see Redis Documentation: ZADD + * @see Redis Documentation: ZADD */ Mono addAll(K key, Collection> tuples); @@ -64,7 +64,7 @@ public interface ReactiveZSetOperations { * @param key must not be {@literal null}. * @param values must not be {@literal null}. * @return - * @see Redis Documentation: ZREM + * @see Redis Documentation: ZREM */ Mono remove(K key, Object... values); @@ -75,7 +75,7 @@ public interface ReactiveZSetOperations { * @param delta * @param value the value. * @return - * @see Redis Documentation: ZINCRBY + * @see Redis Documentation: ZINCRBY */ Mono incrementScore(K key, V value, double delta); @@ -85,7 +85,7 @@ public interface ReactiveZSetOperations { * @param key must not be {@literal null}. * @param o the value. * @return - * @see Redis Documentation: ZRANK + * @see Redis Documentation: ZRANK */ Mono rank(K key, Object o); @@ -95,7 +95,7 @@ public interface ReactiveZSetOperations { * @param key must not be {@literal null}. * @param o the value. * @return - * @see Redis Documentation: ZREVRANK + * @see Redis Documentation: ZREVRANK */ Mono reverseRank(K key, Object o); @@ -105,7 +105,7 @@ public interface ReactiveZSetOperations { * @param key must not be {@literal null}. * @param range must not be {@literal null}. * @return - * @see Redis Documentation: ZRANGE + * @see Redis Documentation: ZRANGE */ Flux range(K key, Range range); @@ -115,7 +115,7 @@ public interface ReactiveZSetOperations { * @param key must not be {@literal null}. * @param range must not be {@literal null}. * @return - * @see Redis Documentation: ZRANGE + * @see Redis Documentation: ZRANGE */ Flux> rangeWithScores(K key, Range range); @@ -125,7 +125,7 @@ public interface ReactiveZSetOperations { * @param key must not be {@literal null}. * @param range must not be {@literal null}. * @return - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE */ Flux rangeByScore(K key, Range range); @@ -135,7 +135,7 @@ public interface ReactiveZSetOperations { * @param key must not be {@literal null}. * @param range must not be {@literal null}. * @return - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE */ Flux> rangeByScoreWithScores(K key, Range range); @@ -147,7 +147,7 @@ public interface ReactiveZSetOperations { * @param range * @param limit * @return - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE */ Flux rangeByScore(K key, Range range, Limit limit); @@ -159,7 +159,7 @@ public interface ReactiveZSetOperations { * @param range * @param limit * @return - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE */ Flux> rangeByScoreWithScores(K key, Range range, Limit limit); @@ -169,7 +169,7 @@ public interface ReactiveZSetOperations { * @param key must not be {@literal null}. * @param range * @return - * @see Redis Documentation: ZREVRANGE + * @see Redis Documentation: ZREVRANGE */ Flux reverseRange(K key, Range range); @@ -179,7 +179,7 @@ public interface ReactiveZSetOperations { * @param key must not be {@literal null}. * @param range * @return - * @see Redis Documentation: ZREVRANGE + * @see Redis Documentation: ZREVRANGE */ Flux> reverseRangeWithScores(K key, Range range); @@ -189,7 +189,7 @@ public interface ReactiveZSetOperations { * @param key must not be {@literal null}. * @param range * @return - * @see Redis Documentation: ZREVRANGE + * @see Redis Documentation: ZREVRANGE */ Flux reverseRangeByScore(K key, Range range); @@ -200,7 +200,7 @@ public interface ReactiveZSetOperations { * @param key must not be {@literal null}. * @param range * @return - * @see Redis Documentation: ZREVRANGEBYSCORE + * @see Redis Documentation: ZREVRANGEBYSCORE */ Flux> reverseRangeByScoreWithScores(K key, Range range); @@ -212,7 +212,7 @@ public interface ReactiveZSetOperations { * @param range * @param limit * @return - * @see Redis Documentation: ZREVRANGEBYSCORE + * @see Redis Documentation: ZREVRANGEBYSCORE */ Flux reverseRangeByScore(K key, Range range, Limit limit); @@ -224,7 +224,7 @@ public interface ReactiveZSetOperations { * @param range * @param limit * @return - * @see Redis Documentation: ZREVRANGEBYSCORE + * @see Redis Documentation: ZREVRANGEBYSCORE */ Flux> reverseRangeByScoreWithScores(K key, Range range, Limit limit); @@ -236,7 +236,7 @@ public interface ReactiveZSetOperations { * @return the {@link Flux} emitting the {@literal values} one by one or an {@link Flux#empty() empty Flux} if none * exist. * @throws IllegalArgumentException when given {@code key} is {@literal null}. - * @see Redis Documentation: ZSCAN + * @see Redis Documentation: ZSCAN * @since 2.1 */ default Flux> scan(K key) { @@ -253,7 +253,7 @@ default Flux> scan(K key) { * @return the {@link Flux} emitting the {@literal values} one by one or an {@link Flux#empty() empty Flux} if none * exist. * @throws IllegalArgumentException when one of the required arguments is {@literal null}. - * @see Redis Documentation: ZSCAN + * @see Redis Documentation: ZSCAN * @since 2.1 */ Flux> scan(K key, ScanOptions options); @@ -264,7 +264,7 @@ default Flux> scan(K key) { * @param key must not be {@literal null}. * @param range * @return - * @see Redis Documentation: ZCOUNT + * @see Redis Documentation: ZCOUNT */ Mono count(K key, Range range); @@ -273,7 +273,7 @@ default Flux> scan(K key) { * * @param key * @return - * @see Redis Documentation: ZCARD + * @see Redis Documentation: ZCARD */ Mono size(K key); @@ -283,7 +283,7 @@ default Flux> scan(K key) { * @param key must not be {@literal null}. * @param o the value. * @return - * @see Redis Documentation: ZSCORE + * @see Redis Documentation: ZSCORE */ Mono score(K key, Object o); @@ -293,7 +293,7 @@ default Flux> scan(K key) { * @param key must not be {@literal null}. * @param range * @return - * @see Redis Documentation: ZREMRANGEBYRANK + * @see Redis Documentation: ZREMRANGEBYRANK */ Mono removeRange(K key, Range range); @@ -303,7 +303,7 @@ default Flux> scan(K key) { * @param key must not be {@literal null}. * @param range * @return - * @see Redis Documentation: ZREMRANGEBYSCORE + * @see Redis Documentation: ZREMRANGEBYSCORE */ Mono removeRangeByScore(K key, Range range); @@ -314,7 +314,7 @@ default Flux> scan(K key) { * @param otherKey must not be {@literal null}. * @param destKey must not be {@literal null}. * @return - * @see Redis Documentation: ZUNIONSTORE + * @see Redis Documentation: ZUNIONSTORE */ Mono unionAndStore(K key, K otherKey, K destKey); @@ -325,7 +325,7 @@ default Flux> scan(K key) { * @param otherKeys must not be {@literal null}. * @param destKey must not be {@literal null}. * @return - * @see Redis Documentation: ZUNIONSTORE + * @see Redis Documentation: ZUNIONSTORE */ Mono unionAndStore(K key, Collection otherKeys, K destKey); @@ -338,7 +338,7 @@ default Flux> scan(K key) { * @param aggregate must not be {@literal null}. * @return * @since 2.1 - * @see Redis Documentation: ZUNIONSTORE + * @see Redis Documentation: ZUNIONSTORE */ default Mono unionAndStore(K key, Collection otherKeys, K destKey, Aggregate aggregate) { return unionAndStore(key, otherKeys, destKey, aggregate, Weights.fromSetCount(1 + otherKeys.size())); @@ -354,7 +354,7 @@ default Mono unionAndStore(K key, Collection otherKeys, K destKey, Aggr * @param weights must not be {@literal null}. * @return * @since 2.1 - * @see Redis Documentation: ZUNIONSTORE + * @see Redis Documentation: ZUNIONSTORE */ Mono unionAndStore(K key, Collection otherKeys, K destKey, Aggregate aggregate, Weights weights); @@ -365,7 +365,7 @@ default Mono unionAndStore(K key, Collection otherKeys, K destKey, Aggr * @param otherKey must not be {@literal null}. * @param destKey must not be {@literal null}. * @return - * @see Redis Documentation: ZINTERSTORE + * @see Redis Documentation: ZINTERSTORE */ Mono intersectAndStore(K key, K otherKey, K destKey); @@ -376,7 +376,7 @@ default Mono unionAndStore(K key, Collection otherKeys, K destKey, Aggr * @param otherKeys must not be {@literal null}. * @param destKey must not be {@literal null}. * @return - * @see Redis Documentation: ZINTERSTORE + * @see Redis Documentation: ZINTERSTORE */ Mono intersectAndStore(K key, Collection otherKeys, K destKey); @@ -389,7 +389,7 @@ default Mono unionAndStore(K key, Collection otherKeys, K destKey, Aggr * @param aggregate must not be {@literal null}. * @return * @since 2.1 - * @see Redis Documentation: ZINTERSTORE + * @see Redis Documentation: ZINTERSTORE */ default Mono intersectAndStore(K key, Collection otherKeys, K destKey, Aggregate aggregate) { return intersectAndStore(key, otherKeys, destKey, aggregate, Weights.fromSetCount(1 + otherKeys.size())); @@ -405,7 +405,7 @@ default Mono intersectAndStore(K key, Collection otherKeys, K destKey, * @param weights must not be {@literal null}. * @return * @since 2.1 - * @see Redis Documentation: ZINTERSTORE + * @see Redis Documentation: ZINTERSTORE */ Mono intersectAndStore(K key, Collection otherKeys, K destKey, Aggregate aggregate, Weights weights); @@ -415,7 +415,7 @@ default Mono intersectAndStore(K key, Collection otherKeys, K destKey, * * @param key must not be {@literal null}. * @param range must not be {@literal null}. - * @see Redis Documentation: ZRANGEBYLEX + * @see Redis Documentation: ZRANGEBYLEX */ Flux rangeByLex(K key, Range range); @@ -428,7 +428,7 @@ default Mono intersectAndStore(K key, Collection otherKeys, K destKey, * @param range must not be {@literal null}. * @param limit can be {@literal null}. * @return - * @see Redis Documentation: ZRANGEBYLEX + * @see Redis Documentation: ZRANGEBYLEX */ Flux rangeByLex(K key, Range range, Limit limit); @@ -438,7 +438,7 @@ default Mono intersectAndStore(K key, Collection otherKeys, K destKey, * * @param key must not be {@literal null}. * @param range must not be {@literal null}. - * @see Redis Documentation: ZREVRANGEBYLEX + * @see Redis Documentation: ZREVRANGEBYLEX */ Flux reverseRangeByLex(K key, Range range); @@ -451,7 +451,7 @@ default Mono intersectAndStore(K key, Collection otherKeys, K destKey, * @param range must not be {@literal null}. * @param limit can be {@literal null}. * @return - * @see Redis Documentation: ZREVRANGEBYLEX + * @see Redis Documentation: ZREVRANGEBYLEX */ Flux reverseRangeByLex(K key, Range range, Limit limit); diff --git a/src/main/java/org/springframework/data/redis/core/RedisOperations.java b/src/main/java/org/springframework/data/redis/core/RedisOperations.java index b0ff819a73..87a2e72e97 100644 --- a/src/main/java/org/springframework/data/redis/core/RedisOperations.java +++ b/src/main/java/org/springframework/data/redis/core/RedisOperations.java @@ -159,7 +159,7 @@ T execute(RedisScript script, RedisSerializer argsSerializer, RedisSer * * @param key must not be {@literal null}. * @return - * @see Redis Documentation: EXISTS + * @see Redis Documentation: EXISTS */ @Nullable Boolean hasKey(K key); @@ -170,7 +170,7 @@ T execute(RedisScript script, RedisSerializer argsSerializer, RedisSer * @param keys must not be {@literal null}. * @return The number of keys existing among the ones specified as arguments. Keys mentioned multiple times and * existing are counted multiple times. - * @see Redis Documentation: EXISTS + * @see Redis Documentation: EXISTS * @since 2.1 */ @Nullable @@ -181,7 +181,7 @@ T execute(RedisScript script, RedisSerializer argsSerializer, RedisSer * * @param key must not be {@literal null}. * @return {@literal true} if the key was removed. - * @see Redis Documentation: DEL + * @see Redis Documentation: DEL */ @Nullable Boolean delete(K key); @@ -191,7 +191,7 @@ T execute(RedisScript script, RedisSerializer argsSerializer, RedisSer * * @param keys must not be {@literal null}. * @return The number of keys that were removed. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: DEL + * @see Redis Documentation: DEL */ @Nullable Long delete(Collection keys); @@ -202,7 +202,7 @@ T execute(RedisScript script, RedisSerializer argsSerializer, RedisSer * * @param key must not be {@literal null}. * @return The number of keys that were removed. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: UNLINK + * @see Redis Documentation: UNLINK * @since 2.1 */ @Nullable @@ -214,7 +214,7 @@ T execute(RedisScript script, RedisSerializer argsSerializer, RedisSer * * @param keys must not be {@literal null}. * @return The number of keys that were removed. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: UNLINK + * @see Redis Documentation: UNLINK * @since 2.1 */ @Nullable @@ -225,7 +225,7 @@ T execute(RedisScript script, RedisSerializer argsSerializer, RedisSer * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: TYPE + * @see Redis Documentation: TYPE */ @Nullable DataType type(K key); @@ -235,7 +235,7 @@ T execute(RedisScript script, RedisSerializer argsSerializer, RedisSer * * @param pattern must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: KEYS + * @see Redis Documentation: KEYS */ @Nullable Set keys(K pattern); @@ -244,7 +244,7 @@ T execute(RedisScript script, RedisSerializer argsSerializer, RedisSer * Return a random key from the keyspace. * * @return {@literal null} no keys exist or when used in pipeline / transaction. - * @see Redis Documentation: RANDOMKEY + * @see Redis Documentation: RANDOMKEY */ @Nullable K randomKey(); @@ -254,7 +254,7 @@ T execute(RedisScript script, RedisSerializer argsSerializer, RedisSer * * @param oldKey must not be {@literal null}. * @param newKey must not be {@literal null}. - * @see Redis Documentation: RENAME + * @see Redis Documentation: RENAME */ void rename(K oldKey, K newKey); @@ -264,7 +264,7 @@ T execute(RedisScript script, RedisSerializer argsSerializer, RedisSer * @param oldKey must not be {@literal null}. * @param newKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: RENAMENX + * @see Redis Documentation: RENAMENX */ @Nullable Boolean renameIfAbsent(K oldKey, K newKey); @@ -295,7 +295,7 @@ T execute(RedisScript script, RedisSerializer argsSerializer, RedisSer * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: PERSIST + * @see Redis Documentation: PERSIST */ @Nullable Boolean persist(K key); @@ -306,7 +306,7 @@ T execute(RedisScript script, RedisSerializer argsSerializer, RedisSer * @param key must not be {@literal null}. * @param dbIndex * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: MOVE + * @see Redis Documentation: MOVE */ @Nullable Boolean move(K key, int dbIndex); @@ -316,7 +316,7 @@ T execute(RedisScript script, RedisSerializer argsSerializer, RedisSer * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: DUMP + * @see Redis Documentation: DUMP */ @Nullable byte[] dump(K key); @@ -328,7 +328,7 @@ T execute(RedisScript script, RedisSerializer argsSerializer, RedisSer * @param value must not be {@literal null}. * @param timeToLive * @param unit must not be {@literal null}. - * @see Redis Documentation: RESTORE + * @see Redis Documentation: RESTORE */ default void restore(K key, byte[] value, long timeToLive, TimeUnit unit) { restore(key, value, timeToLive, unit, false); @@ -343,7 +343,7 @@ default void restore(K key, byte[] value, long timeToLive, TimeUnit unit) { * @param unit must not be {@literal null}. * @param replace use {@literal true} to replace a potentially existing value instead of erroring. * @since 2.1 - * @see Redis Documentation: RESTORE + * @see Redis Documentation: RESTORE */ void restore(K key, byte[] value, long timeToLive, TimeUnit unit, boolean replace); @@ -352,7 +352,7 @@ default void restore(K key, byte[] value, long timeToLive, TimeUnit unit) { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: TTL + * @see Redis Documentation: TTL */ @Nullable Long getExpire(K key); @@ -373,7 +373,7 @@ default void restore(K key, byte[] value, long timeToLive, TimeUnit unit) { * * @param query must not be {@literal null}. * @return the results of sort. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SORT + * @see Redis Documentation: SORT */ @Nullable List sort(SortQuery query); @@ -383,7 +383,7 @@ default void restore(K key, byte[] value, long timeToLive, TimeUnit unit) { * * @param query must not be {@literal null}. * @return the deserialized results of sort. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SORT + * @see Redis Documentation: SORT */ @Nullable List sort(SortQuery query, RedisSerializer resultSerializer); @@ -393,7 +393,7 @@ default void restore(K key, byte[] value, long timeToLive, TimeUnit unit) { * * @param query must not be {@literal null}. * @return the deserialized results of sort. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SORT + * @see Redis Documentation: SORT */ @Nullable List sort(SortQuery query, BulkMapper bulkMapper); @@ -403,7 +403,7 @@ default void restore(K key, byte[] value, long timeToLive, TimeUnit unit) { * * @param query must not be {@literal null}. * @return the deserialized results of sort. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SORT + * @see Redis Documentation: SORT */ @Nullable List sort(SortQuery query, BulkMapper bulkMapper, RedisSerializer resultSerializer); @@ -414,7 +414,7 @@ default void restore(K key, byte[] value, long timeToLive, TimeUnit unit) { * @param query must not be {@literal null}. * @param storeKey must not be {@literal null}. * @return number of values. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SORT + * @see Redis Documentation: SORT */ @Nullable Long sort(SortQuery query, K storeKey); @@ -427,7 +427,7 @@ default void restore(K key, byte[] value, long timeToLive, TimeUnit unit) { * Watch given {@code key} for modifications during transaction started with {@link #multi()}. * * @param key must not be {@literal null}. - * @see Redis Documentation: WATCH + * @see Redis Documentation: WATCH */ void watch(K key); @@ -435,14 +435,14 @@ default void restore(K key, byte[] value, long timeToLive, TimeUnit unit) { * Watch given {@code keys} for modifications during transaction started with {@link #multi()}. * * @param keys must not be {@literal null}. - * @see Redis Documentation: WATCH + * @see Redis Documentation: WATCH */ void watch(Collection keys); /** * Flushes all the previously {@link #watch(Object)} keys. * - * @see Redis Documentation: UNWATCH + * @see Redis Documentation: UNWATCH */ void unwatch(); @@ -451,14 +451,14 @@ default void restore(K key, byte[] value, long timeToLive, TimeUnit unit) { * Commands will be queued and can then be executed by calling {@link #exec()} or rolled back using {@link #discard()} *

* - * @see Redis Documentation: MULTI + * @see Redis Documentation: MULTI */ void multi(); /** * Discard all commands issued after {@link #multi()}. * - * @see Redis Documentation: DISCARD + * @see Redis Documentation: DISCARD */ void discard(); @@ -467,7 +467,7 @@ default void restore(K key, byte[] value, long timeToLive, TimeUnit unit) { * If used along with {@link #watch(Object)} the operation will fail if any of watched keys has been modified. * * @return List of replies for each executed command. - * @see Redis Documentation: EXEC + * @see Redis Documentation: EXEC */ List exec(); @@ -510,7 +510,7 @@ default void restore(K key, byte[] value, long timeToLive, TimeUnit unit) { * @param host must not be {@literal null}. * @param port * @since 1.3 - * @see Redis Documentation: SLAVEOF + * @see Redis Documentation: SLAVEOF */ void slaveOf(String host, int port); @@ -518,7 +518,7 @@ default void restore(K key, byte[] value, long timeToLive, TimeUnit unit) { * Change server into master. * * @since 1.3 - * @see Redis Documentation: SLAVEOF + * @see Redis Documentation: SLAVEOF */ void slaveOfNoOne(); @@ -528,7 +528,7 @@ default void restore(K key, byte[] value, long timeToLive, TimeUnit unit) { * @param destination the channel to publish to, must not be {@literal null}. * @param message message to publish * @return the number of clients that received the message - * @see Redis Documentation: PUBLISH + * @see Redis Documentation: PUBLISH */ void convertAndSend(String destination, Object message); diff --git a/src/main/java/org/springframework/data/redis/core/SetOperations.java b/src/main/java/org/springframework/data/redis/core/SetOperations.java index d40151b907..f9c9e127c8 100644 --- a/src/main/java/org/springframework/data/redis/core/SetOperations.java +++ b/src/main/java/org/springframework/data/redis/core/SetOperations.java @@ -37,7 +37,7 @@ public interface SetOperations { * @param key must not be {@literal null}. * @param values * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SADD + * @see Redis Documentation: SADD */ @Nullable Long add(K key, V... values); @@ -48,7 +48,7 @@ public interface SetOperations { * @param key must not be {@literal null}. * @param values * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SREM + * @see Redis Documentation: SREM */ @Nullable Long remove(K key, Object... values); @@ -58,7 +58,7 @@ public interface SetOperations { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SPOP + * @see Redis Documentation: SPOP */ @Nullable V pop(K key); @@ -69,7 +69,7 @@ public interface SetOperations { * @param key must not be {@literal null}. * @param count number of random members to pop from the set. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SPOP + * @see Redis Documentation: SPOP * @since 2.0 */ @Nullable @@ -82,7 +82,7 @@ public interface SetOperations { * @param value * @param destKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SMOVE + * @see Redis Documentation: SMOVE */ @Nullable Boolean move(K key, V value, K destKey); @@ -92,7 +92,7 @@ public interface SetOperations { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SCARD + * @see Redis Documentation: SCARD */ @Nullable Long size(K key); @@ -103,7 +103,7 @@ public interface SetOperations { * @param key must not be {@literal null}. * @param o * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SISMEMBER + * @see Redis Documentation: SISMEMBER */ @Nullable Boolean isMember(K key, Object o); @@ -114,7 +114,7 @@ public interface SetOperations { * @param key must not be {@literal null}. * @param otherKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SINTER + * @see Redis Documentation: SINTER */ @Nullable Set intersect(K key, K otherKey); @@ -125,7 +125,7 @@ public interface SetOperations { * @param key must not be {@literal null}. * @param otherKeys must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SINTER + * @see Redis Documentation: SINTER */ @Nullable Set intersect(K key, Collection otherKeys); @@ -135,7 +135,7 @@ public interface SetOperations { * * @param keys must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SINTER + * @see Redis Documentation: SINTER * @since 2.2 */ @Nullable @@ -148,7 +148,7 @@ public interface SetOperations { * @param otherKey must not be {@literal null}. * @param destKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SINTERSTORE + * @see Redis Documentation: SINTERSTORE */ @Nullable Long intersectAndStore(K key, K otherKey, K destKey); @@ -160,7 +160,7 @@ public interface SetOperations { * @param otherKeys must not be {@literal null}. * @param destKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SINTERSTORE + * @see Redis Documentation: SINTERSTORE */ @Nullable Long intersectAndStore(K key, Collection otherKeys, K destKey); @@ -171,7 +171,7 @@ public interface SetOperations { * @param keys must not be {@literal null}. * @param destKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SINTERSTORE + * @see Redis Documentation: SINTERSTORE * @since 2.2 */ @Nullable @@ -183,7 +183,7 @@ public interface SetOperations { * @param key must not be {@literal null}. * @param otherKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SUNION + * @see Redis Documentation: SUNION */ @Nullable Set union(K key, K otherKey); @@ -194,7 +194,7 @@ public interface SetOperations { * @param key must not be {@literal null}. * @param otherKeys must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SUNION + * @see Redis Documentation: SUNION */ @Nullable Set union(K key, Collection otherKeys); @@ -204,7 +204,7 @@ public interface SetOperations { * * @param keys must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SUNION + * @see Redis Documentation: SUNION * @since 2.2 */ @Nullable @@ -217,7 +217,7 @@ public interface SetOperations { * @param otherKey must not be {@literal null}. * @param destKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SUNIONSTORE + * @see Redis Documentation: SUNIONSTORE */ @Nullable Long unionAndStore(K key, K otherKey, K destKey); @@ -229,7 +229,7 @@ public interface SetOperations { * @param otherKeys must not be {@literal null}. * @param destKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SUNIONSTORE + * @see Redis Documentation: SUNIONSTORE */ @Nullable Long unionAndStore(K key, Collection otherKeys, K destKey); @@ -240,7 +240,7 @@ public interface SetOperations { * @param keys must not be {@literal null}. * @param destKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SUNIONSTORE + * @see Redis Documentation: SUNIONSTORE * @since 2.2 */ @Nullable @@ -252,7 +252,7 @@ public interface SetOperations { * @param key must not be {@literal null}. * @param otherKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SDIFF + * @see Redis Documentation: SDIFF */ @Nullable Set difference(K key, K otherKey); @@ -263,7 +263,7 @@ public interface SetOperations { * @param key must not be {@literal null}. * @param otherKeys must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SDIFF + * @see Redis Documentation: SDIFF */ @Nullable Set difference(K key, Collection otherKeys); @@ -273,7 +273,7 @@ public interface SetOperations { * * @param keys must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SDIFF + * @see Redis Documentation: SDIFF * @since 2.2 */ @Nullable @@ -286,7 +286,7 @@ public interface SetOperations { * @param otherKey must not be {@literal null}. * @param destKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SDIFFSTORE + * @see Redis Documentation: SDIFFSTORE */ @Nullable Long differenceAndStore(K key, K otherKey, K destKey); @@ -298,7 +298,7 @@ public interface SetOperations { * @param otherKeys must not be {@literal null}. * @param destKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SDIFFSTORE + * @see Redis Documentation: SDIFFSTORE */ @Nullable Long differenceAndStore(K key, Collection otherKeys, K destKey); @@ -309,7 +309,7 @@ public interface SetOperations { * @param keys must not be {@literal null}. * @param destKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SDIFFSTORE + * @see Redis Documentation: SDIFFSTORE * @since 2.2 */ @Nullable @@ -320,7 +320,7 @@ public interface SetOperations { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SMEMBERS + * @see Redis Documentation: SMEMBERS */ @Nullable Set members(K key); @@ -330,7 +330,7 @@ public interface SetOperations { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SRANDMEMBER + * @see Redis Documentation: SRANDMEMBER */ V randomMember(K key); @@ -341,7 +341,7 @@ public interface SetOperations { * @param count nr of members to return * @return empty {@link Set} if {@code key} does not exist. * @throws IllegalArgumentException if count is negative. - * @see Redis Documentation: SRANDMEMBER + * @see Redis Documentation: SRANDMEMBER */ @Nullable Set distinctRandomMembers(K key, long count); @@ -353,7 +353,7 @@ public interface SetOperations { * @param count nr of members to return. * @return empty {@link List} if {@code key} does not exist or {@literal null} when used in pipeline / transaction. * @throws IllegalArgumentException if count is negative. - * @see Redis Documentation: SRANDMEMBER + * @see Redis Documentation: SRANDMEMBER */ @Nullable List randomMembers(K key, long count); diff --git a/src/main/java/org/springframework/data/redis/core/StreamOperations.java b/src/main/java/org/springframework/data/redis/core/StreamOperations.java index d10149c45e..02c973aa0b 100644 --- a/src/main/java/org/springframework/data/redis/core/StreamOperations.java +++ b/src/main/java/org/springframework/data/redis/core/StreamOperations.java @@ -52,7 +52,7 @@ public interface StreamOperations extends HashMapperProvider * @param group name of the consumer group. * @param recordIds record id's to acknowledge. * @return length of acknowledged records. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XACK + * @see Redis Documentation: XACK */ @Nullable Long acknowledge(K key, String group, String... recordIds); @@ -64,7 +64,7 @@ public interface StreamOperations extends HashMapperProvider * @param group name of the consumer group. * @param recordIds record id's to acknowledge. * @return length of acknowledged records. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XACK + * @see Redis Documentation: XACK */ @Nullable default Long acknowledge(K key, String group, RecordId... recordIds) { @@ -77,7 +77,7 @@ default Long acknowledge(K key, String group, RecordId... recordIds) { * @param group name of the consumer group. * @param record the {@link Record} to acknowledge. * @return length of acknowledged records. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XACK + * @see Redis Documentation: XACK */ default Long acknowledge(String group, Record record) { return acknowledge(record.getStream(), group, record.getId()); @@ -89,7 +89,7 @@ default Long acknowledge(String group, Record record) { * @param key the stream key. * @param content record content as Map. * @return the record Id. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XADD + * @see Redis Documentation: XADD */ @SuppressWarnings("unchecked") @Nullable @@ -102,7 +102,7 @@ default RecordId add(K key, Map content) { * * @param record the record to append. * @return the record Id. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XADD + * @see Redis Documentation: XADD */ @Nullable @SuppressWarnings("unchecked") @@ -129,7 +129,7 @@ default RecordId add(MapRecord record) { * @param key the stream key. * @param recordIds stream record Id's. * @return number of removed entries. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XDEL + * @see Redis Documentation: XDEL */ @Nullable default Long delete(K key, String... recordIds) { @@ -154,7 +154,7 @@ default Long delete(Record record) { * @param key the stream key. * @param recordIds stream record Id's. * @return the {@link Mono} emitting the number of removed records. - * @see Redis Documentation: XDEL + * @see Redis Documentation: XDEL */ @Nullable Long delete(K key, RecordId... recordIds); @@ -206,7 +206,7 @@ default String createGroup(K key, String group) { * * @param key the stream key. * @return length of the stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XLEN + * @see Redis Documentation: XLEN */ @Nullable Long size(K key); @@ -217,7 +217,7 @@ default String createGroup(K key, String group) { * @param key the stream key. * @param range must not be {@literal null}. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XRANGE + * @see Redis Documentation: XRANGE */ @Nullable default List> range(K key, Range range) { @@ -231,7 +231,7 @@ default List> range(K key, Range range) { * @param range must not be {@literal null}. * @param limit must not be {@literal null}. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XRANGE + * @see Redis Documentation: XRANGE */ @Nullable List> range(K key, Range range, Limit limit); @@ -243,7 +243,7 @@ default List> range(K key, Range range) { * @param key the stream key. * @param range must not be {@literal null}. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XRANGE + * @see Redis Documentation: XRANGE */ default List> range(Class targetType, K key, Range range) { return range(targetType, key, range, Limit.unlimited()); @@ -257,7 +257,7 @@ default List> range(Class targetType, K key, RangeRedis Documentation: XRANGE + * @see Redis Documentation: XRANGE */ default List> range(Class targetType, K key, Range range, Limit limit) { @@ -271,7 +271,7 @@ default List> range(Class targetType, K key, RangeRedis Documentation: XREAD + * @see Redis Documentation: XREAD */ @Nullable default List> read(StreamOffset... streams) { @@ -284,7 +284,7 @@ default List> read(StreamOffset... streams) { * @param targetType the target type of the payload. * @param streams the streams to read from. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XREAD + * @see Redis Documentation: XREAD */ default List> read(Class targetType, StreamOffset... streams) { return read(targetType, StreamReadOptions.empty(), streams); @@ -296,7 +296,7 @@ default List> read(Class targetType, StreamOffset.. * @param readOptions read arguments. * @param streams the streams to read from. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XREAD + * @see Redis Documentation: XREAD */ @Nullable List> read(StreamReadOptions readOptions, StreamOffset... streams); @@ -308,7 +308,7 @@ default List> read(Class targetType, StreamOffset.. * @param readOptions read arguments. * @param streams the streams to read from. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XREAD + * @see Redis Documentation: XREAD */ @Nullable default List> read(Class targetType, StreamReadOptions readOptions, @@ -325,7 +325,7 @@ default List> read(Class targetType, StreamReadOptions * @param consumer consumer/group. * @param streams the streams to read from. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XREADGROUP + * @see Redis Documentation: XREADGROUP */ @Nullable default List> read(Consumer consumer, StreamOffset... streams) { @@ -339,7 +339,7 @@ default List> read(Consumer consumer, StreamOffset... st * @param consumer consumer/group. * @param streams the streams to read from. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XREADGROUP + * @see Redis Documentation: XREADGROUP */ @Nullable default List> read(Class targetType, Consumer consumer, StreamOffset... streams) { @@ -353,7 +353,7 @@ default List> read(Class targetType, Consumer consumer * @param readOptions read arguments. * @param streams the streams to read from. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XREADGROUP + * @see Redis Documentation: XREADGROUP */ @Nullable List> read(Consumer consumer, StreamReadOptions readOptions, StreamOffset... streams); @@ -366,7 +366,7 @@ default List> read(Class targetType, Consumer consumer * @param readOptions read arguments. * @param streams the streams to read from. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XREADGROUP + * @see Redis Documentation: XREADGROUP */ @Nullable default List> read(Class targetType, Consumer consumer, StreamReadOptions readOptions, @@ -383,7 +383,7 @@ default List> read(Class targetType, Consumer consumer * @param key the stream key. * @param range must not be {@literal null}. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XREVRANGE + * @see Redis Documentation: XREVRANGE */ @Nullable default List> reverseRange(K key, Range range) { @@ -397,7 +397,7 @@ default List> reverseRange(K key, Range range) { * @param range must not be {@literal null}. * @param limit must not be {@literal null}. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XREVRANGE + * @see Redis Documentation: XREVRANGE */ @Nullable List> reverseRange(K key, Range range, Limit limit); @@ -409,7 +409,7 @@ default List> reverseRange(K key, Range range) { * @param key the stream key. * @param range must not be {@literal null}. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XREVRANGE + * @see Redis Documentation: XREVRANGE */ default List> reverseRange(Class targetType, K key, Range range) { return reverseRange(targetType, key, range, Limit.unlimited()); @@ -424,7 +424,7 @@ default List> reverseRange(Class targetType, K key, Ra * @param range must not be {@literal null}. * @param limit must not be {@literal null}. * @return list with members of the resulting stream. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XREVRANGE + * @see Redis Documentation: XREVRANGE */ default List> reverseRange(Class targetType, K key, Range range, Limit limit) { @@ -439,7 +439,7 @@ default List> reverseRange(Class targetType, K key, Ra * @param key the stream key. * @param count length of the stream. * @return number of removed entries. {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: XTRIM + * @see Redis Documentation: XTRIM */ @Nullable Long trim(K key, long count); diff --git a/src/main/java/org/springframework/data/redis/core/ValueOperations.java b/src/main/java/org/springframework/data/redis/core/ValueOperations.java index 49de87e21d..4f8a90460d 100644 --- a/src/main/java/org/springframework/data/redis/core/ValueOperations.java +++ b/src/main/java/org/springframework/data/redis/core/ValueOperations.java @@ -40,7 +40,7 @@ public interface ValueOperations { * * @param key must not be {@literal null}. * @param value must not be {@literal null}. - * @see Redis Documentation: SET + * @see Redis Documentation: SET */ void set(K key, V value); @@ -51,7 +51,7 @@ public interface ValueOperations { * @param value must not be {@literal null}. * @param timeout the key expiration timeout. * @param unit must not be {@literal null}. - * @see Redis Documentation: SETEX + * @see Redis Documentation: SETEX */ void set(K key, V value, long timeout, TimeUnit unit); @@ -62,7 +62,7 @@ public interface ValueOperations { * @param value must not be {@literal null}. * @param timeout must not be {@literal null}. * @throws IllegalArgumentException if either {@code key}, {@code value} or {@code timeout} is not present. - * @see Redis Documentation: SETEX + * @see Redis Documentation: SETEX * @since 2.1 */ default void set(K key, V value, Duration timeout) { @@ -82,7 +82,7 @@ default void set(K key, V value, Duration timeout) { * @param key must not be {@literal null}. * @param value must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: SETNX + * @see Redis Documentation: SETNX */ @Nullable Boolean setIfAbsent(K key, V value); @@ -96,7 +96,7 @@ default void set(K key, V value, Duration timeout) { * @param unit must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 2.1 - * @see Redis Documentation: SET + * @see Redis Documentation: SET */ @Nullable Boolean setIfAbsent(K key, V value, long timeout, TimeUnit unit); @@ -109,7 +109,7 @@ default void set(K key, V value, Duration timeout) { * @param timeout must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @throws IllegalArgumentException if either {@code key}, {@code value} or {@code timeout} is not present. - * @see Redis Documentation: SET + * @see Redis Documentation: SET * @since 2.1 */ @Nullable @@ -131,7 +131,7 @@ default Boolean setIfAbsent(K key, V value, Duration timeout) { * @param value must not be {@literal null}. * @return command result indicating if the key has been set. * @throws IllegalArgumentException if either {@code key} or {@code value} is not present. - * @see Redis Documentation: SET + * @see Redis Documentation: SET * @since 2.1 */ @Nullable @@ -146,7 +146,7 @@ default Boolean setIfAbsent(K key, V value, Duration timeout) { * @param unit must not be {@literal null}. * @return command result indicating if the key has been set. * @throws IllegalArgumentException if either {@code key}, {@code value} or {@code timeout} is not present. - * @see Redis Documentation: SET + * @see Redis Documentation: SET * @since 2.1 */ @Nullable @@ -160,7 +160,7 @@ default Boolean setIfAbsent(K key, V value, Duration timeout) { * @param timeout must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @throws IllegalArgumentException if either {@code key}, {@code value} or {@code timeout} is not present. - * @see Redis Documentation: SET + * @see Redis Documentation: SET * @since 2.1 */ @Nullable @@ -179,7 +179,7 @@ default Boolean setIfPresent(K key, V value, Duration timeout) { * Set multiple keys to multiple values using key-value pairs provided in {@code tuple}. * * @param map must not be {@literal null}. - * @see Redis Documentation: MSET + * @see Redis Documentation: MSET */ void multiSet(Map map); @@ -189,7 +189,7 @@ default Boolean setIfPresent(K key, V value, Duration timeout) { * * @param map must not be {@literal null}. * @param {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: MSET + * @see Redis Documentation: MSET */ @Nullable Boolean multiSetIfAbsent(Map map); @@ -199,7 +199,7 @@ default Boolean setIfPresent(K key, V value, Duration timeout) { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GET + * @see Redis Documentation: GET */ @Nullable V get(Object key); @@ -209,7 +209,7 @@ default Boolean setIfPresent(K key, V value, Duration timeout) { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GETSET + * @see Redis Documentation: GETSET */ @Nullable V getAndSet(K key, V value); @@ -219,7 +219,7 @@ default Boolean setIfPresent(K key, V value, Duration timeout) { * * @param keys must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: MGET + * @see Redis Documentation: MGET */ @Nullable List multiGet(Collection keys); @@ -230,7 +230,7 @@ default Boolean setIfPresent(K key, V value, Duration timeout) { * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 2.1 - * @see Redis Documentation: INCR + * @see Redis Documentation: INCR */ @Nullable Long increment(K key); @@ -241,7 +241,7 @@ default Boolean setIfPresent(K key, V value, Duration timeout) { * @param key must not be {@literal null}. * @param delta * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: INCRBY + * @see Redis Documentation: INCRBY */ @Nullable Long increment(K key, long delta); @@ -252,7 +252,7 @@ default Boolean setIfPresent(K key, V value, Duration timeout) { * @param key must not be {@literal null}. * @param delta * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: INCRBYFLOAT + * @see Redis Documentation: INCRBYFLOAT */ @Nullable Double increment(K key, double delta); @@ -263,7 +263,7 @@ default Boolean setIfPresent(K key, V value, Duration timeout) { * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 2.1 - * @see Redis Documentation: DECR + * @see Redis Documentation: DECR */ @Nullable Long decrement(K key); @@ -275,7 +275,7 @@ default Boolean setIfPresent(K key, V value, Duration timeout) { * @param delta * @return {@literal null} when used in pipeline / transaction. * @since 2.1 - * @see Redis Documentation: DECRBY + * @see Redis Documentation: DECRBY */ @Nullable Long decrement(K key, long delta); @@ -286,7 +286,7 @@ default Boolean setIfPresent(K key, V value, Duration timeout) { * @param key must not be {@literal null}. * @param value * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: APPEND + * @see Redis Documentation: APPEND */ @Nullable Integer append(K key, String value); @@ -298,7 +298,7 @@ default Boolean setIfPresent(K key, V value, Duration timeout) { * @param start * @param end * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: GETRANGE + * @see Redis Documentation: GETRANGE */ @Nullable String get(K key, long start, long end); @@ -309,7 +309,7 @@ default Boolean setIfPresent(K key, V value, Duration timeout) { * @param key must not be {@literal null}. * @param value * @param offset - * @see Redis Documentation: SETRANGE + * @see Redis Documentation: SETRANGE */ void set(K key, V value, long offset); @@ -318,7 +318,7 @@ default Boolean setIfPresent(K key, V value, Duration timeout) { * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: STRLEN + * @see Redis Documentation: STRLEN */ @Nullable Long size(K key); @@ -331,7 +331,7 @@ default Boolean setIfPresent(K key, V value, Duration timeout) { * @param value * @return {@literal null} when used in pipeline / transaction. * @since 1.5 - * @see Redis Documentation: SETBIT + * @see Redis Documentation: SETBIT */ @Nullable Boolean setBit(K key, long offset, boolean value); @@ -343,7 +343,7 @@ default Boolean setIfPresent(K key, V value, Duration timeout) { * @param offset * @return {@literal null} when used in pipeline / transaction. * @since 1.5 - * @see Redis Documentation: GETBIT + * @see Redis Documentation: GETBIT */ @Nullable Boolean getBit(K key, long offset); @@ -356,7 +356,7 @@ default Boolean setIfPresent(K key, V value, Duration timeout) { * @param subCommands must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 2.1 - * @see Redis Documentation: BITFIELD + * @see Redis Documentation: BITFIELD */ @Nullable List bitField(K key, BitFieldSubCommands subCommands); diff --git a/src/main/java/org/springframework/data/redis/core/ZSetOperations.java b/src/main/java/org/springframework/data/redis/core/ZSetOperations.java index ac57c07aef..244fe49f62 100644 --- a/src/main/java/org/springframework/data/redis/core/ZSetOperations.java +++ b/src/main/java/org/springframework/data/redis/core/ZSetOperations.java @@ -55,7 +55,7 @@ interface TypedTuple extends Comparable> { * @param score the score. * @param value the value. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZADD + * @see Redis Documentation: ZADD */ @Nullable Boolean add(K key, V value, double score); @@ -66,7 +66,7 @@ interface TypedTuple extends Comparable> { * @param key must not be {@literal null}. * @param tuples must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZADD + * @see Redis Documentation: ZADD */ @Nullable Long add(K key, Set> tuples); @@ -77,7 +77,7 @@ interface TypedTuple extends Comparable> { * @param key must not be {@literal null}. * @param values must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREM + * @see Redis Documentation: ZREM */ @Nullable Long remove(K key, Object... values); @@ -89,7 +89,7 @@ interface TypedTuple extends Comparable> { * @param delta * @param value the value. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZINCRBY + * @see Redis Documentation: ZINCRBY */ @Nullable Double incrementScore(K key, V value, double delta); @@ -100,7 +100,7 @@ interface TypedTuple extends Comparable> { * @param key must not be {@literal null}. * @param o the value. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZRANK + * @see Redis Documentation: ZRANK */ @Nullable Long rank(K key, Object o); @@ -111,7 +111,7 @@ interface TypedTuple extends Comparable> { * @param key must not be {@literal null}. * @param o the value. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREVRANK + * @see Redis Documentation: ZREVRANK */ @Nullable Long reverseRank(K key, Object o); @@ -123,7 +123,7 @@ interface TypedTuple extends Comparable> { * @param start * @param end * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZRANGE + * @see Redis Documentation: ZRANGE */ @Nullable Set range(K key, long start, long end); @@ -135,7 +135,7 @@ interface TypedTuple extends Comparable> { * @param start * @param end * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZRANGE + * @see Redis Documentation: ZRANGE */ @Nullable Set> rangeWithScores(K key, long start, long end); @@ -147,7 +147,7 @@ interface TypedTuple extends Comparable> { * @param min * @param max * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE */ @Nullable Set rangeByScore(K key, double min, double max); @@ -159,7 +159,7 @@ interface TypedTuple extends Comparable> { * @param min * @param max * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE */ @Nullable Set> rangeByScoreWithScores(K key, double min, double max); @@ -174,7 +174,7 @@ interface TypedTuple extends Comparable> { * @param offset * @param count * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE */ @Nullable Set rangeByScore(K key, double min, double max, long offset, long count); @@ -189,7 +189,7 @@ interface TypedTuple extends Comparable> { * @param offset * @param count * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZRANGEBYSCORE + * @see Redis Documentation: ZRANGEBYSCORE */ @Nullable Set> rangeByScoreWithScores(K key, double min, double max, long offset, long count); @@ -201,7 +201,7 @@ interface TypedTuple extends Comparable> { * @param start * @param end * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREVRANGE + * @see Redis Documentation: ZREVRANGE */ @Nullable Set reverseRange(K key, long start, long end); @@ -213,7 +213,7 @@ interface TypedTuple extends Comparable> { * @param start * @param end * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREVRANGE + * @see Redis Documentation: ZREVRANGE */ @Nullable Set> reverseRangeWithScores(K key, long start, long end); @@ -225,7 +225,7 @@ interface TypedTuple extends Comparable> { * @param min * @param max * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREVRANGE + * @see Redis Documentation: ZREVRANGE */ @Nullable Set reverseRangeByScore(K key, double min, double max); @@ -238,7 +238,7 @@ interface TypedTuple extends Comparable> { * @param min * @param max * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREVRANGEBYSCORE + * @see Redis Documentation: ZREVRANGEBYSCORE */ @Nullable Set> reverseRangeByScoreWithScores(K key, double min, double max); @@ -253,7 +253,7 @@ interface TypedTuple extends Comparable> { * @param offset * @param count * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREVRANGEBYSCORE + * @see Redis Documentation: ZREVRANGEBYSCORE */ @Nullable Set reverseRangeByScore(K key, double min, double max, long offset, long count); @@ -268,7 +268,7 @@ interface TypedTuple extends Comparable> { * @param offset * @param count * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREVRANGEBYSCORE + * @see Redis Documentation: ZREVRANGEBYSCORE */ @Nullable Set> reverseRangeByScoreWithScores(K key, double min, double max, long offset, long count); @@ -280,7 +280,7 @@ interface TypedTuple extends Comparable> { * @param min * @param max * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZCOUNT + * @see Redis Documentation: ZCOUNT */ @Nullable Long count(K key, double min, double max); @@ -291,7 +291,7 @@ interface TypedTuple extends Comparable> { * @see #zCard(Object) * @param key * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZCARD + * @see Redis Documentation: ZCARD */ @Nullable Long size(K key); @@ -302,7 +302,7 @@ interface TypedTuple extends Comparable> { * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 1.3 - * @see Redis Documentation: ZCARD + * @see Redis Documentation: ZCARD */ @Nullable Long zCard(K key); @@ -313,7 +313,7 @@ interface TypedTuple extends Comparable> { * @param key must not be {@literal null}. * @param o the value. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZSCORE + * @see Redis Documentation: ZSCORE */ @Nullable Double score(K key, Object o); @@ -325,7 +325,7 @@ interface TypedTuple extends Comparable> { * @param start * @param end * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREMRANGEBYRANK + * @see Redis Documentation: ZREMRANGEBYRANK */ @Nullable Long removeRange(K key, long start, long end); @@ -337,7 +337,7 @@ interface TypedTuple extends Comparable> { * @param min * @param max * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZREMRANGEBYSCORE + * @see Redis Documentation: ZREMRANGEBYSCORE */ @Nullable Long removeRangeByScore(K key, double min, double max); @@ -349,7 +349,7 @@ interface TypedTuple extends Comparable> { * @param otherKey must not be {@literal null}. * @param destKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZUNIONSTORE + * @see Redis Documentation: ZUNIONSTORE */ @Nullable Long unionAndStore(K key, K otherKey, K destKey); @@ -361,7 +361,7 @@ interface TypedTuple extends Comparable> { * @param otherKeys must not be {@literal null}. * @param destKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZUNIONSTORE + * @see Redis Documentation: ZUNIONSTORE */ @Nullable Long unionAndStore(K key, Collection otherKeys, K destKey); @@ -375,7 +375,7 @@ interface TypedTuple extends Comparable> { * @param aggregate must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 2.1 - * @see Redis Documentation: ZUNIONSTORE + * @see Redis Documentation: ZUNIONSTORE */ @Nullable default Long unionAndStore(K key, Collection otherKeys, K destKey, Aggregate aggregate) { @@ -392,7 +392,7 @@ default Long unionAndStore(K key, Collection otherKeys, K destKey, Aggregate * @param weights must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 2.1 - * @see Redis Documentation: ZUNIONSTORE + * @see Redis Documentation: ZUNIONSTORE */ @Nullable Long unionAndStore(K key, Collection otherKeys, K destKey, Aggregate aggregate, Weights weights); @@ -404,7 +404,7 @@ default Long unionAndStore(K key, Collection otherKeys, K destKey, Aggregate * @param otherKey must not be {@literal null}. * @param destKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZINTERSTORE + * @see Redis Documentation: ZINTERSTORE */ @Nullable Long intersectAndStore(K key, K otherKey, K destKey); @@ -416,7 +416,7 @@ default Long unionAndStore(K key, Collection otherKeys, K destKey, Aggregate * @param otherKeys must not be {@literal null}. * @param destKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZINTERSTORE + * @see Redis Documentation: ZINTERSTORE */ @Nullable Long intersectAndStore(K key, Collection otherKeys, K destKey); @@ -430,7 +430,7 @@ default Long unionAndStore(K key, Collection otherKeys, K destKey, Aggregate * @param aggregate must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 2.1 - * @see Redis Documentation: ZINTERSTORE + * @see Redis Documentation: ZINTERSTORE */ @Nullable default Long intersectAndStore(K key, Collection otherKeys, K destKey, Aggregate aggregate) { @@ -447,7 +447,7 @@ default Long intersectAndStore(K key, Collection otherKeys, K destKey, Aggreg * @param weights must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 2.1 - * @see Redis Documentation: ZINTERSTORE + * @see Redis Documentation: ZINTERSTORE */ @Nullable Long intersectAndStore(K key, Collection otherKeys, K destKey, Aggregate aggregate, Weights weights); @@ -459,7 +459,7 @@ default Long intersectAndStore(K key, Collection otherKeys, K destKey, Aggreg * @param key * @param options * @return {@literal null} when used in pipeline / transaction. - * @see Redis Documentation: ZSCAN + * @see Redis Documentation: ZSCAN * @since 1.4 */ Cursor> scan(K key, ScanOptions options); @@ -472,7 +472,7 @@ default Long intersectAndStore(K key, Collection otherKeys, K destKey, Aggreg * @param range must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 1.7 - * @see Redis Documentation: ZRANGEBYLEX + * @see Redis Documentation: ZRANGEBYLEX */ @Nullable Set rangeByLex(K key, Range range); @@ -487,7 +487,7 @@ default Long intersectAndStore(K key, Collection otherKeys, K destKey, Aggreg * @param limit can be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 1.7 - * @see Redis Documentation: ZRANGEBYLEX + * @see Redis Documentation: ZRANGEBYLEX */ @Nullable Set rangeByLex(K key, Range range, Limit limit); diff --git a/src/main/java/org/springframework/data/redis/core/script/RedisScript.java b/src/main/java/org/springframework/data/redis/core/script/RedisScript.java index fbf5f68c09..c990aaa61b 100644 --- a/src/main/java/org/springframework/data/redis/core/script/RedisScript.java +++ b/src/main/java/org/springframework/data/redis/core/script/RedisScript.java @@ -19,7 +19,7 @@ import org.springframework.util.Assert; /** - * A script to be executed using the Redis scripting support available as of + * A script to be executed using the Redis scripting support available as of * version 2.6 * * @author Jennifer Hickey diff --git a/src/main/resources/org/springframework/data/redis/config/spring-redis-1.0.xsd b/src/main/resources/org/springframework/data/redis/config/spring-redis-1.0.xsd index 285039a64e..ba260c1482 100644 --- a/src/main/resources/org/springframework/data/redis/config/spring-redis-1.0.xsd +++ b/src/main/resources/org/springframework/data/redis/config/spring-redis-1.0.xsd @@ -8,7 +8,7 @@ elementFormDefault="qualified" attributeFormDefault="unqualified"> - +