Reconstruct lost commit: Rename retain to list and add @experimental to type system

Author: boggle

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

@@ -204,13 +204,13 @@ public RecordAccessor peek()
     }
 
     @Override
-    public List<Record> retain()
+    public List<Record> list()
     {
-        return retain( recordAsIs() );
+        return list( recordAsIs() );
     }
 
     @Override
-    public <T> List<T> retain( Function<RecordAccessor, T> mapFunction )
+    public <T> List<T> list( Function<RecordAccessor, T> mapFunction )
     {
         if ( isEmpty() )
         {

driver/src/main/java/org/neo4j/driver/v1/Experimental.java

@@ -0,0 +1,37 @@
+/**
+ * Copyright (c) 2002-2015 "Neo Technology,"
+ * Network Engine for Objects in Lund AB [http://neotechnology.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.neo4j.driver.v1;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Annotated elements are experimental and may change without deprecation across driver releases
+ */
+@Inherited
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+@Target( { ElementType.TYPE, ElementType.METHOD } )
+public @interface Experimental
+{
+}

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

@@ -24,7 +24,7 @@
  * A record is an immutable copy of an ordered map
  *
  * @see ResultCursor#record()
- * @see ResultCursor#retain()
+ * @see ResultCursor#list()
  */
 @Immutable
 public interface Record extends RecordAccessor

driver/src/main/java/org/neo4j/driver/v1/Records.java

@@ -21,7 +21,7 @@
 /**
  * Static utility methods for retaining records
  *
- * @see ResultCursor#retain()
+ * @see ResultCursor#list()
  */
 public abstract class Records
 {

driver/src/main/java/org/neo4j/driver/v1/ResultCursor.java

@@ -35,7 +35,7 @@
  * Initially, before {@link #next()} has been called at least once, all field values are null.
  *
  * 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()}.
+ * of the current transaction, see {@link #list()}.
  */
 public interface ResultCursor extends RecordAccessor, Resource
 {
@@ -122,7 +122,7 @@ public interface ResultCursor extends RecordAccessor, Resource
      * @throws ClientException if the cursor can't be positioned at the first record
      * @return list of all immutable records
      */
-    List<Record> retain();
+    List<Record> list();
 
     /**
      * Retrieve and store a projection of the entire result stream.
@@ -136,7 +136,7 @@ public interface ResultCursor extends RecordAccessor, Resource
      * @param <T> the type of result list elements
      * @return list of all mapped immutable records
      */
-    <T> List<T> retain( Function<RecordAccessor, T> mapFunction );
+    <T> List<T> list( Function<RecordAccessor, T> mapFunction );
 
     /**
      * Summarize the result.

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

@@ -76,5 +76,6 @@ public interface StatementRunner
     /**
      * @return type system used by this statement runner for classifying values
      */
+    @Experimental
     TypeSystem typeSystem();
 }

driver/src/main/java/org/neo4j/driver/v1/Type.java

@@ -21,7 +21,7 @@
 /**
  * The type of a {@link Value} as defined by the Cypher language
  */
-@Immutable
+@Immutable @Experimental
 public interface Type
 {
     /**

driver/src/main/java/org/neo4j/driver/v1/TypeSystem.java

@@ -18,7 +18,7 @@
  */
 package org.neo4j.driver.v1;
 
-@Immutable
+@Immutable @Experimental
 public interface TypeSystem
 {
     Type ANY();

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

@@ -110,6 +110,7 @@ public interface Value extends MapAccessor, ListAccessor
     Iterable<String> keys();
 
     /** @return The type of this value as defined in the Neo4j type system */
+    @Experimental
     Type type();
 
     /**
@@ -118,6 +119,7 @@ public interface Value extends MapAccessor, ListAccessor
      * @param type the given type
      * @return type.isTypeOf( this )
      */
+    @Experimental
     boolean hasType( Type type );
 
     /**

driver/src/test/java/org/neo4j/driver/internal/InternalResultCursorTest.java

@@ -155,7 +155,7 @@ public void limitShouldWorkAsExpected()
         result.limit( 10 );
 
         // THEN
-        assertThat( result.retain().size(), equalTo( 10 ) );
+        assertThat( result.list().size(), equalTo( 10 ) );
     }
 
     @Test
@@ -166,7 +166,7 @@ public void limitZeroShouldWorkAsExpected1()
         result.limit( 0 );
 
         // THEN
-        assertThat( result.retain().size(), equalTo( 0 ) );
+        assertThat( result.list().size(), equalTo( 0 ) );
     }
 
     @Test
@@ -190,7 +190,7 @@ public void limitOnEmptyResultShouldWorkAsExpected()
         result.limit( 10 );
 
         // THEN
-        assertThat( result.retain().size(), equalTo( 0 ) );
+        assertThat( result.list().size(), equalTo( 0 ) );
     }
 
     @Test
@@ -202,7 +202,7 @@ public void changingLimitShouldWorkAsExpected()
         result.limit( 60 );
 
         // THEN
-        assertThat( result.retain().size(), equalTo( 6 ) );
+        assertThat( result.list().size(), equalTo( 6 ) );
     }
 
     @Test
@@ -212,7 +212,7 @@ public void retainShouldWorkAsExpected()
         ResultCursor result = createResult( 3 );
 
         // WHEN
-        List<Record> records = result.retain();
+        List<Record> records = result.list();
 
         // THEN
         assertTrue(result.atEnd());
@@ -226,7 +226,7 @@ public void retainAndMapByKeyShouldWorkAsExpected()
         ResultCursor result = createResult( 3 );
 
         // WHEN
-        List<Value> records = result.retain( Records.columnAsIs( "k1" ) );
+        List<Value> records = result.list( Records.columnAsIs( "k1" ) );
 
         // THEN
         assertTrue(result.atEnd());
@@ -240,7 +240,7 @@ public void retainAndMapByIndexShouldWorkAsExpected()
         ResultCursor result = createResult( 3 );
 
         // WHEN
-        List<Value> records = result.retain( Records.columnAsIs( 0 ) );
+        List<Value> records = result.list( Records.columnAsIs( 0 ) );
 
         // THEN
         assertTrue(result.atEnd());
@@ -254,7 +254,7 @@ public void retainFailsIfItCannotRetainEntireResult()
         result.skip( 5 );
 
         expectedException.expect( ClientException.class );
-        result.retain();
+        result.list();
     }
 
     @Test