Added support for a delegating data loader - tweaked javadoc

Author: bbakerman

src/main/java/org/dataloader/DelegatingDataLoader.java

@@ -16,8 +16,24 @@
 
 /**
  * This delegating {@link DataLoader} makes it easier to create wrappers of {@link DataLoader}s in case you want to change how
- * values are returned for example
- *
+ * values are returned for example.
+ * <p>
+ * The most common way would be to make a new {@link DelegatingDataLoader} subclass that overloads the {@link DelegatingDataLoader#load(Object, Object)}
+ * method.
+ * <p>
+ * For example the following allows you to change the returned value in some way :
+ * <pre>
+ * {@code
+ *         DataLoader<String, String> rawLoader = createDataLoader();
+ *         DelegatingDataLoader<String, String> delegatingDataLoader = new DelegatingDataLoader<>(rawLoader) {
+ *             @Override
+ *             public CompletableFuture<String> load(@NonNull String key, @Nullable Object keyContext) {
+ *                 CompletableFuture<String> cf = super.load(key, keyContext);
+ *                 return cf.thenApply(v -> "|" + v + "|");
+ *             }
+ *         };
+ * }
+ * </pre>
  * @param <K> type parameter indicating the type of the data load keys
  * @param <V> type parameter indicating the type of the data that is returned
  */
@@ -65,7 +81,6 @@ public CompletableFuture<V> load(@NonNull K key, @Nullable Object keyContext) {
         return delegate.load(key, keyContext);
     }
 
-
     @Override
     public DataLoader<K, V> transform(Consumer<DataLoaderFactory.Builder<K, V>> builderConsumer) {
         return delegate.transform(builderConsumer);

src/test/java/org/dataloader/DelegatingDataLoaderTest.java

@@ -1,6 +1,7 @@
 package org.dataloader;
 
 import org.dataloader.fixtures.TestKit;
+import org.dataloader.fixtures.parameterized.DelegatingDataLoaderFactory;
 import org.jspecify.annotations.NonNull;
 import org.jspecify.annotations.Nullable;
 import org.junit.jupiter.api.Test;
@@ -14,7 +15,7 @@
 import static org.hamcrest.MatcherAssert.assertThat;
 
 /**
- * There are WAY more tests via the {@link org.dataloader.fixtures.parameterized.DelegatingDataLoaderFactory}
+ * There are WAY more tests via the {@link DelegatingDataLoaderFactory}
  * parameterized tests.  All the basic {@link DataLoader} tests pass when wrapped in a {@link DelegatingDataLoader}
  */
 public class DelegatingDataLoaderTest {