#318 Remove/add some NotNull pertaining to property values

- ConfigMe doesn't provide null values for properties by default, but is somewhat "agnostic" at allowing other property implementations doing so. This is difficult to represent with the annotations, so some have been replaced by a comment "PV" (for property value) that should always be not null by default, but we cannot technically guarantee it.
AuthMe · Jun 20, 2023 · 4c35833 · 4c35833
1 parent 00f0724
commit 4c35833
Show file tree

Hide file tree

Showing 14 changed files with 36 additions and 22 deletions.
diff --git a/src/main/java/ch/jalu/configme/SettingsManager.java b/src/main/java/ch/jalu/configme/SettingsManager.java
@@ -26,7 +26,7 @@ public interface SettingsManager {
      * @param <T> The property's type
      * @return The property's value
      */
-    <T> T getProperty(@NotNull Property<T> property);
+    <T> /* PV */ T getProperty(@NotNull Property<T> property);
 
     /**
      * Sets a new value for the given property.
@@ -35,7 +35,7 @@ public interface SettingsManager {
      * @param value The new value to assign to the property
      * @param <T> The property's type
      */
-    <T> void setProperty(@NotNull Property<T> property, @NotNull T value);
+    <T> void setProperty(@NotNull Property<T> property, /* PV */ T value);
 
     /**
      * Reloads the configuration.

diff --git a/src/main/java/ch/jalu/configme/SettingsManagerImpl.java b/src/main/java/ch/jalu/configme/SettingsManagerImpl.java
@@ -54,7 +54,7 @@ protected SettingsManagerImpl(@NotNull PropertyResource resource, @NotNull Confi
      * @return the property's value
      */
     @Override
-    public <T> T getProperty(@NotNull Property<T> property) {
+    public <T> @NotNull T getProperty(@NotNull Property<T> property) {
         return configurationData.getValue(property);
     }
 
@@ -66,7 +66,7 @@ public <T> T getProperty(@NotNull Property<T> property) {
      * @param <T> the property's type
      */
     @Override
-    public <T> void setProperty(@NotNull Property<T> property, @NotNull T value) {
+    public <T> void setProperty(@NotNull Property<T> property, /* PV */ T value) {
         configurationData.setValue(property, value);
     }
 

diff --git a/src/main/java/ch/jalu/configme/configurationdata/ConfigurationData.java b/src/main/java/ch/jalu/configme/configurationdata/ConfigurationData.java
@@ -64,7 +64,7 @@ public interface ConfigurationData {
      * @param <T> property type
      * @return value associated with the property, or null if not present
      */
-    <T> @Nullable T getValue(@NotNull Property<T> property);
+    <T> /* PV */ T getValue(@NotNull Property<T> property);
 
     /**
      * Sets the given value for the given property. May throw an exception
@@ -74,7 +74,7 @@ public interface ConfigurationData {
      * @param value the value to set
      * @param <T> the property type
      */
-    <T> void setValue(@NotNull Property<T> property, @NotNull T value);
+    <T> void setValue(@NotNull Property<T> property, /* PV */ T value);
 
     /**
      * Returns if the last call of {@link #initializeValues} had fully valid values in the resource

diff --git a/src/main/java/ch/jalu/configme/configurationdata/ConfigurationDataImpl.java b/src/main/java/ch/jalu/configme/configurationdata/ConfigurationDataImpl.java
@@ -54,7 +54,7 @@ protected ConfigurationDataImpl(@NotNull List<? extends Property<?>> allProperti
 
     @Override
     @SuppressWarnings("unchecked")
-    public <T> T getValue(@NotNull Property<T> property) {
+    public <T> @NotNull T getValue(@NotNull Property<T> property) {
         Object value = values.get(property.getPath());
         if (value == null) {
             throw new ConfigMeException(format("No value exists for property with path '%s'. This may happen if "
@@ -65,7 +65,7 @@ public <T> T getValue(@NotNull Property<T> property) {
     }
 
     @Override
-    public <T> void setValue(@NotNull Property<T> property, @NotNull T value) {
+    public <T> void setValue(@NotNull Property<T> property, /* PV */ T value) {
         if (property.isValidValue(value)) {
             values.put(property.getPath(), value);
         } else {

diff --git a/src/main/java/ch/jalu/configme/properties/BaseProperty.java b/src/main/java/ch/jalu/configme/properties/BaseProperty.java
@@ -59,6 +59,14 @@ public boolean isValidValue(@Nullable T value) {
         return value != null;
     }
 
+    /*
+     * Overridden to set the param as @NotNull. If the value from #determineValue is not null and #isValidValue rejects
+     * nulls, it is guaranteed that this method will never be called with a null value.
+     */
+    @Override
+    @SuppressWarnings("NullableProblems")
+    public abstract @Nullable Object toExportValue(@NotNull T value);
+
     /**
      * Constructs the value of the property from the property reader. Returns null if no value is
      * available in the reader or if it cannot be used to construct a value for this property.

diff --git a/src/main/java/ch/jalu/configme/properties/InlineArrayProperty.java b/src/main/java/ch/jalu/configme/properties/InlineArrayProperty.java
@@ -40,7 +40,7 @@ public InlineArrayProperty(@NotNull String path, T @NotNull [] defaultValue,
     }
 
     @Override
-    public Object toExportValue(T[] value) {
+    public Object toExportValue(T @NotNull [] value) {
         return inlineConverter.toExportValue(value);
     }
 }
diff --git a/src/main/java/ch/jalu/configme/properties/Property.java b/src/main/java/ch/jalu/configme/properties/Property.java
@@ -52,7 +52,7 @@ default boolean isValidInResource(@NotNull PropertyReader propertyReader) {
      *
      * @return the default value
      */
-    @NotNull T getDefaultValue();
+    @Nullable T getDefaultValue();
 
     /**
      * Returns whether the value can be associated to the given property, i.e. whether it fulfills all

diff --git a/src/main/java/ch/jalu/configme/properties/TypeBasedProperty.java b/src/main/java/ch/jalu/configme/properties/TypeBasedProperty.java
@@ -36,7 +36,7 @@ public TypeBasedProperty(@NotNull String path, @NotNull T defaultValue, @NotNull
     }
 
     @Override
-    public @Nullable Object toExportValue(T value) {
+    public @Nullable Object toExportValue(@NotNull T value) {
         return type.toExportValue(value);
     }
 }
diff --git a/src/main/java/ch/jalu/configme/properties/convertresult/PropertyValue.java b/src/main/java/ch/jalu/configme/properties/convertresult/PropertyValue.java
@@ -2,6 +2,7 @@
 
 import ch.jalu.configme.properties.Property;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 /**
  * Return value of {@link Property#determineValue}. Wraps the value to associate with the property, along with a field
@@ -26,7 +27,7 @@ public class PropertyValue<T> {
      * @param value the value associated with the property
      * @param isValidInResource true if the value in the resource was fully valid
      */
-    public PropertyValue(@NotNull T value, boolean isValidInResource) {
+    public PropertyValue(/* PV */ T value, boolean isValidInResource) {
         this.value = value;
         this.isValidInResource = isValidInResource;
     }
@@ -38,7 +39,7 @@ public PropertyValue(@NotNull T value, boolean isValidInResource) {
      * @param <T> the value type
      * @return property value with the given value and the valid flag set to true
      */
-    public static <T> @NotNull PropertyValue<T> withValidValue(@NotNull T value) {
+    public static <T> @NotNull PropertyValue<T> withValidValue(/* PV */ T value) {
         return new PropertyValue<>(value, true);
     }
 
@@ -49,14 +50,14 @@ public PropertyValue(@NotNull T value, boolean isValidInResource) {
      * @param <T> the value type
      * @return property value with the given value and the valid flag set to false
      */
-    public static <T> @NotNull PropertyValue<T> withValueRequiringRewrite(@NotNull T value) {
+    public static <T> @NotNull PropertyValue<T> withValueRequiringRewrite(/* PV */ T value) {
         return new PropertyValue<>(value, false);
     }
 
     /**
      * @return the value to associate with the property
      */
-    public @NotNull T getValue() {
+    public /* PV */ T getValue() {
         return value;
     }
 

diff --git a/src/main/java/ch/jalu/configme/properties/types/PropertyType.java b/src/main/java/ch/jalu/configme/properties/types/PropertyType.java
@@ -29,6 +29,6 @@ public interface PropertyType<T> {
      * @param value the value to convert
      * @return the value to use in the property export
      */
-    @Nullable Object toExportValue(T value);
+    @Nullable Object toExportValue(@Nullable T value);
 
 }
diff --git a/...test/java/ch/jalu/configme/beanmapper/leafvaluehandler/CombiningLeafValueHandlerTest.java b/...test/java/ch/jalu/configme/beanmapper/leafvaluehandler/CombiningLeafValueHandlerTest.java
@@ -1,9 +1,11 @@
 package ch.jalu.configme.beanmapper.leafvaluehandler;
 
+import ch.jalu.configme.properties.types.PrimitivePropertyType;
 import ch.jalu.configme.utils.TypeInformation;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.junit.jupiter.api.Test;
+import org.w3c.dom.TypeInfo;
 
 import java.util.Arrays;
 
@@ -26,9 +28,9 @@ void shouldRespectOrderOfTransformers() {
         CombiningLeafValueHandler result2 = new CombiningLeafValueHandler(Arrays.asList(t1, t2));
 
         // then
-        assertThat(result1.convert(null, null), equalTo("value_1"));
+        assertThat(result1.convert(new TypeInformation(String.class), null), equalTo("value_1"));
         assertThat(result1.toExportValue(null), equalTo("export_1"));
-        assertThat(result2.convert(null, null), equalTo("value_1"));
+        assertThat(result2.convert(new TypeInformation(String.class), null), equalTo("value_1"));
         assertThat(result2.toExportValue(null), equalTo("export_1"));
     }
 
@@ -43,7 +45,7 @@ void shouldGetFirstNonNullResult() {
         CombiningLeafValueHandler result = new CombiningLeafValueHandler(t1, t2, t3);
 
         // then
-        assertThat(result.convert(null, null), equalTo("value_2"));
+        assertThat(result.convert(new TypeInformation(String.class), null), equalTo("value_2"));
         assertThat(result.toExportValue(null), equalTo("export_2"));
     }
 

diff --git a/src/test/java/ch/jalu/configme/properties/BasePropertyTest.java b/src/test/java/ch/jalu/configme/properties/BasePropertyTest.java
@@ -2,6 +2,7 @@
 
 import ch.jalu.configme.properties.convertresult.ConvertErrorRecorder;
 import ch.jalu.configme.resource.PropertyReader;
+import org.jetbrains.annotations.NotNull;
 import org.junit.jupiter.api.Test;
 
 import static ch.jalu.configme.TestUtils.getExceptionTypeForNullArg;
@@ -67,7 +68,7 @@ private static final class PropertyTestImpl extends BaseProperty<Byte> {
         }
 
         @Override
-        protected Byte getFromReader(PropertyReader reader, ConvertErrorRecorder errorRecorder) {
+        protected Byte getFromReader(@NotNull PropertyReader reader, @NotNull ConvertErrorRecorder errorRecorder) {
             Integer value = reader.getInt(getPath());
             return value != null && value >= Byte.MIN_VALUE && value <= Byte.MAX_VALUE
                 ? value.byteValue()

diff --git a/src/test/java/ch/jalu/configme/properties/type/EnumPropertyTypeTest.java b/src/test/java/ch/jalu/configme/properties/type/EnumPropertyTypeTest.java
@@ -21,7 +21,7 @@ void shouldReturnUnknown() {
         EnumPropertyType<TimeUnit> propertyType = new EnumPropertyType<>(TimeUnit.class);
 
         // when
-        TimeUnit result = propertyType.convert("unknown", null);
+        TimeUnit result = propertyType.convert("unknown", new ConvertErrorRecorder());
 
         // then
         assertThat(result, nullValue());

diff --git a/src/test/java/ch/jalu/configme/resource/YamlSetPropertyExportTest.java b/src/test/java/ch/jalu/configme/resource/YamlSetPropertyExportTest.java
@@ -7,6 +7,7 @@
 import ch.jalu.configme.properties.Property;
 import ch.jalu.configme.properties.convertresult.ConvertErrorRecorder;
 import ch.jalu.configme.samples.TestEnum;
+import org.jetbrains.annotations.NotNull;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;
@@ -73,7 +74,8 @@ private static final class EnumSetProperty extends BaseProperty<Set<TestEnum>> {
         }
 
         @Override
-        protected Set<TestEnum> getFromReader(PropertyReader reader, ConvertErrorRecorder errorRecorder) {
+        protected Set<TestEnum> getFromReader(@NotNull PropertyReader reader,
+                                              @NotNull ConvertErrorRecorder errorRecorder) {
             List<?> list = reader.getList(getPath());
             if (list == null) {
                 return null;