com.mongodb

Class CommandResult

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<String,Object>

org.bson.BasicBSONObject

com.mongodb.BasicDBObject

com.mongodb.CommandResult

All Implemented Interfaces:

DBObject, Serializable, Cloneable, Map<String,Object>, BSONObject

public class CommandResult
extends BasicDBObject

A simple wrapper for the result of getLastError() calls and other commands

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Method Summary

Methods

Modifier and Type	Method and Description
String	getErrorMessage() gets the "errmsg" field which holds the error message
MongoException	getException() utility method to create an exception with the command name
ServerAddress	getServerUsed()
boolean	ok() gets the "ok" field which is the result of the command
void	throwOnError() throws an exception containing the cmd name, in case the command failed, or the "err/code" information

Methods inherited from class com.mongodb.BasicDBObject

append, copy, isPartialObject, markAsPartialObject, toString

Methods inherited from class org.bson.BasicBSONObject

containsField, containsKey, equals, get, getBoolean, getBoolean, getDate, getDate, getDouble, getDouble, getInt, getInt, getLong, getLong, getObjectId, getObjectId, getString, getString, hashCode, put, putAll, putAll, removeField, toMap

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, get, removeEldestEntry

Methods inherited from class java.util.HashMap

clone, containsKey, entrySet, isEmpty, keySet, remove, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.bson.BSONObject

containsField, containsKey, get, keySet, put, putAll, putAll, removeField, toMap

Methods inherited from interface java.util.Map

containsKey, entrySet, isEmpty, keySet, remove, size, values

Method Detail

ok

public boolean ok()

gets the "ok" field which is the result of the command

Returns:

True if ok

getErrorMessage

public String getErrorMessage()

gets the "errmsg" field which holds the error message

Returns:

The error message or null

getException

public MongoException getException()

utility method to create an exception with the command name

Returns:

The mongo exception or null

throwOnError

public void throwOnError()

throws an exception containing the cmd name, in case the command failed, or the "err/code" information

Throws:

MongoException

getServerUsed

public ServerAddress getServerUsed()