JAVA-757: Made CommandFailureException public. Added Javadoc

mongodb · Feb 22, 2013 · 2ed798f · 2ed798f
1 parent 7897a3b
commit 2ed798f
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/src/main/com/mongodb/CommandFailureException.java b/src/main/com/mongodb/CommandFailureException.java
@@ -17,11 +17,15 @@
 
 package com.mongodb;
 
-class CommandFailureException extends MongoException {
+/**
-    private static final long serialVersionUID = 1L;
+ * An exception indicating a failed command.
+ */
+public class CommandFailureException extends MongoException {
+    private static final long serialVersionUID = -1180715413196161037L;
     private final CommandResult commandResult;
 
     /**
+     * Construct a new instance with the CommandResult from a failed command
      *
      * @param commandResult the result
      */
@@ -30,6 +34,11 @@ public CommandFailureException(CommandResult commandResult){
         this.commandResult = commandResult;
     }
 
+    /**
+     * Gets the getlasterror command result document.
+     *
+     * @return the command result
+     */
     public CommandResult getCommandResult() {
         return commandResult;
     }

diff --git a/src/main/com/mongodb/WriteConcernException.java b/src/main/com/mongodb/WriteConcernException.java
@@ -26,6 +26,11 @@ public class WriteConcernException extends MongoException {
 
     private final CommandResult commandResult;
 
+    /**
+     * Construct a new instance with the CommandResult from getlasterror command
+     *
+     * @param commandResult the command result
+     */
     public WriteConcernException(final CommandResult commandResult) {
         super(commandResult.getCode(), commandResult.toString());
         this.commandResult = commandResult;