Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 2016-2018 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.redis.connection;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import java.nio.ByteBuffer;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import org.reactivestreams.Publisher;
import org.springframework.data.redis.connection.ReactiveRedisConnection.BooleanResponse;
import org.springframework.data.redis.connection.ReactiveRedisConnection.ByteBufferResponse;
import org.springframework.data.redis.connection.ReactiveRedisConnection.Command;
import org.springframework.data.redis.connection.ReactiveRedisConnection.CommandResponse;
import org.springframework.data.redis.connection.ReactiveRedisConnection.KeyCommand;
import org.springframework.data.redis.connection.ReactiveRedisConnection.KeyScanCommand;
import org.springframework.data.redis.connection.ReactiveRedisConnection.NumericResponse;
import org.springframework.data.redis.core.ScanOptions;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
/**
* Redis Set commands executed using reactive infrastructure.
*
* @author Christoph Strobl
* @author Mark Paluch
* @since 2.0
*/
public interface ReactiveSetCommands {
/**
* {@code SADD} command parameters.
*
* @author Christoph Strobl
* @see Redis Documentation: SADD
*/
class SAddCommand extends KeyCommand {
private List values;
private SAddCommand(@Nullable ByteBuffer key, List values) {
super(key);
this.values = values;
}
/**
* Creates a new {@link SAddCommand} given a {@literal value}.
*
* @param value must not be {@literal null}.
* @return a new {@link SAddCommand} for a {@literal value}.
*/
public static SAddCommand value(ByteBuffer value) {
Assert.notNull(value, "Value must not be null!");
return values(Collections.singletonList(value));
}
/**
* Creates a new {@link SAddCommand} given a {@link Collection} of values.
*
* @param values must not be {@literal null}.
* @return a new {@link SAddCommand} for a {@link Collection} of values.
*/
public static SAddCommand values(Collection values) {
Assert.notNull(values, "Values must not be null!");
return new SAddCommand(null, new ArrayList<>(values));
}
/**
* Applies the {@literal key}. Constructs a new command instance with all previously configured properties.
*
* @param key must not be {@literal null}.
* @return a new {@link SAddCommand} with {@literal key} applied.
*/
public SAddCommand to(ByteBuffer key) {
Assert.notNull(key, "Key must not be null!");
return new SAddCommand(key, values);
}
/**
* @return
*/
public List getValues() {
return values;
}
}
/**
* Add given {@literal value} to set at {@literal key}.
*
* @param key must not be {@literal null}.
* @param value must not be {@literal null}.
* @return
* @see Redis Documentation: SADD
*/
default Mono sAdd(ByteBuffer key, ByteBuffer value) {
Assert.notNull(value, "Value must not be null!");
return sAdd(key, Collections.singletonList(value));
}
/**
* Add given {@literal values} to set at {@literal key}.
*
* @param key must not be {@literal null}.
* @param values must not be {@literal null}.
* @return
* @see Redis Documentation: SADD
*/
default Mono sAdd(ByteBuffer key, Collection values) {
Assert.notNull(key, "Key must not be null!");
Assert.notNull(values, "Values must not be null!");
return sAdd(Mono.just(SAddCommand.values(values).to(key))).next().map(NumericResponse::getOutput);
}
/**
* Add given {@link SAddCommand#getValues()} to set at {@link SAddCommand#getKey()}.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: SADD
*/
Flux> sAdd(Publisher commands);
/**
* {@code SREM} command parameters.
*
* @author Christoph Strobl
* @see Redis Documentation: SREM
*/
class SRemCommand extends KeyCommand {
private final List values;
private SRemCommand(@Nullable ByteBuffer key, List values) {
super(key);
this.values = values;
}
/**
* Creates a new {@link SRemCommand} given a {@literal value}.
*
* @param value must not be {@literal null}.
* @return a new {@link SRemCommand} for a {@literal value}.
*/
public static SRemCommand value(ByteBuffer value) {
Assert.notNull(value, "Value must not be null!");
return values(Collections.singletonList(value));
}
/**
* Creates a new {@link SRemCommand} given a {@link Collection} of values.
*
* @param values must not be {@literal null}.
* @return a new {@link SRemCommand} for a {@link Collection} of values.
*/
public static SRemCommand values(Collection values) {
Assert.notNull(values, "Values must not be null!");
return new SRemCommand(null, new ArrayList<>(values));
}
/**
* Applies the {@literal key}. Constructs a new command instance with all previously configured properties.
*
* @param key must not be {@literal null}.
* @return a new {@link SRemCommand} with {@literal key} applied.
*/
public SRemCommand from(ByteBuffer key) {
Assert.notNull(key, "Key must not be null!");
return new SRemCommand(key, values);
}
/**
* @return never {@literal null}.
*/
public List getValues() {
return values;
}
}
/**
* Remove given {@literal value} from set at {@literal key} and return the number of removed elements.
*
* @param key must not be {@literal null}.
* @param value must not be {@literal null}.
* @return
* @see Redis Documentation: SREM
*/
default Mono sRem(ByteBuffer key, ByteBuffer value) {
Assert.notNull(value, "Value must not be null!");
return sRem(key, Collections.singletonList(value));
}
/**
* Remove given {@literal values} from set at {@literal key} and return the number of removed elements.
*
* @param key must not be {@literal null}.
* @param values must not be {@literal null}.
* @return
* @see Redis Documentation: SREM
*/
default Mono sRem(ByteBuffer key, Collection values) {
Assert.notNull(key, "Key must not be null!");
Assert.notNull(values, "Values must not be null!");
return sRem(Mono.just(SRemCommand.values(values).from(key))).next().map(NumericResponse::getOutput);
}
/**
* Remove given {@link SRemCommand#getValues()} from set at {@link SRemCommand#getKey()}.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: SREM
*/
Flux> sRem(Publisher commands);
/**
* {@code SPOP} command parameters.
*
* @author Christoph Strobl
* @see Redis Documentation: SPOP
*/
class SPopCommand extends KeyCommand {
private final long count;
private SPopCommand(@Nullable ByteBuffer key, long count) {
super(key);
this.count = count;
}
/**
* Creates a new {@link SPopCommand} for a single member.
*
* @return a new {@link SPopCommand} for a single member.
*/
public static SPopCommand one() {
return new SPopCommand(null, 1L);
}
/**
* Creates a new {@link SPopCommand} for {@code count} members.
*
* @return a new {@link SPopCommand} for {@code count} members.
*/
public static SPopCommand members(long count) {
return new SPopCommand(null, count);
}
/**
* Applies the {@literal key}. Constructs a new command instance with all previously configured properties.
*
* @param key must not be {@literal null}.
* @return a new {@link SRemCommand} with {@literal key} applied.
*/
public SPopCommand from(ByteBuffer key) {
Assert.notNull(key, "Key must not be null!");
return new SPopCommand(key, count);
}
public long getCount() {
return count;
}
}
/**
* Remove and return a random member from set at {@literal key}.
*
* @param key must not be {@literal null}.
* @return
* @see Redis Documentation: SPOP
*/
default Mono sPop(ByteBuffer key) {
Assert.notNull(key, "Key must not be null!");
return sPop(Mono.just(SPopCommand.one().from(key))).next().map(ByteBufferResponse::getOutput);
}
/**
* Remove and return {@code count} random members from set at {@code key}.
*
* @param key must not be {@literal null}.
* @param count number of random members to pop from the set.
* @return
* @see Redis Documentation: SPOP
*/
default Flux sPop(ByteBuffer key, long count) {
Assert.notNull(key, "Key must not be null!");
return sPop(SPopCommand.members(count).from(key));
}
/**
* Remove and return a random member from set at {@literal key}.
*
* @param command must not be {@literal null}.
* @return
* @see Redis Documentation: SPOP
*/
Flux sPop(SPopCommand command);
/**
* Remove and return a random member from set at {@link KeyCommand#getKey()}
*
* @param commands
* @return
* @see Redis Documentation: SPOP
*/
Flux> sPop(Publisher commands);
/**
* {@code SMOVE} command parameters.
*
* @author Christoph Strobl
* @see Redis Documentation: SMOVE
*/
class SMoveCommand extends KeyCommand {
private final @Nullable ByteBuffer destination;
private final ByteBuffer value;
private SMoveCommand(@Nullable ByteBuffer key, @Nullable ByteBuffer destination, ByteBuffer value) {
super(key);
this.destination = destination;
this.value = value;
}
/**
* Creates a new {@link SMoveCommand} given a {@literal value}.
*
* @param value must not be {@literal null}.
* @return a new {@link SMoveCommand} for a {@literal value}.
*/
public static SMoveCommand value(ByteBuffer value) {
Assert.notNull(value, "Value must not be null!");
return new SMoveCommand(null, null, value);
}
/**
* Applies the {@literal source} key. Constructs a new command instance with all previously configured properties.
*
* @param source must not be {@literal null}.
* @return a new {@link SMoveCommand} with {@literal source} applied.
*/
public SMoveCommand from(ByteBuffer source) {
Assert.notNull(source, "Source key must not be null!");
return new SMoveCommand(source, destination, value);
}
/**
* Applies the {@literal destination} key. Constructs a new command instance with all previously configured
* properties.
*
* @param destination must not be {@literal null}.
* @return a new {@link SMoveCommand} with {@literal destination} applied.
*/
public SMoveCommand to(ByteBuffer destination) {
Assert.notNull(destination, "Destination key must not be null!");
return new SMoveCommand(getKey(), destination, value);
}
/**
* @return can be {@literal null}.
*/
@Nullable
public ByteBuffer getDestination() {
return destination;
}
/**
* @return never {@literal null}.
*/
public ByteBuffer getValue() {
return value;
}
}
/**
* Move {@literal value} from {@literal sourceKey} to {@literal destinationKey}
*
* @param sourceKey must not be {@literal null}.
* @param destinationKey must not be {@literal null}.
* @param value must not be {@literal null}.
* @return
* @see Redis Documentation: SMOVE
*/
default Mono sMove(ByteBuffer sourceKey, ByteBuffer destinationKey, ByteBuffer value) {
Assert.notNull(sourceKey, "SourceKey must not be null!");
Assert.notNull(destinationKey, "DestinationKey must not be null!");
Assert.notNull(value, "Value must not be null!");
return sMove(Mono.just(SMoveCommand.value(value).from(sourceKey).to(destinationKey))).next()
.map(BooleanResponse::getOutput);
}
/**
* Move {@link SMoveCommand#getValue()} from {@link SMoveCommand#getKey()} to {@link SMoveCommand#getDestination()}.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: SMOVE
*/
Flux> sMove(Publisher commands);
/**
* Get size of set at {@literal key}.
*
* @param key must not be {@literal null}.
* @return
* @see Redis Documentation: SCARD
*/
default Mono sCard(ByteBuffer key) {
Assert.notNull(key, "Key must not be null!");
return sCard(Mono.just(new KeyCommand(key))).next().map(NumericResponse::getOutput);
}
/**
* Get size of set at {@link KeyCommand#getKey()}.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: SCARD
*/
Flux> sCard(Publisher commands);
/**
* {@code SISMEMBER} command parameters.
*
* @author Christoph Strobl
* @see Redis Documentation: SISMEMBER
*/
class SIsMemberCommand extends KeyCommand {
private final ByteBuffer value;
private SIsMemberCommand(@Nullable ByteBuffer key, ByteBuffer value) {
super(key);
this.value = value;
}
/**
* Creates a new {@link SIsMemberCommand} given a {@literal value}.
*
* @param value must not be {@literal null}.
* @return a new {@link SIsMemberCommand} for a {@literal value}.
*/
public static SIsMemberCommand value(ByteBuffer value) {
Assert.notNull(value, "Value must not be null!");
return new SIsMemberCommand(null, value);
}
/**
* Applies the {@literal set} key. Constructs a new command instance with all previously configured properties.
*
* @param set must not be {@literal null}.
* @return a new {@link SIsMemberCommand} with {@literal set} applied.
*/
public SIsMemberCommand of(ByteBuffer set) {
Assert.notNull(set, "Set key must not be null!");
return new SIsMemberCommand(set, value);
}
/**
* @return
*/
public ByteBuffer getValue() {
return value;
}
}
/**
* Check if set at {@literal key} contains {@literal value}.
*
* @param key must not be {@literal null}.
* @param value must not be {@literal null}.
* @return
* @see Redis Documentation: SISMEMBER
*/
default Mono sIsMember(ByteBuffer key, ByteBuffer value) {
Assert.notNull(key, "Key must not be null!");
Assert.notNull(value, "Value must not be null!");
return sIsMember(Mono.just(SIsMemberCommand.value(value).of(key))).next().map(BooleanResponse::getOutput);
}
/**
* Check if set at {@link SIsMemberCommand#getKey()} contains {@link SIsMemberCommand#getKey()}.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: SISMEMBER
*/
Flux> sIsMember(Publisher commands);
/**
* {@code SINTER} command parameters.
*
* @author Christoph Strobl
* @see Redis Documentation: SINTER
*/
class SInterCommand implements Command {
private final List keys;
private SInterCommand(List keys) {
this.keys = keys;
}
/**
* Creates a new {@link SInterCommand} given a {@link Collection} of keys.
*
* @param keys must not be {@literal null}.
* @return a new {@link SInterCommand} for a {@link Collection} of values.
*/
public static SInterCommand keys(Collection keys) {
Assert.notNull(keys, "Keys must not be null!");
return new SInterCommand(new ArrayList<>(keys));
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.ReactiveRedisConnection.Command#getKey()
*/
@Override
@Nullable
public ByteBuffer getKey() {
return null;
}
/**
* @return
*/
public List getKeys() {
return keys;
}
}
/**
* Returns the members intersecting all given sets at {@literal keys}.
*
* @param keys must not be {@literal null}.
* @return
* @see Redis Documentation: SINTER
*/
default Flux sInter(Collection keys) {
Assert.notNull(keys, "Keys must not be null!");
return sInter(Mono.just(SInterCommand.keys(keys))).flatMap(CommandResponse::getOutput);
}
/**
* Returns the members intersecting all given sets at {@link SInterCommand#getKeys()}.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: SINTER
*/
Flux>> sInter(Publisher commands);
/**
* {@code SINTERSTORE} command parameters.
*
* @author Christoph Strobl
* @see Redis Documentation: SINTERSTORE
*/
class SInterStoreCommand extends KeyCommand {
private final List keys;
private SInterStoreCommand(@Nullable ByteBuffer key, List keys) {
super(key);
this.keys = keys;
}
/**
* Creates a new {@link SInterStoreCommand} given a {@link Collection} of keys.
*
* @param keys must not be {@literal null}.
* @return a new {@link SInterStoreCommand} for a {@link Collection} of values.
*/
public static SInterStoreCommand keys(Collection keys) {
Assert.notNull(keys, "Keys must not be null!");
return new SInterStoreCommand(null, new ArrayList<>(keys));
}
/**
* Applies the {@literal key} at which the result is stored. Constructs a new command instance with all previously
* configured properties.
*
* @param key must not be {@literal null}.
* @return a new {@link SInterStoreCommand} with {@literal key} applied.
*/
public SInterStoreCommand storeAt(ByteBuffer key) {
Assert.notNull(key, "Key must not be null!");
return new SInterStoreCommand(key, keys);
}
/**
* @return
*/
public List getKeys() {
return keys;
}
}
/**
* Intersect all given sets at {@literal keys} and store result in {@literal destinationKey}.
*
* @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
*/
default Mono sInterStore(ByteBuffer destinationKey, Collection keys) {
Assert.notNull(destinationKey, "DestinationKey must not be null!");
Assert.notNull(keys, "Keys must not be null!");
return sInterStore(Mono.just(SInterStoreCommand.keys(keys).storeAt(destinationKey))).next()
.map(NumericResponse::getOutput);
}
/**
* Intersect all given sets at {@literal keys} and store result in {@literal destinationKey}.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: SINTERSTORE
*/
Flux> sInterStore(Publisher commands);
/**
* {@code SUNION} command parameters.
*
* @author Christoph Strobl
* @see Redis Documentation: SUNION
*/
class SUnionCommand implements Command {
private final List keys;
private SUnionCommand(List keys) {
this.keys = keys;
}
/**
* Creates a new {@link SUnionCommand} given a {@link Collection} of keys.
*
* @param keys must not be {@literal null}.
* @return a new {@link SUnionCommand} for a {@link Collection} of values.
*/
public static SUnionCommand keys(Collection keys) {
Assert.notNull(keys, "Keys must not be null!");
return new SUnionCommand(new ArrayList<>(keys));
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.ReactiveRedisConnection.Command#getKey()
*/
@Override
@Nullable
public ByteBuffer getKey() {
return null;
}
/**
* @return
*/
public List getKeys() {
return keys;
}
}
/**
* Returns the members intersecting all given sets at {@literal keys}.
*
* @param keys must not be {@literal null}.
* @return
* @see Redis Documentation: SUNION
*/
default Flux sUnion(Collection keys) {
Assert.notNull(keys, "Keys must not be null!");
return sUnion(Mono.just(SUnionCommand.keys(keys))).flatMap(CommandResponse::getOutput);
}
/**
* Returns the members intersecting all given sets at {@link SInterCommand#getKeys()}.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: SUNION
*/
Flux>> sUnion(Publisher commands);
/**
* {@code SUNIONSTORE} command parameters.
*
* @author Christoph Strobl
* @see Redis Documentation: SUNIONSTORE
*/
class SUnionStoreCommand extends KeyCommand {
private final List keys;
private SUnionStoreCommand(@Nullable ByteBuffer key, List keys) {
super(key);
this.keys = keys;
}
/**
* Creates a new {@link SUnionStoreCommand} given a {@link Collection} of keys.
*
* @param keys must not be {@literal null}.
* @return a new {@link SUnionStoreCommand} for a {@link Collection} of values.
*/
public static SUnionStoreCommand keys(Collection keys) {
Assert.notNull(keys, "Keys must not be null!");
return new SUnionStoreCommand(null, new ArrayList<>(keys));
}
/**
* Applies the {@literal key} at which the result is stored. Constructs a new command instance with all previously
* configured properties.
*
* @param key must not be {@literal null}.
* @return a new {@link SUnionStoreCommand} with {@literal key} applied.
*/
public SUnionStoreCommand storeAt(ByteBuffer key) {
Assert.notNull(key, "Key must not be null!");
return new SUnionStoreCommand(key, keys);
}
/**
* @return
*/
public List getKeys() {
return keys;
}
}
/**
* Union all given sets at {@literal keys} and store result in {@literal destinationKey}.
*
* @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
*/
default Mono sUnionStore(ByteBuffer destinationKey, Collection keys) {
Assert.notNull(destinationKey, "DestinationKey must not be null!");
Assert.notNull(keys, "Keys must not be null!");
return sUnionStore(Mono.just(SUnionStoreCommand.keys(keys).storeAt(destinationKey))).next()
.map(NumericResponse::getOutput);
}
/**
* Union all given sets at {@literal keys} and store result in {@literal destinationKey}.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: SUNIONSTORE
*/
Flux> sUnionStore(Publisher commands);
/**
* {@code SDIFF} command parameters.
*
* @author Christoph Strobl
* @see Redis Documentation: SDIFF
*/
class SDiffCommand implements Command {
private final List keys;
private SDiffCommand(List keys) {
this.keys = keys;
}
/**
* Creates a new {@link SDiffCommand} given a {@link Collection} of keys.
*
* @param keys must not be {@literal null}.
* @return a new {@link SDiffCommand} for a {@link Collection} of values.
*/
public static SDiffCommand keys(Collection keys) {
Assert.notNull(keys, "Keys must not be null!");
return new SDiffCommand(new ArrayList<>(keys));
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.ReactiveRedisConnection.Command#getKey()
*/
@Override
@Nullable
public ByteBuffer getKey() {
return null;
}
/**
* @return
*/
public List getKeys() {
return keys;
}
}
/**
* Returns the diff of the members of all given sets at {@literal keys}.
*
* @param keys must not be {@literal null}.
* @return
* @see Redis Documentation: SDIFF
*/
default Flux sDiff(Collection keys) {
Assert.notNull(keys, "Keys must not be null!");
return sDiff(Mono.just(SDiffCommand.keys(keys))).flatMap(CommandResponse::getOutput);
}
/**
* Returns the diff of the members of all given sets at {@link SInterCommand#getKeys()}.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: SDIFF
*/
Flux>> sDiff(Publisher commands);
/**
* {@code SDIFFSTORE} command parameters.
*
* @author Christoph Strobl
* @see Redis Documentation: SDIFFSTORE
*/
class SDiffStoreCommand extends KeyCommand {
private final List keys;
private SDiffStoreCommand(@Nullable ByteBuffer key, List keys) {
super(key);
this.keys = keys;
}
/**
* Creates a new {@link SDiffStoreCommand} given a {@link Collection} of keys.
*
* @param keys must not be {@literal null}.
* @return a new {@link SDiffStoreCommand} for a {@link Collection} of values.
*/
public static SDiffStoreCommand keys(Collection keys) {
Assert.notNull(keys, "Keys must not be null!");
return new SDiffStoreCommand(null, new ArrayList<>(keys));
}
/**
* Applies the {@literal key} at which the result is stored. Constructs a new command instance with all previously
* configured properties.
*
* @param key must not be {@literal null}.
* @return a new {@link SDiffStoreCommand} with {@literal key} applied.
*/
public SDiffStoreCommand storeAt(ByteBuffer key) {
Assert.notNull(key, "Key must not be null!");
return new SDiffStoreCommand(key, keys);
}
/**
* @return
*/
public List getKeys() {
return keys;
}
}
/**
* Diff all given sets at {@literal keys} and store result in {@literal destinationKey}.
*
* @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
*/
default Mono sDiffStore(ByteBuffer destinationKey, Collection keys) {
Assert.notNull(destinationKey, "DestinationKey must not be null!");
Assert.notNull(keys, "Keys must not be null!");
return sDiffStore(Mono.just(SDiffStoreCommand.keys(keys).storeAt(destinationKey))).next()
.map(NumericResponse::getOutput);
}
/**
* Diff all given sets at {@literal keys} and store result in {@literal destinationKey}.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: SDIFFSTORE
*/
Flux> sDiffStore(Publisher commands);
/**
* Get all elements of set at {@literal key}.
*
* @param key must not be {@literal null}.
* @return
* @see Redis Documentation: SMEMBERS
*/
default Flux sMembers(ByteBuffer key) {
Assert.notNull(key, "Key must not be null!");
return sMembers(Mono.just(new KeyCommand(key))).flatMap(CommandResponse::getOutput);
}
/**
* Get all elements of set at {@link KeyCommand#getKey()}.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: SMEMBERS
*/
Flux>> sMembers(Publisher commands);
/**
* Use a {@link Flux} to iterate over members in the set at {@code key}. The resulting {@link Flux} acts as a cursor
* and issues {@code SSCAN} commands itself as long as the subscriber signals demand.
*
* @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
* @since 2.1
*/
default Flux sScan(ByteBuffer key) {
return sScan(key, ScanOptions.NONE);
}
/**
* Use a {@link Flux} to iterate over members in the set at {@code key} given {@link ScanOptions}. The resulting
* {@link Flux} acts as a cursor and issues {@code SSCAN} commands itself as long as the subscriber signals demand.
*
* @param key must not be {@literal null}.
* @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
* @since 2.1
*/
default Flux sScan(ByteBuffer key, ScanOptions options) {
return sScan(Mono.just(KeyScanCommand.key(key).withOptions(options))).map(CommandResponse::getOutput)
.flatMap(it -> it);
}
/**
* Use a {@link Flux} to iterate over members in the set at {@code key}. The resulting {@link Flux} acts as a cursor
* and issues {@code SSCAN} commands itself as long as the subscriber signals demand.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: SSCAN
* @since 2.1
*/
Flux>> sScan(Publisher commands);
/**
* {@code SRANDMEMBER} command parameters.
*
* @author Christoph Strobl
* @see Redis Documentation: SRANDMEMBER
*/
class SRandMembersCommand extends KeyCommand {
private final @Nullable Long count;
private SRandMembersCommand(@Nullable ByteBuffer key, @Nullable Long count) {
super(key);
this.count = count;
}
/**
* Creates a new {@link SRandMembersCommand} given the number of values to retrieve.
*
* @param nrValuesToRetrieve
* @return a new {@link SRandMembersCommand} for a number of values to retrieve.
*/
public static SRandMembersCommand valueCount(long nrValuesToRetrieve) {
return new SRandMembersCommand(null, nrValuesToRetrieve);
}
/**
* Creates a new {@link SRandMembersCommand} to retrieve one random member.
*
* @return a new {@link SRandMembersCommand} to retrieve one random member.
*/
public static SRandMembersCommand singleValue() {
return new SRandMembersCommand(null, null);
}
/**
* Applies the {@literal key}. Constructs a new command instance with all previously configured properties.
*
* @param key must not be {@literal null}.
* @return a new {@link SRandMembersCommand} with {@literal key} applied.
*/
public SRandMembersCommand from(ByteBuffer key) {
Assert.notNull(key, "Key must not be null!");
return new SRandMembersCommand(key, count);
}
/**
* @return
*/
public Optional getCount() {
return Optional.ofNullable(count);
}
}
/**
* Get random element from set at {@literal key}.
*
* @param key must not be {@literal null}.
* @return
* @see Redis Documentation: SRANDMEMBER
*/
default Mono sRandMember(ByteBuffer key) {
return sRandMember(key, 1L).singleOrEmpty();
}
/**
* Get {@literal count} random elements from set at {@literal key}.
*
* @param key must not be {@literal null}.
* @param count must not be {@literal null}.
* @return
* @see Redis Documentation: SRANDMEMBER
*/
default Flux sRandMember(ByteBuffer key, Long count) {
Assert.notNull(key, "Key must not be null!");
Assert.notNull(count, "Count must not be null!");
return sRandMember(Mono.just(SRandMembersCommand.valueCount(count).from(key))).flatMap(CommandResponse::getOutput);
}
/**
* Get {@link SRandMembersCommand#getCount()} random elements from set at {@link SRandMembersCommand#getKey()}.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: SRANDMEMBER
*/
Flux>> sRandMember(Publisher commands);
}
