com.allanbank.mongodb.client.callback

Class AbstractReplyCallback<F>

java.lang.Object

com.allanbank.mongodb.client.callback.AbstractValidatingReplyCallback

com.allanbank.mongodb.client.callback.AbstractReplyCallback<F>

Type Parameters:

F - The type for the converted Reply.

All Implemented Interfaces:

Callback<Reply>, ReplyCallback

Direct Known Subclasses:

CursorCallback, MultipleCursorCallback, ReplyArrayCallback, ReplyCommandCallback, ReplyDocumentCallback, ReplyIntegerCallback, ReplyLongCallback, ReplyResultCallback, SingleDocumentCallback, SingleDocumentReplyCallback, ValidatingReplyCallback

public abstract class AbstractReplyCallback<F>
extends AbstractValidatingReplyCallback

Helper class for constructing callbacks that convert a Reply message into a different type of result.

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

2011-2014, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields inherited from class com.allanbank.mongodb.client.callback.AbstractValidatingReplyCallback

ERROR_CODE_FIELD, ERROR_MESSAGE_FIELDS

Constructor Summary

Constructors

Constructor and Description
AbstractReplyCallback(Callback<F> forwardCallback) Create a new AbstractReplyCallback.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract F	convert(Reply reply) Converts the Reply into the final response type.
void	exception(Throwable thrown) Called when the operation fails due to an exception.
Callback<F>	getForwardCallback() Returns the forwardCallback value.
protected void	handle(Reply reply) Called once the Reply has been validated.
boolean	isLightWeight() Returns true if the callback is lightweight and can be safely performed in the receive thread.

Methods inherited from class com.allanbank.mongodb.client.callback.AbstractValidatingReplyCallback

asError, asError, asError, asError, asString, callback, checkForError, toInt, verify

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractReplyCallback

public AbstractReplyCallback(Callback<F> forwardCallback)

Create a new AbstractReplyCallback.

Parameters:

forwardCallback - The callback for the converted type.

Method Detail

exception

public void exception(Throwable thrown)

Called when the operation fails due to an exception.

Overridden to forward the exception to the myForwardCallback.

Specified by:

exception in interface Callback<Reply>

Specified by:

exception in class AbstractValidatingReplyCallback

Parameters:

thrown - The thrown exception.

See Also:

Callback.exception(java.lang.Throwable)

getForwardCallback

public Callback<F> getForwardCallback()

Returns the forwardCallback value.

Returns:

the forwardCallback

isLightWeight

public boolean isLightWeight()

Returns true if the callback is lightweight and can be safely performed in the receive thread.

Overridden to return true if the forwardCallback is a FutureCallback or to forward the call if the forwardCallback is a ReplyCallback.

Returns:

True if the callback is lightweight and can be safely performed in the receive thread.

convert

protected abstract F convert(Reply reply)
                      throws MongoDbException

Converts the Reply into the final response type.

Parameters:

reply - The reply to convert.

Returns:

The converted reply.

Throws:

MongoDbException - On a failure converting the reply. Generally, the AbstractValidatingReplyCallback.verify(Reply) method should be used to report errors.

handle

protected void handle(Reply reply)

Called once the Reply has been validated.

Overriden to convert and then pass the converted reply to the forward callback.

Specified by:

handle in class AbstractValidatingReplyCallback

Parameters:

reply - The Reply to be handled.