DATAREDIS-526 - Allow using ttl and pttl with TimeUnit on connection-level.

We now support ttl and pttl accepting a TimeUnit on connection level to return the TTL in the requested time unit. By performing the conversion inside the connection we return correct results for plain, pipelining and transaction execution. Add also JavaDoc and @OverRide to ttl/pttl methods.

Original pull request: #205.

Author: mp911de

src/main/java/org/springframework/data/redis/connection/DefaultStringRedisConnection.java

@@ -26,6 +26,7 @@
 import java.util.Properties;
 import java.util.Queue;
 import java.util.Set;
+import java.util.concurrent.TimeUnit;
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
@@ -938,14 +939,35 @@ public Long sUnionStore(byte[] destKey, byte[]... keys) {
 		return result;
 	}
 
+	/* 
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisKeyCommands#ttl(byte[])
+	 */
+	@Override
 	public Long ttl(byte[] key) {
+
 		Long result = delegate.ttl(key);
 		if (isFutureConversion()) {
 			addResultConverter(identityConverter);
 		}
 		return result;
 	}
 
+	/* 
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisKeyCommands#ttl(byte[], java.util.concurrent.TimeUnit)
+	 */
+	@Override
+	public Long ttl(byte[] key, TimeUnit timeUnit) {
+
+		Long result = delegate.ttl(key, timeUnit);
+		if (isFutureConversion()) {
+			addResultConverter(identityConverter);
+		}
+
+		return result;
+	}
+
 	public DataType type(byte[] key) {
 		DataType result = delegate.type(key);
 		if (isFutureConversion()) {
@@ -1329,11 +1351,33 @@ public Boolean pExpireAt(byte[] key, long unixTimeInMillis) {
 		return result;
 	}
 
+	/* 
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisKeyCommands#pTtl(byte[])
+	 */
+	@Override
 	public Long pTtl(byte[] key) {
+
 		Long result = delegate.pTtl(key);
 		if (isFutureConversion()) {
 			addResultConverter(identityConverter);
 		}
+
+		return result;
+	}
+
+	/* 
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisKeyCommands#pTtl(byte[], java.util.concurrent.TimeUnit)
+	 */
+	@Override
+	public Long pTtl(byte[] key, TimeUnit timeUnit) {
+
+		Long result = delegate.pTtl(key, timeUnit);
+		if (isFutureConversion()) {
+			addResultConverter(identityConverter);
+		}
+
 		return result;
 	}
 
@@ -2059,12 +2103,22 @@ public Long sUnionStore(String destKey, String... keys) {
 		return result;
 	}
 
+	/* 
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.StringRedisConnection#ttl(java.lang.String)
+	 */
+	@Override
 	public Long ttl(String key) {
-		Long result = delegate.ttl(serialize(key));
-		if (isFutureConversion()) {
-			addResultConverter(identityConverter);
-		}
-		return result;
+		return ttl(serialize(key));
+	}
+
+	/* 
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.StringRedisConnection#ttl(java.lang.String, java.util.concurrent.TimeUnit)
+	 */
+	@Override
+	public Long ttl(String key, TimeUnit timeUnit) {
+		return ttl(serialize(key), timeUnit);
 	}
 
 	public DataType type(String key) {
@@ -2689,10 +2743,24 @@ public Boolean pExpireAt(String key, long unixTimeInMillis) {
 		return pExpireAt(serialize(key), unixTimeInMillis);
 	}
 
+	/* 
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.StringRedisConnection#pTtl(java.lang.String)
+	 */
+	@Override
 	public Long pTtl(String key) {
 		return pTtl(serialize(key));
 	}
 
+	/* 
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.StringRedisConnection#pTtl(java.lang.String, java.util.concurrent.TimeUnit)
+	 */
+	@Override
+	public Long pTtl(String key, TimeUnit timeUnit) {
+		return pTtl(serialize(key), timeUnit);
+	}
+
 	public String scriptLoad(String script) {
 		String result = delegate.scriptLoad(serialize(script));
 		if (isFutureConversion()) {

src/main/java/org/springframework/data/redis/connection/RedisKeyCommands.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2014 the original author or authors.
+ * Copyright 2011-2016 the original author or authors.
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,6 +17,7 @@
 
 import java.util.List;
 import java.util.Set;
+import java.util.concurrent.TimeUnit;
 
 import org.springframework.data.redis.core.Cursor;
 import org.springframework.data.redis.core.ScanOptions;
@@ -26,6 +27,7 @@
  * 
  * @author Costin Leau
  * @author Christoph Strobl
+ * @author Mark Paluch
  */
 public interface RedisKeyCommands {
 
@@ -186,7 +188,19 @@ public interface RedisKeyCommands {
 	Long ttl(byte[] key);
 
 	/**
-	 * Get the time to live for {@code key} in milliseconds.
+	 * Get the time to live for {@code key} in and convert it to the given {@link TimeUnit}.
+	 * <p>
+	 * See http://redis.io/commands/ttl
+	 *
+	 * @param key
+	 * @param timeUnit
+	 * @return
+	 * @since 1.8
+	 */
+	Long ttl(byte[] key, TimeUnit timeUnit);
+
+	/**
+	 * Get the precise time to live for {@code key} in milliseconds.
 	 * <p>
 	 * See http://redis.io/commands/pttl
 	 * 
@@ -195,6 +209,18 @@ public interface RedisKeyCommands {
 	 */
 	Long pTtl(byte[] key);
 
+	/**
+	 * Get the precise time to live for {@code key} in and convert it to the given {@link TimeUnit}.
+	 * <p>
+	 * See http://redis.io/commands/pttl
+	 *
+	 * @param key
+	 * @param timeUnit
+	 * @return
+	 * @since 1.8
+	 */
+	Long pTtl(byte[] key, TimeUnit timeUnit);
+
 	/**
 	 * Sort the elements for {@code key}.
 	 * <p>

src/main/java/org/springframework/data/redis/connection/StringRedisConnection.java

@@ -19,6 +19,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
+import java.util.concurrent.TimeUnit;
 
 import org.springframework.data.geo.Circle;
 import org.springframework.data.geo.Distance;
@@ -60,34 +61,176 @@ public interface StringTuple extends Tuple {
 
 	Object execute(String command);
 
+	/**
+	 * Determine if given {@code key} exists.
+	 * <p>
+	 * See http://redis.io/commands/exists
+	 *
+	 * @param key
+	 * @return
+	 */
 	Boolean exists(String key);
 
+	/**
+	 * Delete given {@code keys}.
+	 * <p>
+	 * See http://redis.io/commands/del
+	 *
+	 * @param keys
+	 * @return The number of keys that were removed.
+	 */
 	Long del(String... keys);
 
+	/**
+	 * Determine the type stored at {@code key}.
+	 * <p>
+	 * See http://redis.io/commands/type
+	 *
+	 * @param key
+	 * @return
+	 */
 	DataType type(String key);
 
+	/**
+	 * Find all keys matching the given {@code pattern}.
+	 * <p>
+	 * See http://redis.io/commands/keys
+	 *
+	 * @param pattern
+	 * @return
+	 */
 	Collection<String> keys(String pattern);
 
+	/**
+	 * Rename key {@code oleName} to {@code newName}.
+	 * <p>
+	 * See http://redis.io/commands/rename
+	 *
+	 * @param oldName
+	 * @param newName
+	 */
 	void rename(String oldName, String newName);
 
+	/**
+	 * Rename key {@code oleName} to {@code newName} only if {@code newName} does not exist.
+	 * <p>
+	 * See http://redis.io/commands/renamenx
+	 *
+	 * @param oldName
+	 * @param newName
+	 * @return
+	 */
 	Boolean renameNX(String oldName, String newName);
 
+	/**
+	 * Set time to live for given {@code key} in seconds.
+	 * <p>
+	 * See http://redis.io/commands/expire
+	 *
+	 * @param key
+	 * @param seconds
+	 * @return
+	 */
 	Boolean expire(String key, long seconds);
 
+	/**
+	 * Set time to live for given {@code key} in milliseconds.
+	 * <p>
+	 * See http://redis.io/commands/pexpire
+	 *
+	 * @param key
+	 * @param millis
+	 * @return
+	 */
 	Boolean pExpire(String key, long millis);
 
+	/**
+	 * Set the expiration for given {@code key} as a {@literal UNIX} timestamp.
+	 * <p>
+	 * See http://redis.io/commands/expireat
+	 *
+	 * @param key
+	 * @param unixTime
+	 * @return
+	 */
 	Boolean expireAt(String key, long unixTime);
 
+	/**
+	 * Set the expiration for given {@code key} as a {@literal UNIX} timestamp in milliseconds.
+	 * <p>
+	 * See http://redis.io/commands/pexpireat
+	 *
+	 * @param key
+	 * @param unixTimeInMillis
+	 * @return
+	 */
 	Boolean pExpireAt(String key, long unixTimeInMillis);
 
+	/**
+	 * Remove the expiration from given {@code key}.
+	 * <p>
+	 * See http://redis.io/commands/persist
+	 *
+	 * @param key
+	 * @return
+	 */
 	Boolean persist(String key);
 
+	/**
+	 * Move given {@code key} to database with {@code index}.
+	 * <p>
+	 * See http://redis.io/commands/move
+	 *
+	 * @param key
+	 * @param dbIndex
+	 * @return
+	 */
 	Boolean move(String key, int dbIndex);
 
+	/**
+	 * Get the time to live for {@code key} in seconds.
+	 * <p>
+	 * See http://redis.io/commands/ttl
+	 *
+	 * @param key
+	 * @return
+	 */
 	Long ttl(String key);
 
+	/**
+	 * Get the time to live for {@code key} in and convert it to the given {@link TimeUnit}.
+	 * <p>
+	 * See http://redis.io/commands/ttl
+	 *
+	 * @param key
+	 * @param timeUnit
+	 * @return
+	 * @since 1.8
+	 */
+	Long ttl(String key, TimeUnit timeUnit);
+
+	/**
+	 * Get the precise time to live for {@code key} in milliseconds.
+	 * <p>
+	 * See http://redis.io/commands/pttl
+	 *
+	 * @param key
+	 * @return
+	 */
 	Long pTtl(String key);
 
+	/**
+	 * Get the precise time to live for {@code key} in and convert it to the given {@link TimeUnit}.
+	 * <p>
+	 * See http://redis.io/commands/pttl
+	 *
+	 * @param key
+	 * @param timeUnit
+	 * @return
+	 * @since 1.8
+	 */
+	Long pTtl(String key, TimeUnit timeUnit);
+
 	String echo(String message);
 
 	// sort commands