com.allanbank.mongodb.client.callback

Class ReplyLongCallback

java.lang.Object

com.allanbank.mongodb.client.callback.AbstractValidatingReplyCallback

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

com.allanbank.mongodb.client.callback.ReplyLongCallback

All Implemented Interfaces:

Callback<Reply>, ReplyCallback

Direct Known Subclasses:

BatchedNativeWriteCallback, BatchedWriteCallback

public class ReplyLongCallback
extends AbstractReplyCallback<Long>

Callback to expect and extract a single document from the reply and then extract a contained NumericElement and coerce it to a long value.

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 long value to return.

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

ERROR_CODE_FIELD, ERROR_MESSAGE_FIELDS

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected MongoDbException	asError(Reply reply) Creates an exception from the Reply.
protected Long	convert(Reply reply) Converts the Reply into the final response type.
protected long	toLong(Element element) Converts a NumericElement into a long value.

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 long value to return.

See Also:

Constant Field Values

Constructor Detail

ReplyLongCallback

public ReplyLongCallback(Callback<Long> results)

Create a new ReplyLongCallback.

Parameters:

results - The callback to notify of the value.

ReplyLongCallback

public ReplyLongCallback(String name,
                 Callback<Long> results)

Create a new ReplyLongCallback.

Parameters:

name - The name of the numeric value.

results - The callback to notify of the value.

Method Detail

asError

protected MongoDbException asError(Reply reply)

Creates an exception from the Reply.

Creates an exception from the Reply if the 'n' field is missing.

Overrides:

asError in class AbstractValidatingReplyCallback

Parameters:

reply - The raw reply.

Returns:

The exception created.

convert

protected Long convert(Reply reply)
                throws MongoDbException

Converts the Reply into the final response type.

Overridden to return the 'n' field in the reply document.

Specified by:

convert in class AbstractReplyCallback<Long>

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)

toLong

protected long toLong(Element element)

Converts a NumericElement into a long value. If not a NumericElement then -1 is returned.

Parameters:

element - The element to convert.

Returns:

The element's long value or -1.