com.mongodb
Class CommandResult

java.lang.Object
  extended by java.util.AbstractMap<K,V>
      extended by java.util.HashMap<K,V>
          extended by java.util.LinkedHashMap<String,Object>
              extended by org.bson.BasicBSONObject
                  extended by com.mongodb.BasicDBObject
                      extended by 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
 String getErrorMessage()
          gets the "errmsg" field which holds the error message
 MongoException getException()
          utility method to create an exception with the command name
 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
 
Methods inherited from class com.mongodb.BasicDBObject
append, isPartialObject, markAsPartialObject, toString
 
Methods inherited from class org.bson.BasicBSONObject
containsField, containsKey, equals, get, getBoolean, getDouble, getInt, getInt, getLong, getString, 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.util.AbstractMap
hashCode
 
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, hashCode, isEmpty, keySet, remove, size, values
 

Method Detail

ok

public boolean ok()
gets the "ok" field which is the result of the command

Returns:

getErrorMessage

public String getErrorMessage()
gets the "errmsg" field which holds the error message

Returns:

getException

public MongoException getException()
utility method to create an exception with the command name

Returns:

throwOnError

public void throwOnError()
                  throws MongoException
throws an exception containing the cmd name, in case the command failed

Throws:
MongoException