Merge pull request #84 from boggle/driver-v1

Driver versioning and renaming

Author: Stefan Plantikow

driver/src/main/java/org/neo4j/driver/Config.java renamed to driver/src/main/java/org/neo4j/driver/v1/Config.java

@@ -16,15 +16,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
 
 import java.io.File;
 import java.util.logging.Level;
 
-import org.neo4j.driver.internal.logging.JULogging;
-import org.neo4j.driver.internal.spi.Logging;
+import org.neo4j.driver.v1.internal.logging.JULogging;
+import org.neo4j.driver.v1.internal.spi.Logging;
 
-import static org.neo4j.driver.Config.TlsAuthenticationConfig.*;
+import static org.neo4j.driver.v1.Config.TlsAuthenticationConfig.*;
 
 /**
  * A configuration class to config driver properties.

driver/src/main/java/org/neo4j/driver/Directed.java renamed to driver/src/main/java/org/neo4j/driver/v1/Directed.java

@@ -16,7 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
 
 /**
  * An item that can be considered to have <em>direction</em>.

driver/src/main/java/org/neo4j/driver/Driver.java renamed to driver/src/main/java/org/neo4j/driver/v1/Driver.java

@@ -16,13 +16,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
 
 import java.net.URI;
 
-import org.neo4j.driver.internal.StandardSession;
-import org.neo4j.driver.internal.pool.StandardConnectionPool;
-import org.neo4j.driver.internal.spi.ConnectionPool;
+import org.neo4j.driver.v1.internal.StandardSession;
+import org.neo4j.driver.v1.internal.pool.StandardConnectionPool;
+import org.neo4j.driver.v1.internal.spi.ConnectionPool;
 
 /**
  * A Neo4j database driver, through which you can create {@link Session sessions} to run statements against the database.
@@ -40,7 +40,7 @@
  * session.run( "CREATE (n {name:'Bob'})" );
  *
  * // Or, run multiple statements together in an atomic transaction:
- * try( Transaction tx = session.newTransaction() )
+ * try( Transaction tx = session.beginTransaction() )
  * {
  *     tx.run( "CREATE (n {name:'Alice'})" );
  *     tx.run( "CREATE (n {name:'Tina'})" );
@@ -84,7 +84,7 @@ public Driver( URI url, Config config )
     /**
      * Establish a session
      * @return a session that could be used to run {@link Session#run(String) a statement} or
-     * {@link Session#newTransaction() a transaction }.
+     * {@link Session#beginTransaction() a transaction }.
      */
     public Session session()
     {

driver/src/main/java/org/neo4j/driver/Entity.java renamed to driver/src/main/java/org/neo4j/driver/v1/Entity.java

@@ -16,15 +16,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
 
 /**
  * A uniquely identifiable property container that can form part of a Neo4j graph.
  */
 public interface Entity
 {
     /**
-     * A unique {@link org.neo4j.driver.Identity identity} for this Entity. Identities are guaranteed
+     * A unique {@link Identity identity} for this Entity. Identities are guaranteed
      * to remain stable for the duration of the session they were found in, but may be re-used for other
      * entities after that. As such, if you want a public identity to use for your entities, attaching
      * an explicit 'id' property or similar persistent and unique identifier is a better choice.
@@ -48,7 +48,7 @@ public interface Entity
     int propertyCount();
 
     /**
-     * Return a specific property {@link org.neo4j.driver.Value}. If no value could be found with the specified key,
+     * Return a specific property {@link Value}. If no value could be found with the specified key,
      * null will be returned.
      *
      * @param key a property key

driver/src/main/java/org/neo4j/driver/Function.java renamed to driver/src/main/java/org/neo4j/driver/v1/Function.java

@@ -16,7 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
 
 /**
  * Same as {@link java.util.function.Function}, but defined here to work in versions older than java 8.

driver/src/main/java/org/neo4j/driver/GraphDatabase.java renamed to driver/src/main/java/org/neo4j/driver/v1/GraphDatabase.java

@@ -16,7 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
 
 import java.net.URI;
 

driver/src/main/java/org/neo4j/driver/Identity.java renamed to driver/src/main/java/org/neo4j/driver/v1/Identity.java

@@ -16,10 +16,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
 
 /**
- * A unique identifier for an {@link org.neo4j.driver.Entity}.
+ * A unique identifier for an {@link Entity}.
  * <p>
  * The identity can be used to correlate entities in one response with entities received earlier. The identity of an
  * entity is guaranteed to be stable within the scope of a session. Beyond that, the identity may change. If you want

driver/src/main/java/org/neo4j/driver/InputPosition.java renamed to driver/src/main/java/org/neo4j/driver/v1/InputPosition.java

@@ -16,7 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
 
 /**
  * An input position refers to a specific character in a statement.

driver/src/main/java/org/neo4j/driver/Node.java renamed to driver/src/main/java/org/neo4j/driver/v1/Node.java

@@ -16,7 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
 
 /**
  * The <strong>Node</strong> interface describes the characteristics of a node from a Neo4j graph.
@@ -29,5 +29,4 @@ public interface Node extends Entity
      * @return a label Collection
      */
     Iterable<String> labels();
-
 }

driver/src/main/java/org/neo4j/driver/Notification.java renamed to driver/src/main/java/org/neo4j/driver/v1/Notification.java

@@ -16,7 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
 
 /**
  * Representation for notifications found when executing a statement.

driver/src/main/java/org/neo4j/driver/Path.java renamed to driver/src/main/java/org/neo4j/driver/v1/Path.java

@@ -16,7 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
 
 /**
  * A <strong>Path</strong> is a directed sequence of relationships between two nodes. This generally

driver/src/main/java/org/neo4j/driver/Plan.java renamed to driver/src/main/java/org/neo4j/driver/v1/Plan.java

@@ -16,7 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
 
 import java.util.List;
 import java.util.Map;

driver/src/main/java/org/neo4j/driver/ProfiledPlan.java renamed to driver/src/main/java/org/neo4j/driver/v1/ProfiledPlan.java

@@ -16,7 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
 
 import java.util.List;
 

driver/src/main/java/org/neo4j/driver/Record.java renamed to driver/src/main/java/org/neo4j/driver/v1/Record.java

@@ -16,11 +16,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
 
 /**
  * A record is a collection of named fields, and is what makes up the individual items in a {@link
- * org.neo4j.driver.Result}
+ * Result}
  */
 public interface Record
 {

driver/src/main/java/org/neo4j/driver/Relationship.java renamed to driver/src/main/java/org/neo4j/driver/v1/Relationship.java

@@ -16,7 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
 
 /**
  * The <strong>Relationship</strong> interface describes the characteristics of a relationship from a Neo4j graph.

driver/src/main/java/org/neo4j/driver/Result.java renamed to driver/src/main/java/org/neo4j/driver/v1/Result.java

@@ -16,7 +16,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
+
+import org.neo4j.driver.v1.exceptions.ClientException;
 
 /**
  * The result of running a statement, a stream of records. The result interface can be used to iterate over all the
@@ -36,7 +38,7 @@ public interface Result
      *
      * This cannot be used if you have already started iterating through the stream using {@link #next()}.
      *
-     * @return {@link org.neo4j.driver.ReusableResult}
+     * @return {@link ReusableResult}
      */
     ReusableResult retain();
 
@@ -83,7 +85,7 @@ public interface Result
      * </pre>
      *
      * @return a single record from the stream
-     * @throws org.neo4j.driver.exceptions.ClientException if the stream is empty
+     * @throws ClientException if the stream is empty
      */
     Record single();
 

driver/src/main/java/org/neo4j/driver/ResultSummary.java renamed to driver/src/main/java/org/neo4j/driver/v1/ResultSummary.java

@@ -16,7 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
 
 import java.util.List;
 

driver/src/main/java/org/neo4j/driver/ReusableResult.java renamed to driver/src/main/java/org/neo4j/driver/v1/ReusableResult.java

@@ -16,7 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
 
 /**
  * A {@link Result} that has been fully retrieved and stored from the server.

driver/src/main/java/org/neo4j/driver/Session.java renamed to driver/src/main/java/org/neo4j/driver/v1/Session.java

@@ -16,7 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
 
 /**
  * A live session with a Neo4j instance.
@@ -45,8 +45,8 @@ public interface Session extends AutoCloseable, StatementRunner
      *
      * @return a new transaction
      */
-    Transaction newTransaction();
+    Transaction beginTransaction();
 
     @Override
     void close();
-}
+}

driver/src/main/java/org/neo4j/driver/Statement.java renamed to driver/src/main/java/org/neo4j/driver/v1/Statement.java

@@ -16,24 +16,24 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
 
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
 
-import org.neo4j.driver.internal.ParameterSupport;
+import org.neo4j.driver.v1.internal.ParameterSupport;
 
 import static java.lang.String.format;
 
 /**
  * An executable statement, i.e. the statements' text and its parameters.
  *
- * @see org.neo4j.driver.Session
- * @see org.neo4j.driver.Transaction
- * @see org.neo4j.driver.Result
- * @see org.neo4j.driver.Result#summarize()
- * @see org.neo4j.driver.ResultSummary
+ * @see Session
+ * @see Transaction
+ * @see Result
+ * @see Result#summarize()
+ * @see ResultSummary
  */
 public class Statement
 {

driver/src/main/java/org/neo4j/driver/StatementRunner.java renamed to driver/src/main/java/org/neo4j/driver/v1/StatementRunner.java

@@ -16,15 +16,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
 
 import java.util.Map;
 
 /**
  * Common interface for components that can execute Neo4j statements.
  *
- * @see org.neo4j.driver.Session
- * @see org.neo4j.driver.Transaction
+ * @see Session
+ * @see Transaction
  */
 public interface StatementRunner
 {

driver/src/main/java/org/neo4j/driver/StatementType.java renamed to driver/src/main/java/org/neo4j/driver/v1/StatementType.java

@@ -16,9 +16,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
 
-import org.neo4j.driver.exceptions.ClientException;
+import org.neo4j.driver.v1.exceptions.ClientException;
 
 public enum StatementType
 {

driver/src/main/java/org/neo4j/driver/Transaction.java renamed to driver/src/main/java/org/neo4j/driver/v1/Transaction.java

@@ -16,7 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
 
 /**
  * Represents a transaction in the Neo4j database.
@@ -29,7 +29,7 @@
  *
  * <pre class="docTest:TransactionDocIT#classDoc">
  * {@code
- * try( Transaction tx = session.newTransaction() )
+ * try( Transaction tx = session.beginTransaction() )
  * {
  *     tx.run( "CREATE (n)" );
  *     tx.success();
@@ -56,7 +56,7 @@ public interface Transaction extends AutoCloseable, StatementRunner
      *
      * <pre class="docTest:TransactionDocIT#failure">
      * {@code
-     * try(Transaction tx = session.newTransaction() )
+     * try(Transaction tx = session.beginTransaction() )
      * {
      *     tx.run( "CREATE (n)" );
      *     tx.failure();

driver/src/main/java/org/neo4j/driver/UpdateStatistics.java renamed to driver/src/main/java/org/neo4j/driver/v1/UpdateStatistics.java

@@ -16,7 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
 
 /**
  * Contains counters for the number of update operations performed by a statement.

driver/src/main/java/org/neo4j/driver/Value.java renamed to driver/src/main/java/org/neo4j/driver/v1/Value.java

@@ -16,7 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver;
+package org.neo4j.driver.v1;
 
 import java.util.List;
 import java.util.Map;
@@ -34,7 +34,7 @@
  * <h2>Navigating a tree structure</h2>
  *
  * 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
+ * you handle such structures in Java. Specifically, {@link Value} lets you navigate arbitrary tree
  * structures without having to resort to type casting.
  *
  * Given a tree structure like: