Package io.lettuce.core
Interface CompositeArgument
-
- All Known Subinterfaces:
GeoSearch.GeoPredicate
,GeoSearch.GeoRef<K>
- All Known Implementing Classes:
AclSetuserArgs
,BitFieldArgs
,ClientListArgs
,CopyArgs
,ExpireArgs
,GeoAddArgs
,GeoArgs
,GeoRadiusStoreArgs
,GetExArgs
,KeyScanArgs
,KillArgs
,LMoveArgs
,LMPopArgs
,LPosArgs
,MigrateArgs
,RestoreArgs
,ScanArgs
,SetArgs
,ShutdownArgs
,SortArgs
,StrAlgoArgs
,TrackingArgs
,XAddArgs
,XAutoClaimArgs
,XClaimArgs
,XGroupCreateArgs
,XPendingArgs
,XReadArgs
,XTrimArgs
,ZAddArgs
,ZAggregateArgs
,ZPopArgs
,ZStoreArgs
public interface CompositeArgument
Interface for composite command argument objects. Implementing classes ofCompositeArgument
consolidate multiple arguments for a particular Redis command in to one type and reduce the amount of individual arguments passed in a method signature.Command builder call
build(CommandArgs)
during command construction to contribute command arguments for command invocation. A composite argument is usually stateless as it can be reused multiple times by different commands.- Since:
- 5.0
- Author:
- Mark Paluch
- See Also:
CommandArgs
,SetArgs
,ZAggregateArgs
,GeoArgs
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description <K,V>
voidbuild(CommandArgs<K,V> args)
Build command arguments and contribute arguments toCommandArgs
.
-
-
-
Method Detail
-
build
<K,V> void build(CommandArgs<K,V> args)
Build command arguments and contribute arguments toCommandArgs
.Implementing classes are required to implement this method. Depending on the command nature and configured arguments, this method may contribute arguments but is not required to add arguments if none are specified.
- Type Parameters:
K
- Key type.V
- Value type.- Parameters:
args
- the command arguments, must not benull
.
-
-