add mutable data holder set for nullable and not nullable keys

Author: vsch

VERSION.md

@@ -180,6 +180,11 @@ Next
 * Fix: deprecate `DataKey.getFrom()`
 * Fix: replace all `DataHolder.get()` by `DataKey.get()`
 * Fix: add nullability annotations to `Node` and a few other classes
+* Add: `MutableDataHolder.set(@NotNull DataKey<T>, @NotNull T)` and
+  `MutableDataHolder.set(@NotNull NullableDataKey<T>, @Nullable T)` to respect nullability of
+  key's data value.
+* Add: `DataKey.set(@NotNull MutableDataHolder, @NotNull T)` and `NullableDataKey.set(@NotNull
+  MutableDataHolder, @Nullable T)` to allow setting data values via keys, if needed.
 
 0.59.30
 -------

flexmark-util/src/main/java/com/vladsch/flexmark/util/ast/Document.java

@@ -31,7 +31,10 @@ public MutableDataHolder clear() {
     }
 
     @Override
-    public <T> MutableDataSet set(DataKeyBase<T> key, T value) {return dataSet.set(key, value);}
+    public <T> MutableDataHolder set(DataKey<T> key, @NotNull T value) {return dataSet.set(key, value);}
+
+    @Override
+    public <T> MutableDataHolder set(NullableDataKey<T> key, @Nullable T value) {return dataSet.set(key, value);}
 
     @Override
     public MutableDataSet setFrom(MutableDataSetter dataSetter) {return dataSet.setFrom(dataSetter);}

flexmark-util/src/main/java/com/vladsch/flexmark/util/builder/BuilderBase.java

@@ -3,6 +3,7 @@
 import com.vladsch.flexmark.util.SharedDataKeys;
 import com.vladsch.flexmark.util.data.*;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import java.util.*;
 
@@ -105,7 +106,13 @@ protected void addExtensionApiPoint(Object apiPoint) {
      * @return builder
      */
     @Override
-    public <D> MutableDataSet set(DataKeyBase<D> key, D value) {
+    public <V> MutableDataSet set(DataKey<V> key, @NotNull V value) {
+        addExtensionApiPoint(key);
+        return super.set(key, value);
+    }
+
+    @Override
+    public <V> MutableDataSet set(NullableDataKey<V> key, @Nullable V value) {
         addExtensionApiPoint(key);
         return super.set(key, value);
     }

flexmark-util/src/main/java/com/vladsch/flexmark/util/data/DataKey.java

@@ -22,8 +22,8 @@ public DataKey(@NotNull String name, @NotNull T defaultValue, @NotNull DataNotNu
      * <p>
      * Use this constructor to ensure that factory is never called with null data holder value
      *
-     * @param name         See {@link #getName()}.
-     * @param supplier     data value factory for creating a new default value for the key not dependent on dataHolder
+     * @param name     See {@link #getName()}.
+     * @param supplier data value factory for creating a new default value for the key not dependent on dataHolder
      */
     public DataKey(@NotNull String name, @NotNull NotNullValueSupplier<T> supplier) {
         super(name, supplier.get(), (holder) -> supplier.get());
@@ -66,9 +66,9 @@ public T get(@Nullable DataHolder holder) {
         return super.get(holder);
     }
 
-    @NotNull
-    public MutableDataHolder set(@NotNull MutableDataHolder holder, @NotNull T value) {
-        return super.set(holder, value);
+    @Override
+    public @NotNull MutableDataHolder set(@NotNull MutableDataHolder dataHolder, @NotNull T value) {
+        return dataHolder.set(this, value);
     }
 
     @Override

flexmark-util/src/main/java/com/vladsch/flexmark/util/data/DataKeyBase.java

@@ -3,7 +3,7 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
-public abstract class DataKeyBase<T> {
+public abstract class DataKeyBase<T> implements MutableDataValueSetter<T> {
     private final @NotNull String name;
     private final @NotNull DataValueFactory<T> factory;
     private final T defaultValue;
@@ -73,12 +73,6 @@ final public T getFrom(@Nullable DataHolder holder) {
         return get(holder);
     }
 
-    @NotNull
-    public MutableDataHolder set(@NotNull MutableDataHolder holder, T value) {
-        holder.set(this, value);
-        return holder;
-    }
-
     @Override
     public String toString() {
         if (defaultValue != null) {

flexmark-util/src/main/java/com/vladsch/flexmark/util/data/MutableDataHolder.java

@@ -1,6 +1,7 @@
 package com.vladsch.flexmark.util.data;
 
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 public interface MutableDataHolder extends DataHolder, MutableDataSetter {
     /**
@@ -27,7 +28,17 @@ default <T> T get(@NotNull DataKey<T> key) {
      * @param value value to store
      * @return mutable data holder for chained calls
      */
-    <T> MutableDataHolder set(DataKeyBase<T> key, T value);
+     <T> MutableDataHolder set(DataKey<T> key, @NotNull T value);
+
+    /**
+     * Store the given value for the key
+     *
+     * @param <T>   data type of the data referred by the key
+     * @param key   data key
+     * @param value value to store
+     * @return mutable data holder for chained calls
+     */
+    <T> MutableDataHolder set(NullableDataKey<T> key, @Nullable T value);
 
     /**
      * Remove the stored value for the key, used to force to default or to force recompute

flexmark-util/src/main/java/com/vladsch/flexmark/util/data/MutableDataSet.java

@@ -13,7 +13,16 @@ public MutableDataSet(DataHolder other) {
     }
 
     @Override
-    public <T> MutableDataSet set(DataKeyBase<T> key, T value) {
+    public <T> MutableDataSet set(DataKey<T> key, @NotNull T value) {
+        return set((DataKeyBase<T>) key, value);
+    }
+
+    @Override
+    public <T> MutableDataSet set(NullableDataKey<T> key, @Nullable T value) {
+        return set((DataKeyBase<T>) key, value);
+    }
+
+    private <T> MutableDataSet set(DataKeyBase<T> key, T value) {
         dataSet.put(key, value);
         return this;
     }
@@ -26,7 +35,6 @@ public MutableDataSet setFrom(MutableDataSetter dataSetter) {
 
     @Override
     public MutableDataSet setAll(DataHolder other) {
-        DataSet original = new DataSet(this); //keep a copy in case we have aggregateAction keys which other also has
         dataSet.putAll(other.getAll());
         return this;
     }

flexmark-util/src/main/java/com/vladsch/flexmark/util/data/MutableDataValueSetter.java

@@ -0,0 +1,7 @@
+package com.vladsch.flexmark.util.data;
+
+import org.jetbrains.annotations.NotNull;
+
+public interface MutableDataValueSetter<T> {
+    @NotNull MutableDataHolder set(@NotNull MutableDataHolder dataHolder, T value);
+}

flexmark-util/src/main/java/com/vladsch/flexmark/util/data/NullableDataKey.java

@@ -83,9 +83,9 @@ public T get(@Nullable DataHolder holder) {
         return super.get(holder);
     }
 
-    @NotNull
-    public MutableDataHolder set(@NotNull MutableDataHolder holder, @Nullable T value) {
-        return super.set(holder, value);
+    @Override
+    public @NotNull MutableDataHolder set(@NotNull MutableDataHolder dataHolder, @Nullable T value) {
+        return dataHolder.set(this, value);
     }
 
     @Override