redis.clients.jedis

Class CommandArguments

java.lang.Object

redis.clients.jedis.CommandArguments

All Implemented Interfaces:

java.lang.Iterable<Rawable>

public class CommandArguments
extends java.lang.Object
implements java.lang.Iterable<Rawable>

Constructor Summary

Constructors

Constructor and Description
CommandArguments(ProtocolCommand command)

Method Summary

Modifier and Type	Method and Description
CommandArguments	add(boolean arg)
CommandArguments	add(byte[] arg)
CommandArguments	add(double arg)
CommandArguments	add(int arg)
CommandArguments	add(long arg)
CommandArguments	add(java.lang.Object arg)
CommandArguments	add(Rawable arg)
CommandArguments	add(java.lang.String arg)
protected CommandArguments	addHashSlotKeys(byte[]... keys)
protected CommandArguments	addHashSlotKeys(java.lang.String... keys)
CommandArguments	addObjects(java.util.Collection args)
CommandArguments	addObjects(java.lang.Object... args)
CommandArguments	addParams(IParams params)
CommandArguments	blocking()
Rawable	get(int index) Get the argument at the specified index.
ProtocolCommand	getCommand()
java.util.Set<java.lang.Integer>	getKeyHashSlots()
java.util.List<java.lang.Object>	getKeys() Returns the keys used in this command.
boolean	isBlocking()
boolean	isKeyless()
java.util.Iterator<Rawable>	iterator()
CommandArguments	key(java.lang.Object key)
CommandArguments	keys(java.util.Collection keys)
CommandArguments	keys(java.lang.Object... keys)
int	size()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CommandArguments

public CommandArguments(ProtocolCommand command)

Method Detail

getCommand

public ProtocolCommand getCommand()

add

public CommandArguments add(Rawable arg)

add

public CommandArguments add(byte[] arg)

add

public CommandArguments add(boolean arg)

add

public CommandArguments add(int arg)

add

public CommandArguments add(long arg)

add

public CommandArguments add(double arg)

add

public CommandArguments add(java.lang.String arg)

add

public CommandArguments add(java.lang.Object arg)

addObjects

public CommandArguments addObjects(java.lang.Object... args)

addObjects

public CommandArguments addObjects(java.util.Collection args)

key

public CommandArguments key(java.lang.Object key)

keys

public final CommandArguments keys(java.lang.Object... keys)

keys

public final CommandArguments keys(java.util.Collection keys)

addParams

public final CommandArguments addParams(IParams params)

addHashSlotKeys

protected final CommandArguments addHashSlotKeys(byte[]... keys)

addHashSlotKeys

protected final CommandArguments addHashSlotKeys(java.lang.String... keys)

size

public int size()

get

public Rawable get(int index)

Get the argument at the specified index.

Parameters:

index - the index of the argument to retrieve (0-based, where 0 is the command itself)

Returns:

the Rawable argument at the specified index

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range

iterator

public java.util.Iterator<Rawable> iterator()

Specified by:

iterator in interface java.lang.Iterable<Rawable>

getKeys

@Internal
public java.util.List<java.lang.Object> getKeys()

Returns the keys used in this command.

Internal API: This method is internal and should not be used by external code. It is exposed for internal use by caching (CacheKey.getRedisKeys()) and cluster operations.

Supported types: Keys are stored as either String or byte[] depending on how they were added via key(Object) or addHashSlotKey(String)/addHashSlotKey(byte[]). Only String and byte[] are guaranteed to be supported by downstream consumers.

Type safety: Consumers must handle both String and byte[] types. Passing other types may cause IllegalArgumentException when used with caching (see AbstractCache.makeKeyForRedisKeysToCacheKeys(Object)) or cluster operations.

The returned list is unmodifiable to prevent external modification of the internal key tracking.

Returns:

unmodifiable list of keys (String or byte[])

getKeyHashSlots

@Internal
public java.util.Set<java.lang.Integer> getKeyHashSlots()

isKeyless

public boolean isKeyless()

Returns:

true if this command has no keys, false otherwise

isBlocking

public boolean isBlocking()

blocking

public CommandArguments blocking()