Merge pull request #82 from neo4j/ready-to-release

Prepare for release

Author: Zhen Li

README.md

@@ -44,6 +44,8 @@ Connect to a Neo4j 3.0.0+ database
 
 # Building
 
+## Java version
+
 If you are running Java 8:
 
     mvn clean install
@@ -56,3 +58,12 @@ Java 8, because Neo4j-the-database needs it to run.
 
     # For instance
     export NEO4J_JAVA=$(/usr/libexec/java_home -v 1.8)
+
+## Windows
+
+If you are building on windows, you need to run install as admin so that Neo4j-the-database could be registered as a
+windows service and then be started and stopped correctly using its powershell scripts for windows.
+To be able to run powershell script on windows, you might need to enable running scripts on the system.
+This can for example be achieved by executing the following from an elevated PowerShell prompt:
+
+    Set-ExecutionPolicy -ExecutionPolicy RemoteSigned

driver/pom.xml

@@ -19,6 +19,7 @@
   <packaging>jar</packaging>
   <name>Neo4j Java Driver</name>
   <description>Access to the Neo4j graph database through Java</description>
+  <url>https://github.com/neo4j/neo4j-java-driver</url>
 
   <licenses>
     <license>

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

@@ -161,7 +161,7 @@ public ConfigBuilder withLogging( Logging logging )
 
         /**
          * The max number of connections to open at any given time per Neo4j instance.
-         * @param size
+         * @param size the size of the connection pool
          * @return this builder
          */
         public ConfigBuilder withConnectionPoolSize( int size )
@@ -189,7 +189,7 @@ public ConfigBuilder withMinIdleTimeBeforeConnectionTest( long milliSecond )
          * If no certificate is provided, then we will trust the first certificate received from the server.
          * See {@code withKnownCerts} for more info about what will happen when no trusted certificate is
          * provided.
-         * @param value
+         * @param value true to enable tls and flase to disable tls
          * @return this builder
          */
         public ConfigBuilder withTlsEnabled( boolean value )
@@ -200,8 +200,8 @@ public ConfigBuilder withTlsEnabled( boolean value )
 
         /**
          * Defines how to authenticate a server in TLS connections.
-         * @param tlsAuthConfig
-         * @return
+         * @param tlsAuthConfig TLS authentication config
+         * @return this builder
          */
         public ConfigBuilder withTlsAuthConfig( TlsAuthenticationConfig tlsAuthConfig )
         {

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

@@ -37,6 +37,6 @@ public interface Identity
     int hashCode();
 
     // NOTE: This should be removed, but is kept until the Identity CIP is played
-    /** Return a long representation of this identity */
+    // Return a long representation of this identity
     long asLong();
 }

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

@@ -22,10 +22,10 @@
  * A <strong>Path</strong> is a directed sequence of relationships between two nodes. This generally
  * represents a <em>traversal</em> or <em>walk</em> through a graph and maintains a direction separate
  * from that of any relationships traversed.
- * <p>
+ *
  * It is allowed to be of size 0, meaning there are no relationships in it. In this case,
  * it contains only a single node which is both the start and the end of the path.
- * <p>
+ *
  * <pre>
  *     Path routeToStockholm = ..;
  *

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

@@ -31,7 +31,7 @@
  * what that part of the plan does - for instance, perform an index lookup or filter results. The Neo4j Manual contains
  * a reference of the available operator types, and these may differ across Neo4j versions.
  *
- * For a simple view of a plan, the {@link #toString()} will give a human-readable rendering of the tree.
+ * For a simple view of a plan, the {@code toString} method will give a human-readable rendering of the tree.
  */
 public interface Plan
 {

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

@@ -21,10 +21,10 @@
 /**
  * The result of running a statement, a stream of records. The result interface can be used to iterate over all the
  * records in the stream, and for each record to access the fields within it using the {@link #get(int) get} methods.
- * <p>
+ *
  * Results are valid until the next statement is run or until the end of the current transaction, whichever comes
  * first.
- * <p>
+ *
  * To keep a result around while further statements are run, or to use a result outside the scope of the current
  * transaction, see {@link #retain()}.
  */
@@ -33,7 +33,7 @@ public interface Result
     /**
      * 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>
+     *
      * This cannot be used if you have already started iterating through the stream using {@link #next()}.
      *
      * @return {@link org.neo4j.driver.ReusableResult}
@@ -73,9 +73,9 @@ public interface Result
 
     /**
      * Retrieve the first field of the next record in the stream, and close the stream.
-     * <p>
+     *
      * This is a utility for the common case of statements that are expected to yield a single output value.
-     * <p>
+     *
      * <pre>
      * {@code
      * Record record = statement.run( "MATCH (n:User {uid:..}) RETURN n.name" ).single();
@@ -89,9 +89,9 @@ public interface Result
 
     /**
      * Summarize the result
-     * <p>
+     *
      * Any remaining (unprocessed) result records will be consumed.
-     * <p>
+     *
      * <pre class="doctest:ResultDocIT#summarizeUsage">
      * {@code
      * ResultSummary summary = session.run( "PROFILE MATCH (n:User {id: 12345}) RETURN n" ).summarize();

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

@@ -30,12 +30,12 @@ public interface StatementRunner
 {
     /**
      * Run a statement and return a result stream.
-     * <p>
+     *
      * This method takes a set of parameters that will be injected into the
      * statement by Neo4j. Using parameters is highly encouraged, it helps avoid
      * dangerous cypher injection attacks and improves database performance as
      * Neo4j can re-use query plans more often.
-     * <p>
+     *
      * <h2>Example</h2>
      * <pre class="doctest:StatementRunnerDocIT#parameterTest">
      * {@code

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

@@ -20,13 +20,13 @@
 
 /**
  * Represents a transaction in the Neo4j database.
- * <p>
+ *
  * This interface may seem surprising in that it does not have explicit "commit" or "rollback" methods.
  * It is designed to minimize the complexity of the code you need to write to use transactions in a safe way, ensuring
  * that transactions are properly rolled back even if there is an exception while the transaction is running.
- * <p>
+ *
  * <h2>Example:</h2>
- * <p>
+ *
  * <pre class="docTest:TransactionDocIT#classDoc">
  * {@code
  * try( Transaction tx = session.newTransaction() )
@@ -47,13 +47,13 @@ public interface Transaction extends AutoCloseable, StatementRunner
 
     /**
      * Mark this transaction as failed. When you call {@link #close()}, the transaction will get rolled back.
-     * <p>
+     *
      * After this method has been called, there is nothing that can be done to "un-mark" it. This is a safety feature
      * to make sure no other code calls {@link #success()} and makes a transaction commit that was meant to be rolled
      * back.
-     * <p>
+     *
      * Example:
-     * <p>
+     *
      * <pre class="docTest:TransactionDocIT#failure">
      * {@code
      * try(Transaction tx = session.newTransaction() )

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

@@ -23,22 +23,22 @@
 
 /**
  * Represents a value from Neo4j.
- * <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.
  * The second set of methods perform coercions to Java types (wherever possible).
  * For example, a common Text value should be tested for using <code>isText</code>
  * and extracted using <code>stringValue</code>.
- * <p>
+ *
  * <h2>Navigating a tree structure</h2>
- * <p>
+ *
  * Because Neo4j often handles dynamic structures, this interface is designed to help
  * you handle such structures in Java. Specifically, {@link org.neo4j.driver.Value} lets you navigate arbitrary tree
  * structures without having to resort to type casting.
- * <p>
+ *
  * Given a tree structure like:
- * <p>
+ *
  * <pre>
  * {@code
  * {
@@ -49,17 +49,17 @@
  * }
  * }
  * </pre>
- * <p>
+ *
  * You can retrieve the name of the second user, John, like so:
- * <p>
+ *
  * <pre class="docTest:ValueDocIT#classDocTreeExample">
  * {@code
  * String username = value.get("users").get(1).get("name").javaString();
  * }
  * </pre>
- * <p>
+ *
  * You can also easily iterate over the users:
- * <p>
+ *
  * <pre class="docTest:ValueDocIT#classDocIterationExample">
  * {@code
  * List<String> names = new LinkedList<>();