com.allanbank.mongodb.client.connection.socket

Class PoisonMessage

java.lang.Object

com.allanbank.mongodb.client.connection.socket.PoisonMessage

All Implemented Interfaces:

Message

public class PoisonMessage
extends Object
implements Message

PoisonMessage provides a message that throws an exception when you try to write it.

Copyright ©:

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

Constructor Summary

Constructors

Constructor and Description
PoisonMessage(Throwable toThrow) Creates a new PoisonMessage.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDatabaseName()
String	getOperationName()
ReadPreference	getReadPreference()
VersionRange	getRequiredVersionRange()
int	size()
void	validateSize(int maxDocumentSize)
void	write(int messageId, BsonOutputStream out)
void	write(int messageId, BufferingBsonOutputStream out)

Methods inherited from class java.lang.Object

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

Constructor Detail

PoisonMessage

public PoisonMessage(Throwable toThrow)

Creates a new PoisonMessage.

Parameters:

toThrow - The exception to throw.

Method Detail

getDatabaseName

public String getDatabaseName()

Specified by:

getDatabaseName in interface Message

getOperationName

public String getOperationName()

Specified by:

getOperationName in interface Message

getReadPreference

public ReadPreference getReadPreference()

Specified by:

getReadPreference in interface Message

getRequiredVersionRange

public VersionRange getRequiredVersionRange()

Specified by:

getRequiredVersionRange in interface Message

size

public int size()

Overridden to return zero.

Specified by:

size in interface Message

validateSize

public void validateSize(int maxDocumentSize)
                  throws DocumentToLargeException

Specified by:

validateSize in interface Message

Throws:

DocumentToLargeException

write

public void write(int messageId,
         BsonOutputStream out)
           throws IOException

Specified by:

write in interface Message

Throws:

IOException

write

public void write(int messageId,
         BufferingBsonOutputStream out)
           throws IOException

Specified by:

write in interface Message

Throws:

IOException