From 417a86b9ff11493dc35b95f4d8599ea269b1439c Mon Sep 17 00:00:00 2001
From: Laurent Goujon <laurentgo@users.noreply.github.com>
Date: Thu, 23 May 2024 18:36:57 -0700
Subject: [PATCH] GH-41789: [Java] Clean up immutables and checkerframework
 dependencies (#41790)

### Rationale for this change

As annotation processing is directly configured in `maven-compiler-plugin`, project dependencies should not include annotation processors in their dependencies, and annotations should be limited to `provided` scope as much as possible.

### What changes are included in this PR?

Clean up immutables and checkerframework dependencies to address the issue above:
* switch from `org.immutables:value` to `org.immutables:value-annotations`
* update `org.immutables` dependencies from 2.10.0 to 2.10.1
* change `org.checkerframework:checker-qual` default scope from `compile` to `provided`
* add `org.immutables:value` and `org.checkerframework:checker` to the list of banned dependencies

### Are these changes tested?

CI only

### Are there any user-facing changes?

No
* GitHub Issue: #41789

Authored-by: Laurent Goujon <laurent@apache.org>
Signed-off-by: David Li <li.davidm96@gmail.com>
---
 java/adapter/avro/pom.xml                             |  2 +-
 java/adapter/jdbc/pom.xml                             |  2 +-
 java/adapter/orc/pom.xml                              |  2 +-
 java/algorithm/pom.xml                                |  2 +-
 java/c/pom.xml                                        |  2 +-
 java/compression/pom.xml                              |  2 +-
 java/dataset/pom.xml                                  |  2 +-
 java/flight/flight-core/pom.xml                       |  2 +-
 java/flight/flight-sql/pom.xml                        |  2 +-
 java/gandiva/pom.xml                                  |  2 +-
 java/memory/memory-core/pom.xml                       |  2 +-
 .../memory/memory-core/src/main/java/module-info.java |  2 --
 java/memory/memory-netty/pom.xml                      |  2 +-
 java/memory/memory-unsafe/pom.xml                     |  2 +-
 java/pom.xml                                          | 11 +++++++----
 java/tools/pom.xml                                    |  2 +-
 java/vector/pom.xml                                   |  2 +-
 17 files changed, 22 insertions(+), 21 deletions(-)

diff --git a/java/adapter/avro/pom.xml b/java/adapter/avro/pom.xml
index 9ddc150253874..0046fcac62a22 100644
--- a/java/adapter/avro/pom.xml
+++ b/java/adapter/avro/pom.xml
@@ -47,7 +47,7 @@
 
     <dependency>
       <groupId>org.immutables</groupId>
-      <artifactId>value</artifactId>
+      <artifactId>value-annotations</artifactId>
     </dependency>
 
     <dependency>
diff --git a/java/adapter/jdbc/pom.xml b/java/adapter/jdbc/pom.xml
index 5f72729bb76e7..17681538ac97e 100644
--- a/java/adapter/jdbc/pom.xml
+++ b/java/adapter/jdbc/pom.xml
@@ -48,7 +48,7 @@
 
     <dependency>
       <groupId>org.immutables</groupId>
-      <artifactId>value</artifactId>
+      <artifactId>value-annotations</artifactId>
     </dependency>
 
     <!-- https://mvnrepository.com/artifact/com.h2database/h2 -->
diff --git a/java/adapter/orc/pom.xml b/java/adapter/orc/pom.xml
index f6aadca6de4d3..ca817510bf3e3 100644
--- a/java/adapter/orc/pom.xml
+++ b/java/adapter/orc/pom.xml
@@ -46,7 +46,7 @@
     </dependency>
     <dependency>
       <groupId>org.immutables</groupId>
-      <artifactId>value</artifactId>
+      <artifactId>value-annotations</artifactId>
     </dependency>
     <dependency>
       <groupId>org.apache.orc</groupId>
diff --git a/java/algorithm/pom.xml b/java/algorithm/pom.xml
index 92fa5c8553505..0854da48b718a 100644
--- a/java/algorithm/pom.xml
+++ b/java/algorithm/pom.xml
@@ -44,7 +44,7 @@
     </dependency>
     <dependency>
       <groupId>org.immutables</groupId>
-      <artifactId>value</artifactId>
+      <artifactId>value-annotations</artifactId>
     </dependency>
   </dependencies>
 
diff --git a/java/c/pom.xml b/java/c/pom.xml
index 1095e99bbdd3f..bfb233315a839 100644
--- a/java/c/pom.xml
+++ b/java/c/pom.xml
@@ -50,7 +50,7 @@
     </dependency>
     <dependency>
       <groupId>org.immutables</groupId>
-      <artifactId>value</artifactId>
+      <artifactId>value-annotations</artifactId>
     </dependency>
     <dependency>
       <groupId>org.apache.arrow</groupId>
diff --git a/java/compression/pom.xml b/java/compression/pom.xml
index ff1c7e1690440..26467dbaf2db3 100644
--- a/java/compression/pom.xml
+++ b/java/compression/pom.xml
@@ -37,7 +37,7 @@
     </dependency>
     <dependency>
       <groupId>org.immutables</groupId>
-      <artifactId>value</artifactId>
+      <artifactId>value-annotations</artifactId>
     </dependency>
     <dependency>
       <groupId>org.apache.commons</groupId>
diff --git a/java/dataset/pom.xml b/java/dataset/pom.xml
index dd0c76523d0f8..3dea16204a4db 100644
--- a/java/dataset/pom.xml
+++ b/java/dataset/pom.xml
@@ -46,7 +46,7 @@
     </dependency>
     <dependency>
       <groupId>org.immutables</groupId>
-      <artifactId>value</artifactId>
+      <artifactId>value-annotations</artifactId>
     </dependency>
     <dependency>
       <groupId>org.apache.arrow</groupId>
diff --git a/java/flight/flight-core/pom.xml b/java/flight/flight-core/pom.xml
index a7ea80d68fffe..b565572b383ab 100644
--- a/java/flight/flight-core/pom.xml
+++ b/java/flight/flight-core/pom.xml
@@ -119,7 +119,7 @@
     </dependency>
     <dependency>
       <groupId>org.immutables</groupId>
-      <artifactId>value</artifactId>
+      <artifactId>value-annotations</artifactId>
     </dependency>
 
     <dependency>
diff --git a/java/flight/flight-sql/pom.xml b/java/flight/flight-sql/pom.xml
index d5366ae988d57..e6d703c673ad5 100644
--- a/java/flight/flight-sql/pom.xml
+++ b/java/flight/flight-sql/pom.xml
@@ -52,7 +52,7 @@
     </dependency>
     <dependency>
       <groupId>org.immutables</groupId>
-      <artifactId>value</artifactId>
+      <artifactId>value-annotations</artifactId>
     </dependency>
     <dependency>
       <groupId>org.apache.arrow</groupId>
diff --git a/java/gandiva/pom.xml b/java/gandiva/pom.xml
index 00acb89f1d7cf..26a28d55d238e 100644
--- a/java/gandiva/pom.xml
+++ b/java/gandiva/pom.xml
@@ -36,7 +36,7 @@
     </dependency>
     <dependency>
       <groupId>org.immutables</groupId>
-      <artifactId>value</artifactId>
+      <artifactId>value-annotations</artifactId>
     </dependency>
     <dependency>
       <groupId>org.apache.arrow</groupId>
diff --git a/java/memory/memory-core/pom.xml b/java/memory/memory-core/pom.xml
index ca5bc603bd4dc..1e29ccf8ab9db 100644
--- a/java/memory/memory-core/pom.xml
+++ b/java/memory/memory-core/pom.xml
@@ -33,7 +33,7 @@
     </dependency>
     <dependency>
       <groupId>org.immutables</groupId>
-      <artifactId>value</artifactId>
+      <artifactId>value-annotations</artifactId>
     </dependency>
     <dependency>
       <groupId>org.checkerframework</groupId>
diff --git a/java/memory/memory-core/src/main/java/module-info.java b/java/memory/memory-core/src/main/java/module-info.java
index 5024b7f45769c..d8c22dd993dd9 100644
--- a/java/memory/memory-core/src/main/java/module-info.java
+++ b/java/memory/memory-core/src/main/java/module-info.java
@@ -23,7 +23,5 @@
   exports org.apache.arrow.util;
   requires transitive jdk.unsupported;
   requires jsr305;
-  requires org.immutables.value;
   requires org.slf4j;
-  requires org.checkerframework.checker.qual;
 }
diff --git a/java/memory/memory-netty/pom.xml b/java/memory/memory-netty/pom.xml
index bb4ccd6c26f2a..d815276b09e50 100644
--- a/java/memory/memory-netty/pom.xml
+++ b/java/memory/memory-netty/pom.xml
@@ -53,7 +53,7 @@
     </dependency>
     <dependency>
       <groupId>org.immutables</groupId>
-      <artifactId>value</artifactId>
+      <artifactId>value-annotations</artifactId>
     </dependency>
   </dependencies>
 
diff --git a/java/memory/memory-unsafe/pom.xml b/java/memory/memory-unsafe/pom.xml
index 502ac2cc8051a..f1aa8fde1faa1 100644
--- a/java/memory/memory-unsafe/pom.xml
+++ b/java/memory/memory-unsafe/pom.xml
@@ -28,7 +28,7 @@
     </dependency>
     <dependency>
       <groupId>org.immutables</groupId>
-      <artifactId>value</artifactId>
+      <artifactId>value-annotations</artifactId>
     </dependency>
   </dependencies>
 
diff --git a/java/pom.xml b/java/pom.xml
index 16564ae828b0f..9956c3b2e9f5f 100644
--- a/java/pom.xml
+++ b/java/pom.xml
@@ -115,6 +115,7 @@
         <groupId>org.checkerframework</groupId>
         <artifactId>checker-qual</artifactId>
         <version>${checker.framework.version}</version>
+        <scope>provided</scope>
       </dependency>
       <dependency>
         <groupId>com.google.flatbuffers</groupId>
@@ -149,8 +150,8 @@
       </dependency>
       <dependency>
         <groupId>org.immutables</groupId>
-        <artifactId>value</artifactId>
-        <version>2.10.0</version>
+        <artifactId>value-annotations</artifactId>
+        <version>2.10.1</version>
         <scope>provided</scope>
       </dependency>
       <dependency>
@@ -309,7 +310,7 @@
               <path>
                 <groupId>org.immutables</groupId>
                 <artifactId>value</artifactId>
-                <version>2.10.0</version>
+                <version>2.10.1</version>
               </path>
             </annotationProcessorPaths>
           </configuration>
@@ -669,6 +670,9 @@
                     <exclude>org.mortbay.jetty:servlet-api</exclude>
                     <exclude>org.mortbay.jetty:servlet-api-2.5</exclude>
                     <exclude>log4j:log4j</exclude>
+                    <!-- Do not include annotation processors. Use the annotations-only artifacts -->
+                    <exclude>org.immutables:value</exclude>
+                    <exclude>org.checkerframework:checker</exclude>
                   </excludes>
                 </bannedDependencies>
               </rules>
@@ -777,7 +781,6 @@
                 <!-- source annotations (not kept in compiled code) -->
                 <ignoredDependency>javax.annotation:javax.annotation-api:*</ignoredDependency>
                 <ignoredDependency>org.apache.hadoop:hadoop-client-api</ignoredDependency>
-                <ignoredDependency>org.checkerframework:checker-qual</ignoredDependency>
               </ignoredDependencies>
             </configuration>
           </execution>
diff --git a/java/tools/pom.xml b/java/tools/pom.xml
index b1507cd301f31..5d9db75e525bd 100644
--- a/java/tools/pom.xml
+++ b/java/tools/pom.xml
@@ -36,7 +36,7 @@
     </dependency>
     <dependency>
       <groupId>org.immutables</groupId>
-      <artifactId>value</artifactId>
+      <artifactId>value-annotations</artifactId>
     </dependency>
     <dependency>
       <groupId>com.google.guava</groupId>
diff --git a/java/vector/pom.xml b/java/vector/pom.xml
index a315bbc03afb6..c39504df2b207 100644
--- a/java/vector/pom.xml
+++ b/java/vector/pom.xml
@@ -32,7 +32,7 @@
     </dependency>
     <dependency>
       <groupId>org.immutables</groupId>
-      <artifactId>value</artifactId>
+      <artifactId>value-annotations</artifactId>
     </dependency>
     <dependency>
       <groupId>com.fasterxml.jackson.core</groupId>