com.allanbank.mongodb.client.callback

Class ValidatingReplyCallback

java.lang.Object

com.allanbank.mongodb.client.callback.AbstractValidatingReplyCallback

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

com.allanbank.mongodb.client.callback.ValidatingReplyCallback

All Implemented Interfaces:

Callback<Reply>, ReplyCallback

public class ValidatingReplyCallback
extends AbstractReplyCallback<Reply>

ValidatingCallback to expect and extract a single document from the reply. The document is checked for errors but then ignored.

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 ©:

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
ValidatingReplyCallback(FutureReplyCallback delegate) Create a new ValidatingReplyCallback.

Method Summary

Methods

Modifier and Type	Method and Description
protected Reply	convert(Reply reply) Converts the Reply into the final response type.
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.AbstractReplyCallback

exception, getForwardCallback, handle

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

ValidatingReplyCallback

public ValidatingReplyCallback(FutureReplyCallback delegate)

Create a new ValidatingReplyCallback.

Parameters:

delegate - The delegate that we can wait on for the reply.

Method Detail

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.

Overridden to return true as there is no additional processing.

Specified by:

isLightWeight in interface ReplyCallback

Overrides:

isLightWeight in class AbstractReplyCallback<Reply>

Returns:

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

convert

protected Reply convert(Reply reply)
                 throws MongoDbException

Converts the Reply into the final response type.

Overridden to return the original reply.

Specified by:

convert in class AbstractReplyCallback<Reply>

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.