DATAREDIS-1106 - Polishing.

Add nullable annotations to methods that can return null. Update since tags. Extract phantom TTL to constant. Original pull request: spring-projects#521.

Author: mp911de

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

@@ -104,6 +104,11 @@
 public class RedisKeyValueAdapter extends AbstractKeyValueAdapter
 implements InitializingBean, ApplicationContextAware, ApplicationListener<RedisKeyspaceEvent> {
 
+/**
+ * Time To Live in seconds that phantom keys should live longer than the actual key.
+ */
+private static final int PHANTOM_KEY_TTL = 300;
+
 private RedisOperations<?, ?> redisOps;
 private RedisConverter converter;
 private @Nullable RedisMessageListenerContainer messageListenerContainer;
@@ -201,7 +206,7 @@ protected RedisKeyValueAdapter() {}
  * @see org.springframework.data.keyvalue.core.KeyValueAdapter#put(java.lang.Object, java.lang.Object, java.lang.String)
  */
 @Override
-public Object put(final Object id, Object item, String keyspace) {
+public Object put(Object id, Object item, String keyspace) {
 
 RedisData rdo = item instanceof RedisData ? (RedisData) item : new RedisData();
 if (!(item instanceof RedisData)) {
@@ -237,7 +242,7 @@ public Object put(final Object id, Object item, String keyspace) {
 byte[] phantomKey = ByteUtils.concat(objectKey, BinaryKeyspaceIdentifier.PHANTOM_SUFFIX);
 connection.del(phantomKey);
 connection.hMSet(phantomKey, rdo.getBucket().rawMap());
-connection.expire(phantomKey, rdo.getTimeToLive() + 300);
+connection.expire(phantomKey, rdo.getTimeToLive() + PHANTOM_KEY_TTL);
 }
 
 connection.sAdd(toBytes(rdo.getKeyspace()), key);
@@ -473,7 +478,7 @@ public void update(PartialUpdate<?> update) {
 // add phantom key so values can be restored
 byte[] phantomKey = ByteUtils.concat(redisKey, BinaryKeyspaceIdentifier.PHANTOM_SUFFIX);
 connection.hMSet(phantomKey, rdo.getBucket().rawMap());
-connection.expire(phantomKey, rdo.getTimeToLive() + 300);
+connection.expire(phantomKey, rdo.getTimeToLive() + PHANTOM_KEY_TTL);
 
 } else {
 

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

@@ -35,7 +35,7 @@ public interface TimeToLiveAccessor {
 /**
  * @param type must not be {@literal null}.
  * @return return {@literal true} if the entity could potentially expire.
- * @since ? (depends on backport)
+ * @since 2.3
  */
 boolean isExpiringEntity(Class<?> type);
 }

src/main/java/org/springframework/data/redis/core/mapping/RedisMappingContext.java

@@ -208,7 +208,7 @@ static class ConfigAwareTimeToLiveAccessor implements TimeToLiveAccessor {
 
 @Override
 @SuppressWarnings({ "rawtypes" })
-public Long getTimeToLive(final Object source) {
+public Long getTimeToLive(Object source) {
 
 Assert.notNull(source, "Source must not be null!");
 Class<?> type = source instanceof Class<?> ? (Class<?>) source
@@ -220,8 +220,7 @@ public Long getTimeToLive(final Object source) {
 PersistentProperty<?> ttlProperty = resolveTtlProperty(type);
 
 if (ttlProperty != null && ttlProperty.isAnnotationPresent(TimeToLive.class)) {
-
-unit = ttlProperty.findAnnotation(TimeToLive.class).unit();
+unit = ttlProperty.getRequiredAnnotation(TimeToLive.class).unit();
 }
 
 if (source instanceof PartialUpdate) {
@@ -251,6 +250,7 @@ public Long getTimeToLive(final Object source) {
 } else {
 
 Method timeoutMethod = resolveTimeMethod(type);
+
 if (timeoutMethod != null) {
 
 if (!timeoutMethod.isAccessible()) {
@@ -260,7 +260,7 @@ public Long getTimeToLive(final Object source) {
 TimeToLive ttl = AnnotationUtils.findAnnotation(timeoutMethod, TimeToLive.class);
 try {
 Number timeout = (Number) timeoutMethod.invoke(source);
-if (timeout != null) {
+if (timeout != null && ttl != null) {
 return TimeUnit.SECONDS.convert(timeout.longValue(), ttl.unit());
 }
 } catch (IllegalAccessException e) {
@@ -291,12 +291,15 @@ public boolean isExpiringEntity(Class<?> type) {
 if (defaultTimeOut != null && defaultTimeOut > 0) {
 return true;
 }
+
 if (resolveTtlProperty(type) != null) {
 return true;
 }
+
 return resolveTimeMethod(type) != null;
 }
 
+@Nullable
 private Long resolveDefaultTimeOut(Class<?> type) {
 
 if (this.defaultTimeouts.containsKey(type)) {
@@ -318,7 +321,8 @@ private Long resolveDefaultTimeOut(Class<?> type) {
 return defaultTimeout;
 }
 
-@SuppressWarnings({ "rawtypes", "unchecked" })
+@SuppressWarnings({ "rawtypes" })
+@Nullable
 private PersistentProperty<?> resolveTtlProperty(Class<?> type) {
 
 if (timeoutProperties.containsKey(type)) {
@@ -351,7 +355,8 @@ private PersistentProperty<?> resolveTtlProperty(Class<?> type) {
 return null;
 }
 
-private Method resolveTimeMethod(final Class<?> type) {
+@Nullable
+private Method resolveTimeMethod(Class<?> type) {
 
 if (timeoutMethods.containsKey(type)) {
 return timeoutMethods.get(type);

src/main/java/org/springframework/data/redis/core/mapping/RedisPersistentEntity.java

@@ -46,15 +46,15 @@ public interface RedisPersistentEntity<T> extends KeyValuePersistentEntity<T, Re
 /**
  * Get the {@link PersistentProperty} that is annotated with {@link org.springframework.data.redis.core.TimeToLive}.
  *
- * @return can be {@null}.
+ * @return can be {@literal null}.
  * @since 1.8
  */
 @Nullable
 RedisPersistentProperty getExplicitTimeToLiveProperty();
 
 /**
  * @return {@literal true} if the entity could potentially expire.
- * @since ? (depends on backport)
+ * @since 2.3
  */
 default boolean isExpiring() {
 return getTimeToLiveAccessor().isExpiringEntity(getType());