com.allanbank.mongodb.client.callback

Class ReplyDocumentCallback

java.lang.Object

com.allanbank.mongodb.client.callback.AbstractValidatingReplyCallback

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

com.allanbank.mongodb.client.callback.ReplyDocumentCallback

All Implemented Interfaces:

Callback<Reply>, ReplyCallback

public class ReplyDocumentCallback
extends AbstractReplyCallback<Document>

Callback to expect and extract a single document from the reply and then extract its contained document.

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-2013, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_NAME The default name for the reply's document to return.

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

ERROR_CODE_FIELD, ERROR_MESSAGE_FIELDS

Constructor Summary

Constructors

Constructor and Description
ReplyDocumentCallback(Callback<Document> results) Create a new ReplyDocumentCallback.
ReplyDocumentCallback(String name, Callback<Document> results) Create a new ReplyDocumentCallback.

Method Summary

Methods

Modifier and Type	Method and Description
protected MongoDbException	asError(Reply reply) Creates an exception from the Reply.
protected Document	convert(Reply reply) Converts the Reply into the final response type.

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

exception, getForwardCallback, handle, isLightWeight

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

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

Field Detail

DEFAULT_NAME

public static final String DEFAULT_NAME

The default name for the reply's document to return.

See Also:

Constant Field Values

Constructor Detail

ReplyDocumentCallback

public ReplyDocumentCallback(Callback<Document> results)

Create a new ReplyDocumentCallback.

Parameters:

results - The callback to notify of the reply document.

ReplyDocumentCallback

public ReplyDocumentCallback(String name,
                     Callback<Document> results)

Create a new ReplyDocumentCallback.

Parameters:

name - The name of the document in the reply document to extract.

results - The callback to notify of the reply document.

Method Detail

asError

protected MongoDbException asError(Reply reply)

Creates an exception from the Reply.

Creates an exception if the Reply has less than or more than a single reply document.

Overrides:

asError in class AbstractValidatingReplyCallback

Parameters:

reply - The raw reply.

Returns:

The exception created.

convert

protected Document convert(Reply reply)
                    throws MongoDbException

Converts the Reply into the final response type.

Overridden to return the reply document.

Specified by:

convert in class AbstractReplyCallback<Document>

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.

See Also:

AbstractReplyCallback.convert(Reply)