Improved javadoc and error classes

Author: Zhen Li

driver/src/main/java/org/neo4j/driver/exceptions/ResultConsumedException.java

@@ -27,9 +27,8 @@
  */
 public class ResultConsumedException extends ClientException
 {
-    public ResultConsumedException()
+    public ResultConsumedException( String message )
     {
-        super( "Cannot access records on this result any more as the result has already been consumed " +
-                "or the statement runner where the result is created has already been closed." );
+        super( message );
     }
 }

driver/src/main/java/org/neo4j/driver/exceptions/TransactionNestingException.java

@@ -27,9 +27,4 @@ public TransactionNestingException( String message )
     {
         super( message );
     }
-
-    public TransactionNestingException()
-    {
-        this( "You cannot run another query or begin a new transaction in the same session before you've fully consumed the previous run result." );
-    }
 }

driver/src/main/java/org/neo4j/driver/internal/cursor/DisposableAsyncStatementResultCursor.java

@@ -25,9 +25,9 @@
 import java.util.function.Function;
 
 import org.neo4j.driver.Record;
-import org.neo4j.driver.exceptions.ResultConsumedException;
 import org.neo4j.driver.summary.ResultSummary;
 
+import static org.neo4j.driver.internal.util.ErrorUtil.newResultConsumedError;
 import static org.neo4j.driver.internal.util.Futures.completedWithNull;
 import static org.neo4j.driver.internal.util.Futures.failedFuture;
 
@@ -109,7 +109,7 @@ private <T> CompletableFuture<T> assertNotDisposed()
     {
         if ( isDisposed )
         {
-            return failedFuture( new ResultConsumedException() );
+            return failedFuture( newResultConsumedError() );
         }
         return completedWithNull();
     }

driver/src/main/java/org/neo4j/driver/internal/cursor/RxStatementResultCursorImpl.java

@@ -25,12 +25,13 @@
 import java.util.function.BiConsumer;
 
 import org.neo4j.driver.Record;
-import org.neo4j.driver.exceptions.ResultConsumedException;
+import org.neo4j.driver.exceptions.TransactionNestingException;
 import org.neo4j.driver.internal.handlers.RunResponseHandler;
 import org.neo4j.driver.internal.handlers.pulln.PullResponseHandler;
-import org.neo4j.driver.exceptions.TransactionNestingException;
 import org.neo4j.driver.summary.ResultSummary;
 
+import static org.neo4j.driver.internal.util.ErrorUtil.newResultConsumedError;
+
 public class RxStatementResultCursorImpl implements RxStatementResultCursor
 {
     static final BiConsumer<Record,Throwable> DISCARD_RECORD_CONSUMER = ( record, throwable ) -> {/*do nothing*/};
@@ -69,7 +70,7 @@ public void installRecordConsumer( BiConsumer<Record,Throwable> recordConsumer )
     {
         if ( resultConsumed )
         {
-            throw new ResultConsumedException();
+            throw newResultConsumedError();
         }
         if ( isRecordConsumerInstalled() )
         {
@@ -109,7 +110,8 @@ public CompletionStage<Throwable> pullAllFailureAsync()
     {
         if ( isRecordConsumerInstalled() && !isDone() )
         {
-            return CompletableFuture.completedFuture( new TransactionNestingException() );
+            return CompletableFuture.completedFuture( new TransactionNestingException(
+                    "You cannot run another query or begin a new transaction in the same session before you've fully consumed the previous run result." ) );
         }
         // It is safe to discard records as either the streaming has not started at all, or the streaming is fully finished.
         return discardAllFailureAsync();

driver/src/main/java/org/neo4j/driver/internal/util/ErrorUtil.java

@@ -26,8 +26,9 @@
 import org.neo4j.driver.exceptions.AuthenticationException;
 import org.neo4j.driver.exceptions.ClientException;
 import org.neo4j.driver.exceptions.DatabaseException;
-import org.neo4j.driver.exceptions.Neo4jException;
 import org.neo4j.driver.exceptions.FatalDiscoveryException;
+import org.neo4j.driver.exceptions.Neo4jException;
+import org.neo4j.driver.exceptions.ResultConsumedException;
 import org.neo4j.driver.exceptions.ServiceUnavailableException;
 import org.neo4j.driver.exceptions.TransientException;
 
@@ -53,6 +54,12 @@ public static ServiceUnavailableException newConnectionTerminatedError()
                                                 "or due to restarts of the database" );
     }
 
+    public static ResultConsumedException newResultConsumedError()
+    {
+        return new ResultConsumedException( "Cannot access records on this result any more as the result has already been consumed " +
+                "or the statement runner where the result is created has already been closed." );
+    }
+
     public static Neo4jException newNeo4jError( String code, String message )
     {
         String classification = extractClassification( code );

driver/src/main/java/org/neo4j/driver/reactive/RxStatementResult.java

@@ -24,6 +24,7 @@
 
 import org.neo4j.driver.Record;
 import org.neo4j.driver.Statement;
+import org.neo4j.driver.exceptions.ResultConsumedException;
 import org.neo4j.driver.summary.ResultSummary;
 
 /**
@@ -83,8 +84,7 @@ public interface RxStatementResult
      * This publisher can only be subscribed by one {@link Subscriber} once.
      * <p>
      * If this publisher is subscribed after {@link #keys()}, then the publish of records is carried out after the arrival of keys.
-     * If this publisher is subscribed after {@link #consume()}, then the publish of records is already cancelled
-     * and an empty publisher of zero record will be return.
+     * If this publisher is subscribed after {@link #consume()}, then a {@link ResultConsumedException} will be thrown.
      * @return a cold unicast publisher of records.
      */
     Publisher<Record> records();
@@ -94,7 +94,7 @@ public interface RxStatementResult
      * <p>
      * {@linkplain Publisher#subscribe(Subscriber) Subscribing} the summary publisher results in the execution of the query followed by the result summary returned.
      * The summary publisher cancels record publishing if not yet subscribed and directly streams back the summary on query execution completion.
-     * As a result, the invocation of {@link #records()} after this method, would receive an empty publisher.
+     * As a result, the invocation of {@link #records()} after this method, would receive an {@link ResultConsumedException}.
      * <p>
      * If subscribed after {@link #keys()}, then the result summary will be published after the query execution without streaming any record to client.
      * If subscribed after {@link #records()}, then the result summary will be published after the query execution and the streaming of records.