Enable compilation failures on warnings for examples

Author: injectives

driver/src/test/java/org/neo4j/driver/util/StdIOCapture.java

@@ -22,32 +22,34 @@
 
 import java.io.ByteArrayOutputStream;
 import java.io.PrintStream;
+import java.io.UnsupportedEncodingException;
 import java.util.List;
 import java.util.concurrent.CopyOnWriteArrayList;
 
 /**
  * Utility that can be used to temporarily capture and store process-wide stdout and stderr output.
  */
-public class StdIOCapture {
+public class StdIOCapture implements AutoCloseable {
     private final List<String> stdout = new CopyOnWriteArrayList<>();
     private final List<String> stderr = new CopyOnWriteArrayList<>();
+    private final PrintStream originalStdOut;
+    private final PrintStream originalStdErr;
+    private final ByteArrayOutputStream capturedStdOut;
+    private final ByteArrayOutputStream capturedStdErr;
 
     /** Put this in a try-with-resources block to capture all standard io that happens within the try block */
-    public AutoCloseable capture() {
-        final PrintStream originalStdOut = System.out;
-        final PrintStream originalStdErr = System.err;
-        final ByteArrayOutputStream capturedStdOut = new ByteArrayOutputStream();
-        final ByteArrayOutputStream capturedStdErr = new ByteArrayOutputStream();
+    public static StdIOCapture capture() {
+        return new StdIOCapture();
+    }
+
+    private StdIOCapture() {
+        originalStdOut = System.out;
+        originalStdErr = System.err;
+        capturedStdOut = new ByteArrayOutputStream();
+        capturedStdErr = new ByteArrayOutputStream();
 
         System.setOut(new PrintStream(capturedStdOut));
         System.setErr(new PrintStream(capturedStdErr));
-
-        return () -> {
-            System.setOut(originalStdOut);
-            System.setErr(originalStdErr);
-            stdout.addAll(asList(capturedStdOut.toString("UTF-8").split(System.lineSeparator())));
-            stderr.addAll(asList(capturedStdErr.toString("UTF-8").split(System.lineSeparator())));
-        };
     }
 
     public List<String> stdout() {
@@ -57,4 +59,12 @@ public List<String> stdout() {
     public List<String> stderr() {
         return stderr;
     }
+
+    @Override
+    public void close() throws UnsupportedEncodingException {
+        System.setOut(originalStdOut);
+        System.setErr(originalStdErr);
+        stdout.addAll(asList(capturedStdOut.toString("UTF-8").split(System.lineSeparator())));
+        stderr.addAll(asList(capturedStdErr.toString("UTF-8").split(System.lineSeparator())));
+    }
 }

examples/pom.xml

@@ -82,13 +82,6 @@
 
   <build>
     <plugins>
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-compiler-plugin</artifactId>
-        <configuration>
-          <compilerArgs combine.self="override"/>
-        </configuration>
-      </plugin>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>

examples/src/main/java/org/neo4j/docs/driver/AsyncResultConsumeExample.java

@@ -22,14 +22,15 @@
 
 import java.util.List;
 import java.util.concurrent.CompletionStage;
-import org.neo4j.driver.async.AsyncSession;
 // end::async-result-consume-import[]
+import org.neo4j.driver.async.AsyncSession;
 
 public class AsyncResultConsumeExample extends BaseApplication {
     public AsyncResultConsumeExample(String uri, String user, String password) {
         super(uri, user, password);
     }
 
+    @SuppressWarnings("deprecation")
     // tag::async-result-consume[]
     public CompletionStage<List<String>> getPeople() {
 

examples/src/main/java/org/neo4j/docs/driver/AsyncRunMultipleTransactionExample.java

@@ -21,9 +21,7 @@
 // tag::async-result-consume-import[]
 
 import static org.neo4j.driver.Values.parameters;
-// end::async-result-consume-import[]
 
-import java.util.Arrays;
 import java.util.List;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.CompletionStage;
@@ -38,6 +36,7 @@ public AsyncRunMultipleTransactionExample(String uri, String user, String passwo
         super(uri, user, password);
     }
 
+    @SuppressWarnings("deprecation")
     // tag::async-multiple-tx[]
     public CompletionStage<Integer> addEmployees(final String companyName) {
         AsyncSession session = driver.asyncSession();
@@ -53,14 +52,13 @@ private static CompletionStage<List<String>> matchPersonNodes(AsyncTransaction t
                         cursor -> cursor.listAsync(record -> record.get("name").asString()));
     }
 
-    private static CompletableFuture<Integer> createNodes(
+    private static CompletionStage<Integer> createNodes(
             AsyncTransaction tx, String companyName, List<String> personNames) {
-        CompletableFuture<Integer>[] nodeCreatedCounts = personNames.stream()
+        return personNames.stream()
                 .map(personName -> createNode(tx, companyName, personName))
-                .toArray(size -> new CompletableFuture[size]);
-        return CompletableFuture.allOf(nodeCreatedCounts).thenApply(ignored -> Arrays.stream(nodeCreatedCounts)
-                .map(CompletableFuture::join)
-                .reduce(0, Integer::sum));
+                .reduce(
+                        CompletableFuture.completedFuture(0),
+                        (stage1, stage2) -> stage1.thenCombine(stage2, Integer::sum));
     }
 
     private static CompletionStage<Integer> createNode(AsyncTransaction tx, String companyName, String personName) {

examples/src/main/java/org/neo4j/docs/driver/AsyncTransactionFunctionExample.java

@@ -18,18 +18,20 @@
  */
 package org.neo4j.docs.driver;
 // tag::async-transaction-function-import[]
+
 import java.util.Collections;
 import java.util.Map;
 import java.util.concurrent.CompletionStage;
+// end::async-transaction-function-import[]
 import org.neo4j.driver.async.AsyncSession;
 import org.neo4j.driver.summary.ResultSummary;
-// end::async-transaction-function-import[]
 
 public class AsyncTransactionFunctionExample extends BaseApplication {
     public AsyncTransactionFunctionExample(String uri, String user, String password) {
         super(uri, user, password);
     }
 
+    @SuppressWarnings("deprecation")
     // tag::async-transaction-function[]
     public CompletionStage<ResultSummary> printAllProducts() {
         String query = "MATCH (p:Product) WHERE p.id = $id RETURN p.title";

examples/src/main/java/org/neo4j/docs/driver/BaseApplication.java

@@ -30,7 +30,7 @@ public BaseApplication(String uri, String user, String password) {
     }
 
     @Override
-    public void close() throws Exception {
+    public void close() throws RuntimeException {
         driver.close();
     }
 }

examples/src/main/java/org/neo4j/docs/driver/BasicAuthExample.java

@@ -36,7 +36,7 @@ public BasicAuthExample(String uri, String user, String password) {
     // end::basic-auth[]
 
     @Override
-    public void close() throws Exception {
+    public void close() throws RuntimeException {
         driver.close();
     }
 

examples/src/main/java/org/neo4j/docs/driver/BearerAuthExample.java

@@ -35,7 +35,7 @@ public BearerAuthExample(String uri, String bearerToken) {
     // end::bearer-auth[]
 
     @Override
-    public void close() throws Exception {
+    public void close() throws RuntimeException {
         driver.close();
     }
 }

examples/src/main/java/org/neo4j/docs/driver/ConfigConnectionPoolExample.java

@@ -18,13 +18,14 @@
  */
 package org.neo4j.docs.driver;
 // tag::config-connection-pool-import[]
+
 import java.util.concurrent.TimeUnit;
+// end::config-connection-pool-import[]
 import org.neo4j.driver.AuthTokens;
 import org.neo4j.driver.Config;
 import org.neo4j.driver.Driver;
 import org.neo4j.driver.GraphDatabase;
 import org.neo4j.driver.Result;
-// end::config-connection-pool-import[]
 
 public class ConfigConnectionPoolExample implements AutoCloseable {
     private final Driver driver;
@@ -42,7 +43,7 @@ public ConfigConnectionPoolExample(String uri, String user, String password) {
     // end::config-connection-pool[]
 
     @Override
-    public void close() throws Exception {
+    public void close() throws RuntimeException {
         driver.close();
     }
 

examples/src/main/java/org/neo4j/docs/driver/ConfigConnectionTimeoutExample.java

@@ -21,7 +21,6 @@
 // tag::config-connection-timeout-import[]
 
 import static java.util.concurrent.TimeUnit.SECONDS;
-// end::config-connection-timeout-import[]
 
 import org.neo4j.driver.AuthTokens;
 import org.neo4j.driver.Config;
@@ -40,7 +39,7 @@ public ConfigConnectionTimeoutExample(String uri, String user, String password)
     // end::config-connection-timeout[]
 
     @Override
-    public void close() throws Exception {
+    public void close() throws RuntimeException {
         driver.close();
     }
 }

examples/src/main/java/org/neo4j/docs/driver/ConfigCustomResolverExample.java

@@ -75,7 +75,7 @@ private void addPerson(String name) {
     // end::config-custom-resolver[]
 
     @Override
-    public void close() throws Exception {
+    public void close() throws RuntimeException {
         driver.close();
     }
 

examples/src/main/java/org/neo4j/docs/driver/ConfigMaxRetryTimeExample.java

@@ -21,7 +21,6 @@
 // tag::config-max-retry-time-import[]
 
 import static java.util.concurrent.TimeUnit.SECONDS;
-// end::config-max-retry-time-import[]
 
 import org.neo4j.driver.AuthTokens;
 import org.neo4j.driver.Config;
@@ -41,7 +40,7 @@ public ConfigMaxRetryTimeExample(String uri, String user, String password) {
     // end::config-max-retry-time[]
 
     @Override
-    public void close() throws Exception {
+    public void close() throws RuntimeException {
         driver.close();
     }
 }

examples/src/main/java/org/neo4j/docs/driver/ConfigTrustExample.java

@@ -40,7 +40,7 @@ public ConfigTrustExample(String uri, String user, String password) {
     // end::config-trust[]
 
     @Override
-    public void close() throws Exception {
+    public void close() throws RuntimeException {
         driver.close();
     }
 }

examples/src/main/java/org/neo4j/docs/driver/ConfigUnencryptedExample.java

@@ -38,7 +38,7 @@ public ConfigUnencryptedExample(String uri, String user, String password) {
     // end::config-unencrypted[]
 
     @Override
-    public void close() throws Exception {
+    public void close() throws RuntimeException {
         driver.close();
     }
 }

examples/src/main/java/org/neo4j/docs/driver/CustomAuthExample.java

@@ -21,10 +21,10 @@
 // tag::custom-auth-import[]
 
 import java.util.Map;
+// end::custom-auth-import[]
 import org.neo4j.driver.AuthTokens;
 import org.neo4j.driver.Driver;
 import org.neo4j.driver.GraphDatabase;
-// end::custom-auth-import[]
 
 public class CustomAuthExample implements AutoCloseable {
     private final Driver driver;
@@ -42,7 +42,7 @@ public CustomAuthExample(
     // end::custom-auth[]
 
     @Override
-    public void close() throws Exception {
+    public void close() throws RuntimeException {
         driver.close();
     }
 }

examples/src/main/java/org/neo4j/docs/driver/CypherErrorExample.java

@@ -21,7 +21,6 @@
 // tag::cypher-error-import[]
 
 import static org.neo4j.driver.Values.parameters;
-// end::cypher-error-import[]
 
 import org.neo4j.driver.Result;
 import org.neo4j.driver.Session;
@@ -34,6 +33,7 @@ public CypherErrorExample(String uri, String user, String password) {
         super(uri, user, password);
     }
 
+    @SuppressWarnings("deprecation")
     // tag::cypher-error[]
     public int getEmployeeNumber(final String name) {
         try (Session session = driver.session()) {

examples/src/main/java/org/neo4j/docs/driver/DriverIntroductionExample.java

@@ -25,6 +25,7 @@
 import java.util.Map;
 import java.util.logging.Level;
 import java.util.logging.Logger;
+// end::driver-introduction-example-import[]
 import org.neo4j.driver.AuthTokens;
 import org.neo4j.driver.Config;
 import org.neo4j.driver.Driver;
@@ -34,7 +35,6 @@
 import org.neo4j.driver.Result;
 import org.neo4j.driver.Session;
 import org.neo4j.driver.exceptions.Neo4jException;
-// end::driver-introduction-example-import[]
 
 // tag::driver-introduction-example[]
 public class DriverIntroductionExample implements AutoCloseable {
@@ -47,11 +47,12 @@ public DriverIntroductionExample(String uri, String user, String password, Confi
     }
 
     @Override
-    public void close() throws Exception {
+    public void close() throws RuntimeException {
         // The driver object should be closed before the application ends.
         driver.close();
     }
 
+    @SuppressWarnings("deprecation")
     public void createFriendship(final String person1Name, final String person2Name, final String knowsFrom) {
         // To learn more about the Cypher syntax, see https://neo4j.com/docs/cypher-manual/current/
         // The Reference Card is also a good resource for keywords https://neo4j.com/docs/cypher-refcard/current/
@@ -83,6 +84,7 @@ public void createFriendship(final String person1Name, final String person2Name,
         }
     }
 
+    @SuppressWarnings("deprecation")
     public void findPerson(final String personName) {
         String readPersonByNameQuery = "MATCH (p:Person)\n" + "WHERE p.name = $person_name\n" + "RETURN p.name AS name";
 

examples/src/main/java/org/neo4j/docs/driver/DriverLifecycleExample.java

@@ -34,7 +34,7 @@ public DriverLifecycleExample(String uri, String user, String password) {
     }
 
     @Override
-    public void close() throws Exception {
+    public void close() throws RuntimeException {
         driver.close();
     }
 }

examples/src/main/java/org/neo4j/docs/driver/HelloWorldExample.java

@@ -21,7 +21,6 @@
 // tag::hello-world-import[]
 
 import static org.neo4j.driver.Values.parameters;
-// end::hello-world-import[]
 
 import org.neo4j.driver.AuthTokens;
 import org.neo4j.driver.Driver;
@@ -38,10 +37,11 @@ public HelloWorldExample(String uri, String user, String password) {
     }
 
     @Override
-    public void close() throws Exception {
+    public void close() throws RuntimeException {
         driver.close();
     }
 
+    @SuppressWarnings("deprecation")
     public void printGreeting(final String message) {
         try (Session session = driver.session()) {
             String greeting = session.writeTransaction(tx -> {

examples/src/main/java/org/neo4j/docs/driver/KerberosAuthExample.java

@@ -35,7 +35,7 @@ public KerberosAuthExample(String uri, String ticket) {
     // end::kerberos-auth[]
 
     @Override
-    public void close() throws Exception {
+    public void close() throws RuntimeException {
         driver.close();
     }
 }

examples/src/main/java/org/neo4j/docs/driver/PassBookmarkExample.java

@@ -22,7 +22,6 @@
 
 import static org.neo4j.driver.SessionConfig.builder;
 import static org.neo4j.driver.Values.parameters;
-// end::pass-bookmarks-import[]
 
 import java.util.ArrayList;
 import java.util.List;
@@ -79,6 +78,7 @@ private Result printFriends(final Transaction tx) {
         return result;
     }
 
+    @SuppressWarnings("deprecation")
     public void addEmployAndMakeFriends() {
         // To collect the session bookmarks
         List<Bookmark> savedBookmarks = new ArrayList<>();