Merge pull request #180 from graphql-java/add-jspecify

add jspecify

Author: bbakerman

build.gradle

@@ -66,6 +66,7 @@ jar {
 
 dependencies {
     api "org.reactivestreams:reactive-streams:$reactive_streams_version"
+    api "org.jspecify:jspecify:1.0.0"
 }
 
 task sourcesJar(type: Jar) {
@@ -197,4 +198,4 @@ tasks.named("dependencyUpdates").configure {
     rejectVersionIf {
         isNonStable(it.candidate.version)
     }
-}
+}

src/main/java/org/dataloader/BatchLoader.java

@@ -17,6 +17,8 @@
 package org.dataloader;
 
 import org.dataloader.annotations.PublicSpi;
+import org.jspecify.annotations.NonNull;
+import org.jspecify.annotations.NullMarked;
 
 import java.util.List;
 import java.util.concurrent.CompletionStage;
@@ -74,6 +76,7 @@
  */
 @FunctionalInterface
 @PublicSpi
+@NullMarked
 public interface BatchLoader<K, V> {
 
     /**

src/main/java/org/dataloader/BatchLoaderContextProvider.java

@@ -1,16 +1,18 @@
 package org.dataloader;
 
 import org.dataloader.annotations.PublicSpi;
+import org.jspecify.annotations.NullMarked;
 
 /**
  * A BatchLoaderContextProvider is used by the {@link org.dataloader.DataLoader} code to
  * provide overall calling context to the {@link org.dataloader.BatchLoader} call.  A common use
  * case is for propagating user security credentials or database connection parameters for example.
  */
 @PublicSpi
+@NullMarked
 public interface BatchLoaderContextProvider {
     /**
      * @return a context object that may be needed in batch load calls
      */
     Object getContext();
-}
+}

src/main/java/org/dataloader/BatchLoaderEnvironment.java

@@ -2,6 +2,8 @@
 
 import org.dataloader.annotations.PublicApi;
 import org.dataloader.impl.Assertions;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
 import java.util.ArrayList;
 import java.util.Collections;
@@ -14,6 +16,7 @@
  * of the calling users for example or database parameters that allow the data layer call to succeed.
  */
 @PublicApi
+@NullMarked
 public class BatchLoaderEnvironment {
 
     private final Object context;
@@ -34,7 +37,7 @@ private BatchLoaderEnvironment(Object context, List<Object> keyContextsList, Map
      * @return a context object or null if there isn't one
      */
     @SuppressWarnings("unchecked")
-    public <T> T getContext() {
+    public <T> @Nullable T getContext() {
         return (T) context;
     }
 

src/main/java/org/dataloader/BatchLoaderEnvironmentProvider.java

@@ -1,6 +1,7 @@
 package org.dataloader;
 
 import org.dataloader.annotations.PublicSpi;
+import org.jspecify.annotations.NullMarked;
 
 /**
  * A BatchLoaderEnvironmentProvider is used by the {@link org.dataloader.DataLoader} code to
@@ -9,9 +10,10 @@
  * case is for propagating user security credentials or database connection parameters.
  */
 @PublicSpi
+@NullMarked
 public interface BatchLoaderEnvironmentProvider {
     /**
      * @return a {@link org.dataloader.BatchLoaderEnvironment} that may be needed in batch calls
      */
     BatchLoaderEnvironment get();
-}
+}

src/main/java/org/dataloader/BatchLoaderWithContext.java

@@ -1,6 +1,7 @@
 package org.dataloader;
 
 import org.dataloader.annotations.PublicSpi;
+import org.jspecify.annotations.NullMarked;
 
 import java.util.List;
 import java.util.concurrent.CompletionStage;
@@ -14,6 +15,7 @@
  * use this interface.
  */
 @PublicSpi
+@NullMarked
 public interface BatchLoaderWithContext<K, V> {
     /**
      * Called to batch load the provided keys and return a promise to a list of values.  This default

src/main/java/org/dataloader/BatchPublisher.java

@@ -1,5 +1,8 @@
 package org.dataloader;
 
+import org.dataloader.annotations.PublicSpi;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 import org.reactivestreams.Subscriber;
 
 import java.util.List;
@@ -18,6 +21,8 @@
  * @param <V> type parameter indicating the type of values returned
  * @see BatchLoader for the non-reactive version
  */
+@NullMarked
+@PublicSpi
 public interface BatchPublisher<K, V> {
     /**
      * Called to batch the provided keys into a stream of values.  You <b>must</b> provide

src/main/java/org/dataloader/BatchPublisherWithContext.java

@@ -1,5 +1,7 @@
 package org.dataloader;
 
+import org.dataloader.annotations.PublicSpi;
+import org.jspecify.annotations.NullMarked;
 import org.reactivestreams.Subscriber;
 
 import java.util.List;
@@ -12,6 +14,8 @@
  * See {@link BatchPublisher} for more details on the design invariants that you must implement in order to
  * use this interface.
  */
+@NullMarked
+@PublicSpi
 public interface BatchPublisherWithContext<K, V> {
     /**
      * Called to batch the provided keys into a stream of values.  You <b>must</b> provide

src/main/java/org/dataloader/CacheKey.java

@@ -16,6 +16,9 @@
 
 package org.dataloader;
 
+import org.dataloader.annotations.PublicSpi;
+import org.jspecify.annotations.NullMarked;
+
 /**
  * Function that is invoked on input keys of type {@code K} to derive keys that are required by the {@link CacheMap}
  * implementation.
@@ -25,6 +28,8 @@
  * @author <a href="https://github.com/aschrijver/">Arnold Schrijver</a>
  */
 @FunctionalInterface
+@NullMarked
+@PublicSpi
 public interface CacheKey<K> {
 
     /**

src/main/java/org/dataloader/CacheMap.java

@@ -18,6 +18,8 @@
 
 import org.dataloader.annotations.PublicSpi;
 import org.dataloader.impl.DefaultCacheMap;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
 import java.util.Collection;
 import java.util.concurrent.CompletableFuture;
@@ -39,6 +41,7 @@
  * @author <a href="https://github.com/bbakerman/">Brad Baker</a>
  */
 @PublicSpi
+@NullMarked
 public interface CacheMap<K, V> {
 
     /**
@@ -71,7 +74,7 @@ static <K, V> CacheMap<K, V> simpleMap() {
      *
      * @return the cached value, or {@code null} if not found (depends on cache implementation)
      */
-    CompletableFuture<V> get(K key);
+    @Nullable  CompletableFuture<V> get(K key);
 
     /**
      * Gets a collection of CompletableFutures from the cache map.