Add JSpecify @NullMarked annotations to all remaining files

Co-authored-by: andimarek <1706744+andimarek@users.noreply.github.com>

Author: Copilot

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

@@ -2,6 +2,7 @@
 
 import org.dataloader.annotations.PublicSpi;
 import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
 /**
  * A BatchLoaderContextProvider is used by the {@link org.dataloader.DataLoader} code to
@@ -12,7 +13,7 @@
 @NullMarked
 public interface BatchLoaderContextProvider {
     /**
-     * @return a context object that may be needed in batch load calls
+     * @return a context object that may be needed in batch load calls, can be null
      */
-    Object getContext();
+    @Nullable Object getContext();
 }

src/main/java/org/dataloader/DataLoaderOptions.java

@@ -1,19 +1,3 @@
-/*
- * Copyright (c) 2016 The original author or authors
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * and Apache License v2.0 which accompanies this distribution.
- *
- *      The Eclipse Public License is available at
- *      http://www.eclipse.org/legal/epl-v10.html
- *
- *      The Apache License v2.0 is available at
- *      http://www.opensource.org/licenses/apache2.0.php
- *
- * You may elect to redistribute this code under either of these licenses.
- */
-
 package org.dataloader;
 
 import org.dataloader.annotations.PublicApi;
@@ -22,6 +6,8 @@
 import org.dataloader.scheduler.BatchLoaderScheduler;
 import org.dataloader.stats.NoOpStatisticsCollector;
 import org.dataloader.stats.StatisticsCollector;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
 import java.util.Objects;
 import java.util.Optional;
@@ -37,6 +23,7 @@
  * @author <a href="https://github.com/aschrijver/">Arnold Schrijver</a>
  */
 @PublicApi
+@NullMarked
 public class DataLoaderOptions {
 
     private static final BatchLoaderContextProvider NULL_PROVIDER = () -> null;
@@ -46,14 +33,14 @@ public class DataLoaderOptions {
     private final boolean batchingEnabled;
     private final boolean cachingEnabled;
     private final boolean cachingExceptionsEnabled;
-    private final CacheKey<?> cacheKeyFunction;
-    private final CacheMap<?, ?> cacheMap;
-    private final ValueCache<?, ?> valueCache;
+    private final @Nullable CacheKey<?> cacheKeyFunction;
+    private final @Nullable CacheMap<?, ?> cacheMap;
+    private final @Nullable ValueCache<?, ?> valueCache;
     private final int maxBatchSize;
     private final Supplier<StatisticsCollector> statisticsCollector;
     private final BatchLoaderContextProvider environmentProvider;
     private final ValueCacheOptions valueCacheOptions;
-    private final BatchLoaderScheduler batchLoaderScheduler;
+    private final @Nullable BatchLoaderScheduler batchLoaderScheduler;
     private final DataLoaderInstrumentation instrumentation;
 
     /**
@@ -243,7 +230,7 @@ public ValueCacheOptions getValueCacheOptions() {
     /**
      * @return the {@link BatchLoaderScheduler} to use, which can be null
      */
-    public BatchLoaderScheduler getBatchLoaderScheduler() {
+    public @Nullable BatchLoaderScheduler getBatchLoaderScheduler() {
         return batchLoaderScheduler;
     }
 
@@ -258,14 +245,14 @@ public static class Builder {
         private boolean batchingEnabled;
         private boolean cachingEnabled;
         private boolean cachingExceptionsEnabled;
-        private CacheKey<?> cacheKeyFunction;
-        private CacheMap<?, ?> cacheMap;
-        private ValueCache<?, ?> valueCache;
+        private @Nullable CacheKey<?> cacheKeyFunction;
+        private @Nullable CacheMap<?, ?> cacheMap;
+        private @Nullable ValueCache<?, ?> valueCache;
         private int maxBatchSize;
         private Supplier<StatisticsCollector> statisticsCollector;
         private BatchLoaderContextProvider environmentProvider;
         private ValueCacheOptions valueCacheOptions;
-        private BatchLoaderScheduler batchLoaderScheduler;
+        private @Nullable BatchLoaderScheduler batchLoaderScheduler;
         private DataLoaderInstrumentation instrumentation;
 
         public Builder() {
@@ -326,7 +313,7 @@ public Builder setCachingExceptionsEnabled(boolean cachingExceptionsEnabled) {
          * @param cacheKeyFunction the cache key function to use
          * @return this builder for fluent coding
          */
-        public Builder setCacheKeyFunction(CacheKey<?> cacheKeyFunction) {
+        public Builder setCacheKeyFunction(@Nullable CacheKey<?> cacheKeyFunction) {
             this.cacheKeyFunction = cacheKeyFunction;
             return this;
         }
@@ -337,7 +324,7 @@ public Builder setCacheKeyFunction(CacheKey<?> cacheKeyFunction) {
          * @param cacheMap the cache map instance
          * @return this builder for fluent coding
          */
-        public Builder setCacheMap(CacheMap<?, ?> cacheMap) {
+        public Builder setCacheMap(@Nullable CacheMap<?, ?> cacheMap) {
             this.cacheMap = cacheMap;
             return this;
         }
@@ -348,7 +335,7 @@ public Builder setCacheMap(CacheMap<?, ?> cacheMap) {
          * @param valueCache the value cache instance
          * @return this builder for fluent coding
          */
-        public Builder setValueCache(ValueCache<?, ?> valueCache) {
+        public Builder setValueCache(@Nullable ValueCache<?, ?> valueCache) {
             this.valueCache = valueCache;
             return this;
         }
@@ -407,7 +394,7 @@ public Builder setValueCacheOptions(ValueCacheOptions valueCacheOptions) {
          * @param batchLoaderScheduler the scheduler
          * @return this builder for fluent coding
          */
-        public Builder setBatchLoaderScheduler(BatchLoaderScheduler batchLoaderScheduler) {
+        public Builder setBatchLoaderScheduler(@Nullable BatchLoaderScheduler batchLoaderScheduler) {
             this.batchLoaderScheduler = batchLoaderScheduler;
             return this;
         }

src/main/java/org/dataloader/Try.java

@@ -1,6 +1,8 @@
 package org.dataloader;
 
 import org.dataloader.annotations.PublicApi;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
 import java.util.Optional;
 import java.util.concurrent.Callable;
@@ -26,6 +28,7 @@
  * the value promise with that exception value.
  */
 @PublicApi
+@NullMarked
 public class Try<V> {
     private final static Object NIL = new Object() {
     };
@@ -43,7 +46,7 @@ public synchronized Throwable fillInStackTrace() {
     };
 
 
-    private final Throwable throwable;
+    private final @Nullable Throwable throwable;
     private final V value;
 
 
@@ -169,7 +172,7 @@ public Throwable getThrowable() {
         if (isSuccess()) {
             throw new UnsupportedOperationException("You have called Try.getThrowable() with a successful Try");
         }
-        return throwable;
+        return nonNull(throwable);
     }
 
     /**
@@ -199,7 +202,7 @@ public <U> Try<U> map(Function<? super V, U> mapper) {
         if (isSuccess()) {
             return succeeded(mapper.apply(value));
         }
-        return failed(this.throwable);
+        return failed(nonNull(this.throwable));
     }
 
     /**
@@ -214,7 +217,7 @@ public <U> Try<U> flatMap(Function<? super V, Try<U>> mapper) {
         if (isSuccess()) {
             return mapper.apply(value);
         }
-        return failed(this.throwable);
+        return failed(nonNull(this.throwable));
     }
 
     /**
@@ -258,7 +261,7 @@ public void reThrow() throws Throwable {
         if (isSuccess()) {
             throw new UnsupportedOperationException("You have called Try.reThrow() with a successful Try.  There is nothing to rethrow");
         }
-        throw throwable;
+        throw nonNull(throwable);
     }
 
     /**
@@ -281,7 +284,7 @@ void forEach(Consumer<? super V> action) {
      */
     public Try<V> recover(Function<Throwable, V> recoverFunction) {
         if (isFailure()) {
-            return succeeded(recoverFunction.apply(throwable));
+            return succeeded(recoverFunction.apply(nonNull(throwable)));
         }
         return this;
     }

src/main/java/org/dataloader/impl/Assertions.java

@@ -1,10 +1,13 @@
 package org.dataloader.impl;
 
 import org.dataloader.annotations.Internal;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
 import java.util.function.Supplier;
 
 @Internal
+@NullMarked
 public class Assertions {
 
     public static void assertState(boolean state, Supplier<String> message) {
@@ -13,11 +16,11 @@ public static void assertState(boolean state, Supplier<String> message) {
         }
     }
 
-    public static <T> T nonNull(T t) {
+    public static <T> T nonNull(@Nullable T t) {
         return nonNull(t, () -> "nonNull object required");
     }
 
-    public static <T> T nonNull(T t, Supplier<String> message) {
+    public static <T> T nonNull(@Nullable T t, Supplier<String> message) {
         if (t == null) {
             throw new NullPointerException(message.get());
         }

src/main/java/org/dataloader/impl/CompletableFutureKit.java

@@ -1,6 +1,8 @@
 package org.dataloader.impl;
 
 import org.dataloader.annotations.Internal;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
 import java.util.List;
 import java.util.Map;
@@ -14,6 +16,7 @@
  * Some really basic helpers when working with CompletableFutures
  */
 @Internal
+@NullMarked
 public class CompletableFutureKit {
 
     public static <V> CompletableFuture<V> failedFuture(Exception e) {
@@ -22,7 +25,7 @@ public static <V> CompletableFuture<V> failedFuture(Exception e) {
         return future;
     }
 
-    public static <V> Throwable cause(CompletableFuture<V> completableFuture) {
+    public static <V> @Nullable Throwable cause(CompletableFuture<V> completableFuture) {
         if (!completableFuture.isCompletedExceptionally()) {
             return null;
         }

src/main/java/org/dataloader/impl/DataLoaderAssertionException.java

@@ -1,5 +1,8 @@
 package org.dataloader.impl;
 
+import org.jspecify.annotations.NullMarked;
+
+@NullMarked
 public class DataLoaderAssertionException extends IllegalStateException {
     public DataLoaderAssertionException(String message) {
         super(message);

src/main/java/org/dataloader/impl/NoOpValueCache.java

@@ -4,6 +4,8 @@
 import org.dataloader.Try;
 import org.dataloader.ValueCache;
 import org.dataloader.annotations.Internal;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
 import java.util.List;
 import java.util.concurrent.CompletableFuture;
@@ -20,7 +22,8 @@
  * @author <a href="https://github.com/craig-day">Craig Day</a>
  */
 @Internal
-public class NoOpValueCache<K, V> implements ValueCache<K, V> {
+@NullMarked
+public class NoOpValueCache<K, V extends @Nullable Object> implements ValueCache<K, V> {
 
     /**
      * a no op value cache instance

src/main/java/org/dataloader/impl/PromisedValues.java

@@ -1,6 +1,8 @@
 package org.dataloader.impl;
 
 import org.dataloader.annotations.Internal;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
 import java.util.List;
 import java.util.concurrent.CancellationException;
@@ -25,6 +27,7 @@
  * @author <a href="https://github.com/bbakerman/">Brad Baker</a>
  */
 @Internal
+@NullMarked
 public interface PromisedValues<T> {
 
     /**
@@ -193,7 +196,7 @@ static <T> PromisedValues<T> allPromisedValues(PromisedValues<T> pv1, PromisedVa
      *
      * @return an exception or null if the future did not fail
      */
-    Throwable cause();
+    @Nullable Throwable cause();
 
     /**
      * The true if the {@link CompletionStage} at the specified index succeeded
@@ -211,7 +214,7 @@ static <T> PromisedValues<T> allPromisedValues(PromisedValues<T> pv1, PromisedVa
      *
      * @return an exception or null if the future did not fail
      */
-    Throwable cause(int index);
+    @Nullable Throwable cause(int index);
 
     /**
      * The value at index or null if it failed
@@ -220,7 +223,7 @@ static <T> PromisedValues<T> allPromisedValues(PromisedValues<T> pv1, PromisedVa
      *
      * @return the value of the future
      */
-    T get(int index);
+    @Nullable T get(int index);
 
     /**
      * Returns the underlying values as a list

src/main/java/org/dataloader/impl/PromisedValuesImpl.java

@@ -1,6 +1,8 @@
 package org.dataloader.impl;
 
 import org.dataloader.annotations.Internal;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -16,6 +18,7 @@
 import static org.dataloader.impl.Assertions.nonNull;
 
 @Internal
+@NullMarked
 public class PromisedValuesImpl<T> implements PromisedValues<T> {
 
     private final List<? extends CompletionStage<T>> futures;
@@ -88,7 +91,7 @@ public boolean isDone() {
     }
 
     @Override
-    public Throwable cause() {
+    public @Nullable Throwable cause() {
         return cause.get();
     }
 
@@ -98,12 +101,12 @@ public boolean succeeded(int index) {
     }
 
     @Override
-    public Throwable cause(int index) {
+    public @Nullable Throwable cause(int index) {
         return CompletableFutureKit.cause(futures.get(index).toCompletableFuture());
     }
 
     @Override
-    public T get(int index) {
+    public @Nullable T get(int index) {
         assertState(isDone(), () -> "The PromisedValues MUST be complete before calling the get() method");
         try {
             CompletionStage<T> future = futures.get(index);