Add difference, intersect, and union support to RedisZSet.

Original Pull Request: #2097

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

@@ -481,6 +481,20 @@ public interface BoundZSetOperations<K, V> extends BoundKeyOperations<K> {
 	@Nullable
 	Set<TypedTuple<V>> differenceWithScores(Collection<K> otherKeys);
 
+	/**
+	 * Diff sorted {@code sets} and store result in destination {@code destKey}.
+	 *
+	 * @param otherKeys must not be {@literal null}.
+	 * @param destKey must not be {@literal null}.
+	 * @return {@literal null} when used in pipeline / transaction.
+	 * @since 2.6
+	 * @see <a href="https://redis.io/commands/zdiffstore">Redis Documentation: ZDIFFSTORE</a>
+	 */
+	@Nullable
+	default Long differenceAndStore(K otherKey, K destKey) {
+		return differenceAndStore(Collections.singleton(otherKey), destKey);
+	}
+
 	/**
 	 * Diff sorted {@code sets} and store result in destination {@code destKey}.
 	 *

src/main/java/org/springframework/data/redis/support/collections/DefaultRedisZSet.java

@@ -105,6 +105,100 @@ public class DefaultRedisZSet<E> extends AbstractRedisCollection<E> implements R
 		this.defaultScore = defaultScore;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.support.collections.RedisZSet#difference(org.springframework.data.redis.support.collections.RedisZSet)
+	 */
+	@Override
+	public Set<E> difference(RedisZSet<?> set) {
+		return boundZSetOps.difference(set.getKey());
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.support.collections.RedisZSet#difference(java.util.Collection)
+	 */
+	@Override
+	public Set<E> difference(Collection<? extends RedisZSet<?>> sets) {
+		return boundZSetOps.difference(CollectionUtils.extractKeys(sets));
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.support.collections.RedisZSet#differenceWithScores(org.springframework.data.redis.support.collections.RedisZSet)
+	 */
+	@Override
+	public Set<TypedTuple<E>> differenceWithScores(RedisZSet<?> set) {
+		return boundZSetOps.differenceWithScores(set.getKey());
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.support.collections.RedisZSet#differenceWithScores(java.util.Collection)
+	 */
+	@Override
+	public Set<TypedTuple<E>> differenceWithScores(Collection<? extends RedisZSet<?>> sets) {
+		return boundZSetOps.differenceWithScores(CollectionUtils.extractKeys(sets));
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.support.collections.RedisZSet#differenceAndStore(org.springframework.data.redis.support.collections.RedisZSet, java.lang.String)
+	 */
+	@Override
+	public RedisZSet<E> differenceAndStore(RedisZSet<?> set, String destKey) {
+
+		boundZSetOps.differenceAndStore(set.getKey(), destKey);
+		return new DefaultRedisZSet<>(boundZSetOps.getOperations().boundZSetOps(destKey), getDefaultScore());
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.support.collections.RedisZSet#differenceAndStore(java.util.Collection, java.lang.String)
+	 */
+	@Override
+	public RedisZSet<E> differenceAndStore(Collection<? extends RedisZSet<?>> sets, String destKey) {
+
+		boundZSetOps.differenceAndStore(CollectionUtils.extractKeys(sets), destKey);
+		return new DefaultRedisZSet<>(boundZSetOps.getOperations().boundZSetOps(destKey), getDefaultScore());
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.support.collections.RedisZSet#intersect(org.springframework.data.redis.support.collections.RedisZSet)
+	 */
+	@Override
+	public Set<E> intersect(RedisZSet<?> set) {
+		return boundZSetOps.intersect(set.getKey());
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.support.collections.RedisZSet#intersect(java.util.Collection)
+	 */
+	@Override
+	public Set<E> intersect(Collection<? extends RedisZSet<?>> sets) {
+		return boundZSetOps.intersect(CollectionUtils.extractKeys(sets));
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.support.collections.RedisZSet#intersectWithScores(org.springframework.data.redis.support.collections.RedisZSet)
+	 */
+	@Override
+	public Set<TypedTuple<E>> intersectWithScores(RedisZSet<?> set) {
+		return boundZSetOps.intersectWithScores(set.getKey());
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.support.collections.RedisZSet#intersectWithScores(java.util.Collection)
+	 */
+	@Override
+	public Set<TypedTuple<E>> intersectWithScores(Collection<? extends RedisZSet<?>> sets) {
+		return boundZSetOps.intersectWithScores(CollectionUtils.extractKeys(sets));
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.support.collections.RedisZSet#intersectAndStore(org.springframework.data.redis.support.collections.RedisZSet, java.lang.String)
@@ -127,6 +221,62 @@ public class DefaultRedisZSet<E> extends AbstractRedisCollection<E> implements R
 		return new DefaultRedisZSet<>(boundZSetOps.getOperations().boundZSetOps(destKey), getDefaultScore());
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.support.collections.RedisZSet#union(org.springframework.data.redis.support.collections.RedisZSet)
+	 */
+	@Override
+	public Set<E> union(RedisZSet<?> set) {
+		return boundZSetOps.union(set.getKey());
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.support.collections.RedisZSet#union(java.util.Collection)
+	 */
+	@Override
+	public Set<E> union(Collection<? extends RedisZSet<?>> sets) {
+		return boundZSetOps.union(CollectionUtils.extractKeys(sets));
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.support.collections.RedisZSet#unionWithScores(org.springframework.data.redis.support.collections.RedisZSet)
+	 */
+	@Override
+	public Set<TypedTuple<E>> unionWithScores(RedisZSet<?> set) {
+		return boundZSetOps.unionWithScores(set.getKey());
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.support.collections.RedisZSet#unionWithScores(java.util.Collection)
+	 */
+	@Override
+	public Set<TypedTuple<E>> unionWithScores(Collection<? extends RedisZSet<?>> sets) {
+		return boundZSetOps.unionWithScores(CollectionUtils.extractKeys(sets));
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.support.collections.RedisZSet#unionAndStore(org.springframework.data.redis.support.collections.RedisZSet, java.lang.String)
+	 */
+	@Override
+	public RedisZSet<E> unionAndStore(RedisZSet<?> set, String destKey) {
+		boundZSetOps.unionAndStore(set.getKey(), destKey);
+		return new DefaultRedisZSet<>(boundZSetOps.getOperations().boundZSetOps(destKey), getDefaultScore());
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.support.collections.RedisZSet#unionAndStore(java.util.Collection, java.lang.String)
+	 */
+	@Override
+	public RedisZSet<E> unionAndStore(Collection<? extends RedisZSet<?>> sets, String destKey) {
+		boundZSetOps.unionAndStore(CollectionUtils.extractKeys(sets), destKey);
+		return new DefaultRedisZSet<>(boundZSetOps.getOperations().boundZSetOps(destKey), getDefaultScore());
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.support.collections.RedisZSet#range(long, long)
@@ -247,26 +397,6 @@ public class DefaultRedisZSet<E> extends AbstractRedisCollection<E> implements R
 		return this;
 	}
 
-	/*
-	 * (non-Javadoc)
-	 * @see org.springframework.data.redis.support.collections.RedisZSet#unionAndStore(org.springframework.data.redis.support.collections.RedisZSet, java.lang.String)
-	 */
-	@Override
-	public RedisZSet<E> unionAndStore(RedisZSet<?> set, String destKey) {
-		boundZSetOps.unionAndStore(set.getKey(), destKey);
-		return new DefaultRedisZSet<>(boundZSetOps.getOperations().boundZSetOps(destKey), getDefaultScore());
-	}
-
-	/*
-	 * (non-Javadoc)
-	 * @see org.springframework.data.redis.support.collections.RedisZSet#unionAndStore(java.util.Collection, java.lang.String)
-	 */
-	@Override
-	public RedisZSet<E> unionAndStore(Collection<? extends RedisZSet<?>> sets, String destKey) {
-		boundZSetOps.unionAndStore(CollectionUtils.extractKeys(sets), destKey);
-		return new DefaultRedisZSet<>(boundZSetOps.getOperations().boundZSetOps(destKey), getDefaultScore());
-	}
-
 	/*
 	 * (non-Javadoc)
 	 * @see java.util.AbstractCollection#add(java.lang.Object)

src/main/java/org/springframework/data/redis/support/collections/RedisZSet.java

@@ -66,6 +66,100 @@ public interface RedisZSet<E> extends RedisCollection<E>, Set<E> {
 		return new DefaultRedisZSet<>(key, operations, defaultScore);
 	}
 
+	/**
+	 * Diff this set and another {@link RedisZSet}.
+	 *
+	 * @param set must not be {@literal null}.
+	 * @return a {@link Set} containing the values that differ.
+	 * @since 2.6
+	 */
+	Set<E> difference(RedisZSet<?> set);
+
+	/**
+	 * Diff this set and other {@link RedisZSet}s.
+	 *
+	 * @param sets must not be {@literal null}.
+	 * @return a {@link Set} containing the values that differ.
+	 * @since 2.6
+	 */
+	Set<E> difference(Collection<? extends RedisZSet<?>> sets);
+
+	/**
+	 * Diff this set and another {@link RedisZSet}.
+	 *
+	 * @param set must not be {@literal null}.
+	 * @return a {@link Set} containing the values that differ with their scores.
+	 * @since 2.6
+	 */
+	Set<TypedTuple<E>> differenceWithScores(RedisZSet<?> set);
+
+	/**
+	 * Diff this set and other {@link RedisZSet}s.
+	 *
+	 * @param set must not be {@literal null}.
+	 * @return a {@link Set} containing the values that differ with their scores.
+	 * @since 2.6
+	 */
+	Set<TypedTuple<E>> differenceWithScores(Collection<? extends RedisZSet<?>> sets);
+
+	/**
+	 * Create a new {@link RedisZSet} by diffing this sorted set and {@link RedisZSet} and store result in destination
+	 * {@code destKey}.
+	 *
+	 * @param set must not be {@literal null}.
+	 * @param destKey must not be {@literal null}.
+	 * @return a new {@link RedisZSet} pointing at {@code destKey}.
+	 * @since 2.6
+	 */
+	RedisZSet<E> differenceAndStore(RedisZSet<?> set, String destKey);
+
+	/**
+	 * Create a new {@link RedisZSet} by diffing this sorted set and the collection {@link RedisZSet} and store result in
+	 * destination {@code destKey}.
+	 *
+	 * @param sets must not be {@literal null}.
+	 * @param destKey must not be {@literal null}.
+	 * @return a new {@link RedisZSet} pointing at {@code destKey}.
+	 * @since 2.6
+	 */
+	RedisZSet<E> differenceAndStore(Collection<? extends RedisZSet<?>> sets, String destKey);
+
+	/**
+	 * Intersect this set and another {@link RedisZSet}.
+	 *
+	 * @param set must not be {@literal null}.
+	 * @return a {@link Set} containing the intersecting values.
+	 * @since 2.6
+	 */
+	Set<E> intersect(RedisZSet<?> set);
+
+	/**
+	 * Intersect this set and other {@link RedisZSet}s.
+	 *
+	 * @param sets must not be {@literal null}.
+	 * @return a {@link Set} containing the intersecting values.
+	 * @since 2.6
+	 */
+	Set<E> intersect(Collection<? extends RedisZSet<?>> sets);
+
+	/**
+	 * Intersect this set and another {@link RedisZSet}.
+	 *
+	 * @param set must not be {@literal null}.
+	 * @return a {@link Set} containing the intersecting values with their scores.
+	 * @since 2.6
+	 */
+	Set<TypedTuple<E>> intersectWithScores(RedisZSet<?> set);
+
+	/**
+	 * Intersect this set and other {@link RedisZSet}s.
+	 *
+	 * @param set must not be {@literal null}.
+	 * @return a {@link Set} containing the intersecting values with their scores.
+	 * @since 2.6
+	 */
+	Set<TypedTuple<E>> intersectWithScores(Collection<? extends RedisZSet<?>> sets);
+
 	/**
 	 * Create a new {@link RedisZSet} by intersecting this sorted set and {@link RedisZSet} and store result in
 	 * destination {@code destKey}.
@@ -86,6 +180,42 @@ public interface RedisZSet<E> extends RedisCollection<E>, Set<E> {
 	 */
 	RedisZSet<E> intersectAndStore(Collection<? extends RedisZSet<?>> sets, String destKey);
 
+	/**
+	 * Union this set and another {@link RedisZSet}.
+	 *
+	 * @param set must not be {@literal null}.
+	 * @return a {@link Set} containing the combined values.
+	 * @since 2.6
+	 */
+	Set<E> union(RedisZSet<?> set);
+
+	/**
+	 * Union this set and other {@link RedisZSet}s.
+	 *
+	 * @param sets must not be {@literal null}.
+	 * @return a {@link Set} containing the combined values.
+	 * @since 2.6
+	 */
+	Set<E> union(Collection<? extends RedisZSet<?>> sets);
+
+	/**
+	 * Union this set and another {@link RedisZSet}.
+	 *
+	 * @param set must not be {@literal null}.
+	 * @return a {@link Set} containing the combined values with their scores.
+	 * @since 2.6
+	 */
+	Set<TypedTuple<E>> unionWithScores(RedisZSet<?> set);
+
+	/**
+	 * Union this set and other {@link RedisZSet}s.
+	 *
+	 * @param set must not be {@literal null}.
+	 * @return a {@link Set} containing the combined values with their scores.
+	 * @since 2.6
+	 */
+	Set<TypedTuple<E>> unionWithScores(Collection<? extends RedisZSet<?>> sets);
+
 	/**
 	 * Create a new {@link RedisZSet} by union this sorted set and {@link RedisZSet} and store result in destination
 	 * {@code destKey}.