Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 5d968c9

Browse files
committed
Fix broken Javadoc.
Closes #3148 
1 parent 13343a0 commit 5d968c9

22 files changed

+65
-82
lines changed

‎src/main/java/org/springframework/data/redis/cache/RedisCacheConfiguration.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -437,12 +437,12 @@ public void configureKeyConverters(Consumer<ConverterRegistry> registryConsumer)
437437
* <p>
438438
* The following converters get registered:
439439
* <ul>
440-
* <li>{@link String} to {@link byte byte[]} using UTF-8 encoding.</li>
440+
* <li>{@link String} to {@code byte byte[]} using UTF-8 encoding.</li>
441441
* <li>{@link SimpleKey} to {@link String}</li>
442442
* </ul>
443443
*
444-
* @param registry {@link ConverterRegistry} in which the {@link Converter key converters} are registered;
445-
* must not be {@literal null}.
444+
* @param registry {@link ConverterRegistry} in which the {@link Converter key converters} are registered; must not be
445+
* {@literal null}.
446446
* @see org.springframework.core.convert.converter.ConverterRegistry
447447
*/
448448
public static void registerDefaultConverters(ConverterRegistry registry) {

‎src/main/java/org/springframework/data/redis/cache/RedisCacheWriter.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -182,13 +182,13 @@ default boolean supportsAsyncRetrieve() {
182182

183183
/**
184184
* Asynchronously retrieves the {@link CompletableFuture value} to which the {@link RedisCache} maps the given
185-
* {@link byte[] key}.
185+
* {@code byte[] key}.
186186
* <p>
187187
* This operation is non-blocking.
188188
*
189189
* @param name {@link String} with the name of the {@link RedisCache}.
190-
* @param key {@link byte[] key} mapped to the {@link CompletableFuture value} in the {@link RedisCache}.
191-
* @return the {@link CompletableFuture value} to which the {@link RedisCache} maps the given {@link byte[] key}.
190+
* @param key {@code byte[] key} mapped to the {@link CompletableFuture value} in the {@link RedisCache}.
191+
* @return the {@link CompletableFuture value} to which the {@link RedisCache} maps the given {@code byte[] key}.
192192
* @see #retrieve(String, byte[], Duration)
193193
* @since 3.2
194194
*/
@@ -198,14 +198,14 @@ default CompletableFuture<byte[]> retrieve(String name, byte[] key) {
198198

199199
/**
200200
* Asynchronously retrieves the {@link CompletableFuture value} to which the {@link RedisCache} maps the given
201-
* {@link byte[] key} setting the {@link Duration TTL expiration} for the cache entry.
201+
* {@code byte[] key} setting the {@link Duration TTL expiration} for the cache entry.
202202
* <p>
203203
* This operation is non-blocking.
204204
*
205205
* @param name {@link String} with the name of the {@link RedisCache}.
206-
* @param key {@link byte[] key} mapped to the {@link CompletableFuture value} in the {@link RedisCache}.
206+
* @param key {@code byte[] key} mapped to the {@link CompletableFuture value} in the {@link RedisCache}.
207207
* @param ttl {@link Duration} specifying the {@literal expiration timeout} for the cache entry.
208-
* @return the {@link CompletableFuture value} to which the {@link RedisCache} maps the given {@link byte[] key}.
208+
* @return the {@link CompletableFuture value} to which the {@link RedisCache} maps the given {@code byte[] key}.
209209
* @since 3.2
210210
*/
211211
CompletableFuture<byte[]> retrieve(String name, byte[] key, @Nullable Duration ttl);

‎src/main/java/org/springframework/data/redis/connection/ClusterCommandExecutor.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -471,9 +471,9 @@ public RedisClusterNode getNode() {
471471
}
472472

473473
/**
474-
* Return the {@link byte[] key} mapped to the value stored in Redis.
474+
* Return the {@code byte[] key} mapped to the value stored in Redis.
475475
*
476-
* @return a {@link byte[] byte array} of the key mapped to the value stored in Redis.
476+
* @return a {@code byte[] byte array} of the key mapped to the value stored in Redis.
477477
*/
478478
public byte[] getKey() {
479479
return this.key.getArray();

‎src/main/java/org/springframework/data/redis/connection/ReactiveZSetCommands.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1974,7 +1974,7 @@ default Mono<Long> zCard(ByteBuffer key) {
19741974
}
19751975

19761976
/**
1977-
* Get the size of sorted set with {@linByteBuffer keyCommand#getKey()}.
1977+
* Get the size of sorted set with {@link ByteBuffer keyCommand#getKey()}.
19781978
*
19791979
* @param commands must not be {@literal null}.
19801980
* @return

‎src/main/java/org/springframework/data/redis/connection/ReturnType.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,12 @@ public enum ReturnType {
4646
MULTI,
4747

4848
/**
49-
* Returned as {@literal byte[]}
49+
* Returned as {@code byte[]}
5050
*/
5151
STATUS,
5252

5353
/**
54-
* Returned as {@literal byte[]}
54+
* Returned as {@code byte[]}
5555
*/
5656
VALUE;
5757

‎src/main/java/org/springframework/data/redis/connection/jedis/JedisConnection.java‎

Lines changed: 20 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,21 @@
1515
*/
1616
package org.springframework.data.redis.connection.jedis;
1717

18+
import redis.clients.jedis.BuilderFactory;
19+
import redis.clients.jedis.CommandArguments;
20+
import redis.clients.jedis.CommandObject;
21+
import redis.clients.jedis.DefaultJedisClientConfig;
22+
import redis.clients.jedis.HostAndPort;
23+
import redis.clients.jedis.Jedis;
24+
import redis.clients.jedis.JedisClientConfig;
25+
import redis.clients.jedis.Pipeline;
26+
import redis.clients.jedis.Response;
27+
import redis.clients.jedis.Transaction;
28+
import redis.clients.jedis.commands.ProtocolCommand;
29+
import redis.clients.jedis.commands.ServerCommands;
30+
import redis.clients.jedis.exceptions.JedisDataException;
31+
import redis.clients.jedis.util.Pool;
32+
1833
import java.util.ArrayList;
1934
import java.util.Collections;
2035
import java.util.LinkedList;
@@ -26,31 +41,14 @@
2641

2742
import org.apache.commons.logging.Log;
2843
import org.apache.commons.logging.LogFactory;
44+
2945
import org.springframework.core.convert.converter.Converter;
3046
import org.springframework.dao.DataAccessException;
3147
import org.springframework.dao.InvalidDataAccessApiUsageException;
3248
import org.springframework.data.redis.ExceptionTranslationStrategy;
3349
import org.springframework.data.redis.FallbackExceptionTranslationStrategy;
3450
import org.springframework.data.redis.RedisSystemException;
35-
import org.springframework.data.redis.connection.AbstractRedisConnection;
36-
import org.springframework.data.redis.connection.FutureResult;
37-
import org.springframework.data.redis.connection.MessageListener;
38-
import org.springframework.data.redis.connection.RedisCommands;
39-
import org.springframework.data.redis.connection.RedisGeoCommands;
40-
import org.springframework.data.redis.connection.RedisHashCommands;
41-
import org.springframework.data.redis.connection.RedisHyperLogLogCommands;
42-
import org.springframework.data.redis.connection.RedisKeyCommands;
43-
import org.springframework.data.redis.connection.RedisListCommands;
44-
import org.springframework.data.redis.connection.RedisNode;
45-
import org.springframework.data.redis.connection.RedisPipelineException;
46-
import org.springframework.data.redis.connection.RedisScriptingCommands;
47-
import org.springframework.data.redis.connection.RedisServerCommands;
48-
import org.springframework.data.redis.connection.RedisSetCommands;
49-
import org.springframework.data.redis.connection.RedisStreamCommands;
50-
import org.springframework.data.redis.connection.RedisStringCommands;
51-
import org.springframework.data.redis.connection.RedisSubscribedConnectionException;
52-
import org.springframework.data.redis.connection.RedisZSetCommands;
53-
import org.springframework.data.redis.connection.Subscription;
51+
import org.springframework.data.redis.connection.*;
5452
import org.springframework.data.redis.connection.convert.TransactionResultConverter;
5553
import org.springframework.data.redis.connection.jedis.JedisInvoker.ResponseCommands;
5654
import org.springframework.data.redis.connection.jedis.JedisResult.JedisResultBuilder;
@@ -59,21 +57,6 @@
5957
import org.springframework.util.Assert;
6058
import org.springframework.util.CollectionUtils;
6159

62-
import redis.clients.jedis.BuilderFactory;
63-
import redis.clients.jedis.CommandArguments;
64-
import redis.clients.jedis.CommandObject;
65-
import redis.clients.jedis.DefaultJedisClientConfig;
66-
import redis.clients.jedis.HostAndPort;
67-
import redis.clients.jedis.Jedis;
68-
import redis.clients.jedis.JedisClientConfig;
69-
import redis.clients.jedis.Pipeline;
70-
import redis.clients.jedis.Response;
71-
import redis.clients.jedis.Transaction;
72-
import redis.clients.jedis.commands.ProtocolCommand;
73-
import redis.clients.jedis.commands.ServerCommands;
74-
import redis.clients.jedis.exceptions.JedisDataException;
75-
import redis.clients.jedis.util.Pool;
76-
7760
/**
7861
* {@code RedisConnection} implementation on top of <a href="https://github.com/redis/jedis">Jedis</a> library.
7962
* <p>
@@ -148,7 +131,7 @@ public JedisConnection(Jedis jedis) {
148131
}
149132

150133
/**
151-
* Constructs a new <{@link JedisConnection} backed by a Jedis {@link Pool}.
134+
* Constructs a new {@link JedisConnection} backed by a Jedis {@link Pool}.
152135
*
153136
* @param jedis {@link Jedis} client.
154137
* @param pool {@link Pool} of Redis connections; can be null, if no pool is used.
@@ -159,7 +142,7 @@ public JedisConnection(Jedis jedis, Pool<Jedis> pool, int dbIndex) {
159142
}
160143

161144
/**
162-
* Constructs a new <{@link JedisConnection} backed by a Jedis {@link Pool}.
145+
* Constructs a new {@link JedisConnection} backed by a Jedis {@link Pool}.
163146
*
164147
* @param jedis {@link Jedis} client.
165148
* @param pool {@link Pool} of Redis connections; can be null, if no pool is used.
@@ -172,7 +155,7 @@ protected JedisConnection(Jedis jedis, @Nullable Pool<Jedis> pool, int dbIndex,
172155
}
173156

174157
/**
175-
* Constructs a new <{@link JedisConnection} backed by a Jedis {@link Pool}.
158+
* Constructs a new {@link JedisConnection} backed by a Jedis {@link Pool}.
176159
*
177160
* @param jedis {@link Jedis} client.
178161
* @param pool {@link Pool} of Redis connections; can be null, if no pool is used.

‎src/main/java/org/springframework/data/redis/connection/lettuce/LettuceConnectionFactory.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -565,7 +565,7 @@ public void setShareNativeConnection(boolean shareNativeConnection) {
565565
* connection factory configuration. Eager initialization also prevents blocking connect while using reactive API and
566566
* is recommended for reactive API usage.
567567
*
568-
* @return {@link true} if the shared connection is initialized upon {@link #start()}.
568+
* @return {@literal true} if the shared connection is initialized upon {@link #start()}.
569569
* @since 2.2
570570
* @see #start()
571571
*/
@@ -1239,7 +1239,7 @@ public DataAccessException translateExceptionIfPossible(RuntimeException ex) {
12391239
}
12401240

12411241
/**
1242-
* @return the shared connection using {@literal byte[]} encoding for imperative API use. {@literal null} if
1242+
* @return the shared connection using {@code byte[]} encoding for imperative API use. {@literal null} if
12431243
* {@link #getShareNativeConnection() connection sharing} is disabled or when connected to Redis Cluster.
12441244
*/
12451245
@Nullable
@@ -1251,7 +1251,7 @@ protected StatefulRedisConnection<byte[], byte[]> getSharedConnection() {
12511251
}
12521252

12531253
/**
1254-
* @return the shared cluster connection using {@literal byte[]} encoding for imperative API use. {@literal null} if
1254+
* @return the shared cluster connection using {@code byte[]} encoding for imperative API use. {@literal null} if
12551255
* {@link #getShareNativeConnection() connection sharing} is disabled or when connected to Redis
12561256
* Standalone/Sentinel/Master-Replica.
12571257
* @since 2.5.7

‎src/main/java/org/springframework/data/redis/connection/stream/StreamSerialization.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,12 @@ static <T> T deserialize(@Nullable RedisSerializer<? extends T> serializer, byte
5959
}
6060

6161
/**
62-
* Returns whether the given {@link RedisSerializer} is capable of serializing the {@code value} to {@literal byte[]}.
62+
* Returns whether the given {@link RedisSerializer} is capable of serializing the {@code value} to {@code byte[]}.
6363
*
6464
* @param serializer the serializer. Can be {@literal null}.
6565
* @param value the value to serialize.
6666
* @return {@literal true} if the given {@link RedisSerializer} is capable of serializing the {@code value} to
67-
* {@literal byte[]}.
67+
* {@code byte[]}.
6868
*/
6969
private static boolean canSerialize(@Nullable RedisSerializer<?> serializer, @Nullable Object value) {
7070
return serializer != null && (value == null || serializer.canSerialize(value.getClass()));

‎src/main/java/org/springframework/data/redis/connection/util/DecodeUtils.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@
3030
* Simple class containing various decoding utilities.
3131
*
3232
* @author Costin Leau
33-
* @auhtor Christoph Strobl
34-
* @auhtor Mark Paluch
33+
* @author Christoph Strobl
34+
* @author Mark Paluch
3535
*/
3636
public abstract class DecodeUtils {
3737

‎src/main/java/org/springframework/data/redis/connection/zset/DefaultTuple.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ public class DefaultTuple implements Tuple {
3636
/**
3737
* Constructs a new {@link DefaultTuple}.
3838
*
39-
* @param value {@link byte[]} of the member's raw value.
39+
* @param value {@code byte[]} of the member's raw value.
4040
* @param score {@link Double score} of the raw value used in sorting.
4141
*/
4242
public DefaultTuple(byte[] value, Double score) {

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /