org.jredis.ri.alphazero.protocol

Class ResponseSupport

java.lang.Object

org.jredis.ri.alphazero.protocol.ResponseSupport

All Implemented Interfaces:

Message, Response

Direct Known Subclasses:

SyncProtocol.SyncResponseBase

public abstract class ResponseSupport
extends java.lang.Object
implements Response

Base for all responses. Responsible for reading and determining status.

Since:

alpha.0

Version:

alpha.0, 04/02/09

Nested Class Summary

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

Response.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected Command	cmd
protected boolean	didRead
protected boolean	isError
protected ResponseStatus	status
protected Response.Type	type

Constructor Summary

Constructors

Constructor and Description
ResponseSupport(Command cmd, Response.Type type)

Method Summary

Modifier and Type	Method and Description
protected void	assertResponseRead() a bit aggressive but to force out the little bugs ..
boolean	didRead()
protected boolean	didRead(boolean value) called by child classes to indicate if & when their read operation has completed
ResponseStatus	getStatus()
Response.Type	getType()
boolean	isError()
void	write(java.io.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

Methods inherited from interface org.jredis.connector.Message

read

Field Detail

type

protected Response.Type type

status

protected ResponseStatus status

cmd

protected Command cmd

didRead

protected boolean didRead

isError

protected boolean isError

Constructor Detail

ResponseSupport

public ResponseSupport(Command cmd,
                       Response.Type type)

Method Detail

didRead

protected final boolean didRead(boolean value)

called by child classes to indicate if & when their read operation has completed

assertResponseRead

protected final void assertResponseRead()

a bit aggressive but to force out the little bugs ..

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.

write

public void write(java.io.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.