com.allanbank.mongodb.error

Class ReplyException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.allanbank.mongodb.MongoDbException

com.allanbank.mongodb.error.ReplyException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CursorNotFoundException, DuplicateKeyException, QueryFailedException, ShardConfigStaleException

public class ReplyException
extends MongoDbException

Base class exception for all reply errors.

See Also:

Serialized Form

API Notice:

This class is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

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

Constructor Summary

Constructors

Constructor and Description
ReplyException(int okValue, int errorNumber, String errorMessage, Message request, Reply reply) Create a new ReplyException.
ReplyException(int okValue, int errorNumber, String errorMessage, Reply reply) Create a new ReplyException.
ReplyException(Reply reply) Create a new ReplyException.
ReplyException(Reply reply, String message) Create a new ReplyException.
ReplyException(Reply reply, Throwable cause) Create a new ReplyException.

Method Summary

Methods

Modifier and Type	Method and Description
int	getErrorNumber() Returns the value of the "errNo" field in the reply document or -1.
int	getOkValue() Returns the value of the "ok" field in the reply document or -1.
Reply	getReply() Returns the reply.
Message	getRequest() Returns the original request message, if known.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplyException

public ReplyException(int okValue,
              int errorNumber,
              String errorMessage,
              Message request,
              Reply reply)

Create a new ReplyException.

Parameters:

okValue - The value of the "ok" field in the reply document.

errorNumber - The value of the "errNo" field in the reply document.

errorMessage - The value of the 'errormsg" field in the reply document.

request - The request that caused the error.

reply - The reply with the error.

ReplyException

public ReplyException(int okValue,
              int errorNumber,
              String errorMessage,
              Reply reply)

Create a new ReplyException.

Parameters:

okValue - The value of the "ok" field in the reply document.

errorNumber - The value of the "errNo" field in the reply document.

errorMessage - The value of the 'errmsg" field in the reply document.

reply - The reply with the error.

ReplyException

public ReplyException(Reply reply)

Create a new ReplyException.

Parameters:

reply - The reply that raised the exception.

ReplyException

public ReplyException(Reply reply,
              String message)

Create a new ReplyException.

Parameters:

reply - The reply that raised the exception.

message - Reason for the error.

ReplyException

public ReplyException(Reply reply,
              Throwable cause)

Create a new ReplyException.

Parameters:

reply - The reply that raised the exception.

cause - If known the cause of the exception.

Method Detail

getErrorNumber

public int getErrorNumber()

Returns the value of the "errNo" field in the reply document or -1.

Returns:

The value of the "errNo" field in the reply document.

getOkValue

public int getOkValue()

Returns the value of the "ok" field in the reply document or -1.

Returns:

The value of the "ok" field in the reply document.

getReply

public Reply getReply()

Returns the reply.

Returns:

The reply.

getRequest

public Message getRequest()

Returns the original request message, if known.

Returns:

The original request message, if known.