org.jredis.ri.alphazero.protocol

Class VirtualResponse

java.lang.Object

org.jredis.ri.alphazero.protocol.VirtualResponse

All Implemented Interfaces:

Message, Response

public final class VirtualResponse
extends Object
implements Response

Certain requested commands do not have a corresponding response from redis. Quit and Shutdown are two examples as of now. This response provides a virtual response for this type of request. You can set the virtual response's status in the constructor. The default constructor provides for OK status.

Since:

alpha.0

Version:

alpha.0, 04/02/09

Author:

Joubin Houshyar (alphazero@sensesay.net)

Nested Class Summary

Nested classes/interfaces inherited from interface org.jredis.protocol.Response

Response.Type

Constructor Summary

Constructors

Constructor and Description
VirtualResponse()
VirtualResponse(ResponseStatus status)

Method Summary

Modifier and Type	Method and Description
boolean	didRead()
ResponseStatus	getStatus()
Response.Type	getType()
boolean	isError()
void	read(InputStream in) Reads itself from the provided InputStream
void	write(OutputStream out) Writes itself to the provided OutputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

VirtualResponse

public VirtualResponse()

VirtualResponse

public VirtualResponse(ResponseStatus status)

Method Detail

didRead

public boolean didRead()

Specified by:

didRead in interface Response

Returns:

if response has been read.

See Also:

Message.read(java.io.InputStream)

getStatus

public ResponseStatus getStatus()

Specified by:

getStatus in interface Response

Returns:

getType

public Response.Type getType()

Specified by:

getType in interface Response

Returns:

Response.Type of this response.

isError

public boolean isError()

Specified by:

isError in interface Response

Returns:

true if response was an error response.

read

public void read(InputStream in)
          throws ClientRuntimeException,
                 ProviderException

Description copied from interface: Message

Reads itself from the provided InputStream

Specified by:

read in interface Message

Parameters:

in - the steam to read from.

Throws:

ClientRuntimeException - to indicate a system error, potentially network related and hopefully recoverable. Typically used to wrap and propagate the IO stream's thrown IOExceptions.

ProviderException - to indicate operational error not directly related to the stream, and should be treated as a bug.

write

public void write(OutputStream out)
           throws ClientRuntimeException,
                  ProviderException

Description copied from interface: Message

Writes itself to the provided OutputStream.

Specified by:

write in interface Message

Parameters:

out - the stream to write to.

Throws:

ClientRuntimeException - to indicate a system error, potentially network related and hopefully recoverable. Typically used to wrap and propagate the IO stream's thrown IOExceptions.

ProviderException - to indicate operational error not directly related to the stream, and should be treated as a bug.