com.allanbank.mongodb.acceptance

Class BasicAcceptanceTestCases.DocumentCallback

java.lang.Object

com.allanbank.mongodb.acceptance.BasicAcceptanceTestCases.DocumentCallback

All Implemented Interfaces:

Callback<Document>, StreamCallback<Document>

Enclosing class:

BasicAcceptanceTestCases

public static final class BasicAcceptanceTestCases.DocumentCallback
extends Object
implements StreamCallback<Document>

DocumentCallback provides a simple callback for testing streaming finds.

Copyright ©:

2012-2013, Allanbank Consulting, Inc., All Rights Reserved

Constructor Summary

Constructors

Constructor and Description
BasicAcceptanceTestCases.DocumentCallback()

Method Summary

Methods

Modifier and Type	Method and Description
void	callback(Document result)
void	done()
void	exception(Throwable thrown)
int	getCount() Returns the number of documents received.
Throwable	getException() Returns the exception if seen.
boolean	isTerminated() Returns true if the callback has been terminated.
boolean	isTerminatedByException() Returns the terminatedByException value.
boolean	isTerminatedByNull() Returns the terminatedByNull value.
void	waitFor(long timeMs) Waits for the specified number of documents to be received or the callback to be termined or the timeout.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicAcceptanceTestCases.DocumentCallback

public BasicAcceptanceTestCases.DocumentCallback()

Method Detail

callback

public void callback(Document result)

Specified by:

callback in interface Callback<Document>

done

public void done()

Overridden to mark the callback as terminated.

Specified by:

done in interface StreamCallback<Document>

exception

public void exception(Throwable thrown)

Specified by:

exception in interface Callback<Document>

getCount

public int getCount()

Returns the number of documents received.

Returns:

The number of documents received.

getException

public Throwable getException()

Returns the exception if seen.

Returns:

The exception if seen.

isTerminated

public boolean isTerminated()

Returns true if the callback has been terminated.

Returns:

True if the callback has been terminated.

isTerminatedByException

public boolean isTerminatedByException()

Returns the terminatedByException value.

Returns:

The terminatedByException value.

isTerminatedByNull

public boolean isTerminatedByNull()

Returns the terminatedByNull value.

Returns:

The terminatedByNull value.

waitFor

public void waitFor(long timeMs)

Waits for the specified number of documents to be received or the callback to be termined or the timeout.

Parameters:

timeMs - The maximum number of milliseconds to wait.