org.aredis.cache

Class RedisCommandInfo

java.lang.Object

org.aredis.cache.RedisCommandInfo

public class RedisCommandInfo
extends Object

This is a class to Hold a Redis Command with its arguments and also the result once the command is completed. RedisCommandInfo Objects should be created for every command submission and not re-used.

Author:

Suresh

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RedisCommandInfo.CommandStatus Enumerates the CommandStatus which is expected to be SUCCESS on normal execution.
static class	RedisCommandInfo.ResultType Enumerates the Result Types of Redis

Constructor Summary

Constructors

Constructor and Description
RedisCommandInfo(DataHandler pdataHandler, Object pmetaData, RedisCommand pcommand, Object... pparams) Creates a Redis CommandInfo Object
RedisCommandInfo(DataHandler pdataHandler, RedisCommand pcommand, Object... pparams) Creates a Redis CommandInfo Object
RedisCommandInfo(Object pmetaData, RedisCommand pcommand, Object... pparams) Creates a Redis CommandInfo Object which uses the Default Data Handler of the AsyncRedisConnection.
RedisCommandInfo(RedisCommand pcommand, Object... pparams) Creates a Redis CommandInfo Object which uses the Default Data Handler of the AsyncRedisConnection.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDebug(String message) Utility to add a Debug message to the Command.
byte	getByteResult(byte def) Converts the result to a byte
byte	getByteResult(Object res, byte def) Converts any result Object to a byte
RedisCommand	getCommand() Gets the command
RedisCommand	getCommandRun() Returns the actual command that was attempted to run.
DataHandler	getDataHandler() Gets the data handler
StringBuffer	getDebugBuf() Gets the debug buf in use
double	getDoubleResult(double def) Converts the result to a double value
double	getDoubleResult(Object res, double def) Converts any result Object to a double value
Throwable	getError() Gets the exception that was encountered
float	getFloatResult(float def) Converts the result to a float
float	getFloatResult(Object res, float def) Converts any result Object to a float
int	getIntResult(int def) Converts the result to an int
static int	getIntResult(Object res, int def) Converts any result Object to an int
long	getLongResult(long def) Converts the result to a long
long	getLongResult(Object res, long def) Converts any result Object to a long
ResultTypeInfo[]	getMbResultTypes() In case the ResultType returned by getResultType is MULTIBULK this method returns the ResultTypes in the response.
Object[]	getParams() Gets the command parameters
Object	getResult() Gets the result.
RedisCommandInfo.ResultType	getResultType() Gets the Type of the Result.
RedisCommandInfo.CommandStatus	getRunStatus() Gets the Run Status to indicate whether the command ran successfully or if there was an error.
short	getShortResult(Object res, short def) Converts any result Object to a short value
short	getShortResult(short def) Converts the result to a short value
void	setDebugBuf(StringBuffer pdebugBuf) Sets a StringBuffer for debuging purposes.

Methods inherited from class java.lang.Object

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

Constructor Detail

RedisCommandInfo

public RedisCommandInfo(DataHandler pdataHandler,
                Object pmetaData,
                RedisCommand pcommand,
                Object... pparams)

Creates a Redis CommandInfo Object

Parameters:

pdataHandler - Data Handler to use

pmetaData - Meta Data for the Data handler if required

pcommand - The Redis Command to run

pparams - Parameters for the Redis Command

RedisCommandInfo

public RedisCommandInfo(DataHandler pdataHandler,
                RedisCommand pcommand,
                Object... pparams)

Creates a Redis CommandInfo Object

Parameters:

pdataHandler - Data Handler to use

pcommand - The Redis Command to run

pparams - Parameters for the Redis Command

RedisCommandInfo

public RedisCommandInfo(Object pmetaData,
                RedisCommand pcommand,
                Object... pparams)

Creates a Redis CommandInfo Object which uses the Default Data Handler of the AsyncRedisConnection.

Parameters:

pmetaData - Meta Data for the Data handler if required

pcommand - The Redis Command to run

pparams - Parameters for the Redis Command

RedisCommandInfo

public RedisCommandInfo(RedisCommand pcommand,
                Object... pparams)

Creates a Redis CommandInfo Object which uses the Default Data Handler of the AsyncRedisConnection.

Parameters:

pcommand - The Redis Command to run

pparams - Parameters for the Redis Command

Method Detail

addDebug

public void addDebug(String message)

Utility to add a Debug message to the Command. setDebugBuf should have been called to set a StringBuffer for this.

Parameters:

message - Message to append. A new line is added after the message.

getResultType

public RedisCommandInfo.ResultType getResultType()

Gets the Type of the Result. This will be null if the run status returned by getRunStatus is not SUCCESS.

Returns:

The Result Type

getResult

public Object getResult()

Gets the result. For resultTypes other than BULK and MULTIBULK the value returned is a String. For resultType BULK the appropriate Data Handler is used to de-serialize the response. In case of the resultType MULTIBULK the return value is an Array of Objects which could have arrays in case of a nested MULTIBULK result as in the response of a SCAN command. The DataHandler is used to de-serialize individual bulk responses in a MULTIBULK response. In case of MULTIBULK response of an EXEC command the Result is an Array of RedisCommandInfo and each of the elements of the Array has the response for the corresponding command in the Redis Transaction.

Returns:

Result Appropriate result which could be null in case of null MULTIBULK response or if getRunStatus returns SKIPPED or NETWORK_ERROR

getMbResultTypes

public ResultTypeInfo[] getMbResultTypes()

In case the ResultType returned by getResultType is MULTIBULK this method returns the ResultTypes in the response. The response is an Array of ResultTypeInfo rather than ResultType because some of the ResultTypes may again be MULTIBULK as in the response of a SCAN command in which case the corresponding ResultTypeInfo.getMbResultTypes gets the ResultTypes of those sub-MULTIBULK responses. This info is usually not needed by the user of aredis since he already knows the MULTIBULK response for the command he/she has sent. However aredis also uses this info when de-serializing. Note that the return value is NULL for an EXEC command.

Returns:

An array identifying the individual ResultTypes if the ResultType is MULTIBULK, null otherwise

getIntResult

public static int getIntResult(Object res,
               int def)

Converts any result Object to an int

Parameters:

res - Result Object

def - Default value to return in case the result is null or not an Integer

Returns:

Result as int

getIntResult

public int getIntResult(int def)

Converts the result to an int

Parameters:

def - Default value to return in case the result is null or not an Integer

Returns:

Result as int

getLongResult

public long getLongResult(Object res,
                 long def)

Converts any result Object to a long

Parameters:

res - Result Object

def - Default value to return in case the result is null or not a Long

Returns:

Result as long

getLongResult

public long getLongResult(long def)

Converts the result to a long

Parameters:

def - Default value to return in case the result is null or not a Long

Returns:

Result as long

getShortResult

public short getShortResult(Object res,
                   short def)

Converts any result Object to a short value

Parameters:

res - Result Object

def - Default value to return in case the result is null or not a Short int

Returns:

Result as a short value

getShortResult

public short getShortResult(short def)

Converts the result to a short value

Parameters:

def - Default value to return in case the result is null or not a Short int

Returns:

Result as a short value

getByteResult

public byte getByteResult(Object res,
                 byte def)

Converts any result Object to a byte

Parameters:

res - Result Object

def - Default value to return in case the result is null or not a Byte

Returns:

Result as a byte

getByteResult

public byte getByteResult(byte def)

Converts the result to a byte

Parameters:

def - Default value to return in case the result is null or not a Byte

Returns:

Result as a byte

getDoubleResult

public double getDoubleResult(Object res,
                     double def)

Converts any result Object to a double value

Parameters:

res - Result Object

def - Default value to return in case the result is null or not a Double

Returns:

Result as a double value

getDoubleResult

public double getDoubleResult(double def)

Converts the result to a double value

Parameters:

def - Default value to return in case the result is null or not a Double

Returns:

Result as a double value

getFloatResult

public float getFloatResult(Object res,
                   float def)

Converts any result Object to a float

Parameters:

res - Result Object

def - Default value to return in case the result is null or not a Float

Returns:

Result as a float

getFloatResult

public float getFloatResult(float def)

Converts the result to a float

Parameters:

def - Default value to return in case the result is null or not a Float

Returns:

Result as a float

getCommand

public RedisCommand getCommand()

Gets the command

Returns:

the command

getCommandRun

public RedisCommand getCommandRun()

Returns the actual command that was attempted to run. This is filled only when the command is submitted and is the same as command except when command is the pseudo-command RedisCommand.EVALCHECK in which case it is either EVAL or EVALSHA.

Returns:

The actual command run which could be different than getCommand for EVALCHECK

getParams

public Object[] getParams()

Gets the command parameters

Returns:

command parameters

getDataHandler

public DataHandler getDataHandler()

Gets the data handler

Returns:

data handler that is in use

getRunStatus

public RedisCommandInfo.CommandStatus getRunStatus()

Gets the Run Status to indicate whether the command ran successfully or if there was an error. Note that Redis Command errors are indicated by a RunStatus of SUCCESS. Only the ResultType indicates a REDIS_ERROR.

Returns:

Command Status

getError

public Throwable getError()

Gets the exception that was encountered

Returns:

The exception that was encountered when running the command or null if there was no exception

getDebugBuf

public StringBuffer getDebugBuf()

Gets the debug buf in use

Returns:

debug buf

setDebugBuf

public void setDebugBuf(StringBuffer pdebugBuf)

Sets a StringBuffer for debuging purposes. After that addDebug can be used to add debug info.

Parameters:

pdebugBuf - Debug Buffer to use