Refactoring

This update migrates the `RoutingSettings` to record, fixes code style, removes redundant declarations, simplifies assertions, etc.

Author: injectives

driver/src/main/java/org/neo4j/driver/AccessMode.java

@@ -23,7 +23,7 @@
  * When running a transaction, a write transaction requires a server that supports writes.
  * A read transaction, on the other hand, requires a server that supports read operations.
  * This classification is key for routing driver to route transactions to a cluster correctly.
- *
+ * <p>
  * While any {@link AccessMode} will be ignored while running transactions via a driver towards a single server.
  * As the single server serves both read and write operations at the same time.
  */

driver/src/main/java/org/neo4j/driver/Bookmark.java

@@ -24,13 +24,13 @@
 
 /**
  * Causal chaining is carried out by passing bookmarks between transactions.
- *
+ * <p>
  * When starting a session with initial bookmarks, the first transaction will be ensured to run at least after
  * the database is as up-to-date as the latest transaction referenced by the supplied bookmarks.
- *
+ * <p>
  * Within a session, bookmark propagation is carried out automatically.
  * Thus all transactions in a session (both managed and unmanaged) are guaranteed to be carried out one after another.
- *
+ * <p>
  * To opt out of this mechanism for unrelated units of work, applications can use multiple sessions.
  */
 public interface Bookmark {

driver/src/main/java/org/neo4j/driver/BookmarkManagerConfig.java

@@ -51,7 +51,7 @@ public static BookmarkManagerConfigBuilder builder() {
     /**
      * Returns the map of bookmarks used to initialise the bookmark manager.
      *
-     * @return the map of bookmarks
+     * @return the set of bookmarks
      */
     public Set<Bookmark> initialBookmarks() {
         return initialBookmarks;

driver/src/main/java/org/neo4j/driver/Query.java

@@ -120,7 +120,7 @@ public Query withParameters(Map<String, Object> newParameters) {
     /**
      * Create a new query with new parameters derived by updating this'
      * query's parameters using the given updates.
-     *
+     * <p>
      * Every update key that points to a null value will be removed from
      * the new query's parameters. All other entries will just replace
      * any existing parameter in the new query.

driver/src/main/java/org/neo4j/driver/Result.java

@@ -29,10 +29,10 @@
 
 /**
  * The result of running a Cypher query, conceptually a stream of {@link Record records}.
- *
+ * <p>
  * The standard way of navigating through the result returned by the database is to
  * {@link #next() iterate} over it.
- *
+ * <p>
  * Results are valid until the next query is run or until the end of the current transaction,
  * whichever comes first. To keep a result around while further queries are run, or to use a result outside the scope
  * of the current transaction, see {@link #list()}.
@@ -42,11 +42,11 @@
  * In order to handle very large results, and to minimize memory overhead and maximize
  * performance, results are retrieved lazily. Please see {@link QueryRunner} for
  * important details on the effects of this.
- *
+ * <p>
  * The short version is that, if you want a hard guarantee that the underlying query
  * has completed, you need to either call {@link Resource#close()} on the {@link Transaction}
  * or {@link Session} that created this result, or you need to use the result.
- *
+ * <p>
  * Calling any method on this interface will guarantee that any write operation has completed on
  * the remote database.
  *
@@ -79,7 +79,7 @@ public interface Result extends Iterator<Record> {
     /**
      * Return the first record in the result, failing if there is not exactly
      * one record left in the stream
-     *
+     * <p>
      * Calling this method always exhausts the result, even when {@link NoSuchRecordException} is thrown.
      *
      * @return the first and only record in the stream
@@ -108,12 +108,12 @@ public interface Result extends Iterator<Record> {
      * Retrieve and store the entire result stream.
      * This can be used if you want to iterate over the stream multiple times or to store the
      * whole result for later use.
-     *
+     * <p>
      * Note that this method can only be used if you know that the query that
      * yielded this result returns a finite stream. Some queries can yield
      * infinite results, in which case calling this method will lead to running
      * out of memory.
-     *
+     * <p>
      * Calling this method exhausts the result.
      *
      * @return list of all remaining immutable records
@@ -124,12 +124,12 @@ public interface Result extends Iterator<Record> {
      * Retrieve and store a projection of the entire result.
      * This can be used if you want to iterate over the stream multiple times or to store the
      * whole result for later use.
-     *
+     * <p>
      * Note that this method can only be used if you know that the query that
      * yielded this result returns a finite stream. Some queries can yield
      * infinite results, in which case calling this method will lead to running
      * out of memory.
-     *
+     * <p>
      * Calling this method exhausts the result.
      *
      * @param mapFunction a function to map from Record to T. See {@link Records} for some predefined functions.

driver/src/main/java/org/neo4j/driver/SessionConfig.java

@@ -332,12 +332,12 @@ public Builder withDatabase(String database) {
          * Specify how many records to fetch in each batch for this session.
          * This config will overrides the default value set on {@link Config#fetchSize()}.
          * This config is only valid when the driver is used with servers that support Bolt V4 (Server version 4.0 and later).
-         *
+         * <p>
          * Bolt V4 enables pulling records in batches to allow client to take control of data population and apply back pressure to server.
          * This config specifies the default fetch size for all query runs using {@link Session} and {@link AsyncSession}.
          * By default, the value is set to {@code 1000}.
          * Use {@code -1} to disables back pressure and config client to pull all records at once after each run.
-         *
+         * <p>
          * This config only applies to run result obtained via {@link Session} and {@link AsyncSession}.
          * As with {@link RxSession}, the batch size is provided via {@link Subscription#request(long)} instead.
          * @param size the default record fetch size when pulling records in batches using Bolt V4.

driver/src/main/java/org/neo4j/driver/SimpleQueryRunner.java

@@ -95,7 +95,7 @@ public interface SimpleQueryRunner {
      *
      * Map<String, Object> parameters = new HashMap<String, Object>();
      * parameters.put("myNameParam", "Bob");
-     *
+     * <p>
      * Result result = session.run( "MATCH (n) WHERE n.name = $myNameParam RETURN (n)",
      *                                       parameters );
      * }

driver/src/main/java/org/neo4j/driver/Value.java

@@ -46,7 +46,7 @@
 
 /**
  * A unit of data that adheres to the Neo4j type system.
- *
+ * <p>
  * This interface describes a number of <code>isType</code> methods along with
  * <code>typeValue</code> methods. The first set of these correlate with types from
  * the Neo4j Type System and are used to determine which Neo4j type is represented.
@@ -59,7 +59,7 @@
  * Because Neo4j often handles dynamic structures, this interface is designed to help
  * you handle such structures in Java. Specifically, {@link Value} lets you navigate arbitrary tree
  * structures without having to resort to type casting.
- *
+ * <p>
  * Given a tree structure like:
  *
  * <pre>
@@ -74,15 +74,13 @@
  * </pre>
  *
  * You can retrieve the name of the second user, John, like so:
- *
  * <pre class="docTest:ValueDocIT#classDocTreeExample">
  * {@code
  * String username = value.get("users").get(1).get("name").asString();
  * }
  * </pre>
  *
  * You can also easily iterate over the users:
- *
  * <pre class="docTest:ValueDocIT#classDocIterationExample">
  * {@code
  * List<String> names = new LinkedList<>();
@@ -497,7 +495,7 @@ public interface Value extends MapAccessor, MapAccessorWithDefaultValue {
     /**
      * Return as a map of string keys and values converted using
      * {@link Value#asObject()}.
-     *
+     * <p>
      * This is equivalent to calling {@link #asMap(Function, Map)} with {@link Values#ofObject()}.
      *
      * @param defaultValue default to this value if the value is a {@link NullValue}

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

@@ -23,7 +23,7 @@
 
 /**
  * Thrown whenever a client expected to read a record that was not available (i.e. because it wasn't returned by the server).
- *
+ * <p>
  * This usually indicates an expectation mismatch between client code and database application logic.
  *
  * @since 1.0

driver/src/main/java/org/neo4j/driver/internal/InternalNotificationCategory.java

@@ -35,7 +35,7 @@ public enum Type {
         UNSUPPORTED,
         PERFORMANCE,
         DEPRECATION,
-        GENERIC;
+        GENERIC
     }
 
     public static Optional<NotificationCategory> valueOf(String value) {