Align snapshot/1.0.11 with version/1.0.11 (#22)

* 🔧 Enhance null safety and add utility methods in settings and utils classes

* ✏️ Mark methods as deprecated

* 🐞 Add null check to AsyncRequest constructor

* Update versioning scheme to include build number for snapshot releases (#13)

* 👌 Refactor FileUtils, MathUtils, and RandomUtils for improved functionality and clarity

* Align version/1.0.11 with dev (#18)

* Update versioning scheme to include build number for snapshot releases

* Update issue templates (#16)

* Update issue templates (#17)

* Align version/1.0.11 with dev (#19)

* Update versioning scheme to include build number for snapshot releases

* Update issue templates (#16)

* Update issue templates (#17)

* Align version/1.0.11 with main (#20)

* Update issue templates (#16)

* Update issue templates (#17)

Author: DevPieter

gradle.properties

@@ -7,6 +7,6 @@ loader_version=0.16.10
 
 # Mod Properties
 artifact_id=utilize
-mod_version=1.0.10
+mod_version=1.0.11
 maven_group=nl.devpieter
 archives_base_name=Utilize

src/main/java/nl/devpieter/utilize/Utilize.java

@@ -20,6 +20,8 @@
 public class Utilize implements ClientModInitializer {
 
     private static final ModContainer MOD_CONTAINER = FabricLoader.getInstance().getModContainer("utilize").orElseThrow();
+
+    @Deprecated(since = "1.0.11", forRemoval = true)
     public static final Logger LOGGER = LoggerFactory.getLogger("Utilize");
 
     private static boolean BLOCK_SWING_HAND_ONCE = false;
@@ -36,22 +38,27 @@ public void onInitializeClient() {
         LOGGER.info("Utilize is running in a development environment.");
     }
 
+    @Deprecated(since = "1.0.11", forRemoval = true)
     public static boolean shouldBlockSwingHandOnce() {
         return BLOCK_SWING_HAND_ONCE;
     }
 
+    @Deprecated(since = "1.0.11", forRemoval = true)
     public static void blockSwingHandOnce() {
         BLOCK_SWING_HAND_ONCE = true;
     }
 
+    @Deprecated(since = "1.0.11", forRemoval = true)
     public static void blockedSwingHandOnce() {
         BLOCK_SWING_HAND_ONCE = false;
     }
 
+    @Deprecated(since = "1.0.11, refactor", forRemoval = true)
     public static boolean shouldBlockScreenId(int screenId) {
         return BLOCK_SCREEN_IDS.contains(screenId);
     }
 
+    @Deprecated(since = "1.0.11, refactor", forRemoval = true)
     public static void blockScreenId(int screenId) {
         if (BLOCK_SCREEN_IDS.contains(screenId)) return;
         BLOCK_SCREEN_IDS.add(screenId);
@@ -68,6 +75,7 @@ public static void blockScreenId(int screenId) {
         });
     }
 
+    @Deprecated(since = "1.0.11, refactor", forRemoval = true)
     public static void blockedScreenId(int screenId) {
         BLOCK_SCREEN_IDS.removeIf(id -> id == screenId);
     }

src/main/java/nl/devpieter/utilize/http/AsyncRequest.java

@@ -21,6 +21,7 @@ public AsyncRequest() {
     }
 
     public AsyncRequest(@Nullable ResultConsumer<T> requestCallback) {
+        if (requestCallback == null) return;
         this.callbacks.add(requestCallback);
     }
 

src/main/java/nl/devpieter/utilize/mixins/ChatHudMixin.java

@@ -37,7 +37,6 @@ public abstract class ChatHudMixin {
 
     @Inject(at = @At("HEAD"), method = "addMessage(Lnet/minecraft/text/Text;Lnet/minecraft/network/message/MessageSignatureData;Lnet/minecraft/client/gui/hud/MessageIndicator;)V", cancellable = true)
     public void onAddMessage(Text message, MessageSignatureData signatureData, MessageIndicator indicator, CallbackInfo ci) {
-
         ReceiveMessageEvent event = new ReceiveMessageEvent(message);
         Text result = this.sees.callWithResult(event);
 

src/main/java/nl/devpieter/utilize/setting/SettingManager.java

@@ -5,6 +5,7 @@
 import com.google.gson.reflect.TypeToken;
 import nl.devpieter.utilize.Utilize;
 import nl.devpieter.utilize.setting.interfaces.ISetting;
+import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 import java.io.*;
@@ -60,7 +61,7 @@ public void tick() {
         });
     }
 
-    public boolean queueSave(File file, ISetting<?> setting) {
+    public boolean queueSave(@NotNull File file, @NotNull ISetting<?> setting) {
         String path = file.getAbsolutePath();
         KeyedSetting<?> keyedSetting = setting.asKeyedSetting();
 
@@ -72,11 +73,11 @@ public boolean queueSave(File file, ISetting<?> setting) {
         return true;
     }
 
-    public boolean queueSave(File file, List<ISetting<?>> settings) {
+    public boolean queueSave(@NotNull File file, @NotNull List<ISetting<?>> settings) {
         boolean success = true;
 
         for (ISetting<?> setting : settings) {
-            if (!queueSave(file, setting)) success = false;
+            if (!this.queueSave(file, setting)) success = false;
         }
 
         return success;
@@ -99,19 +100,18 @@ public void forceSaveQueue() {
         this.saveQueue.clear();
     }
 
-    public <T> boolean loadSetting(File file, ISetting<T> setting) {
+    public <T> boolean loadSetting(@NotNull File file, @NotNull ISetting<T> setting) {
         List<KeyedSetting<?>> batch = this.readBatchFromFile(file);
-        return loadSettingFromBatch(setting, batch);
+        return this.loadSettingFromBatch(setting, batch);
     }
 
-    public boolean loadSettings(File file, List<ISetting<?>> settings) {
+    public boolean loadSettings(@NotNull File file, @NotNull List<ISetting<?>> settings) {
         List<KeyedSetting<?>> batch = this.readBatchFromFile(file);
-        for (ISetting<?> setting : settings) loadSettingFromBatch(setting, batch);
-
+        for (ISetting<?> setting : settings) this.loadSettingFromBatch(setting, batch);
         return true;
     }
 
-    private <T> boolean loadSettingFromBatch(ISetting<T> setting, List<KeyedSetting<?>> batch) {
+    private <T> boolean loadSettingFromBatch(@NotNull ISetting<T> setting, @Nullable List<KeyedSetting<?>> batch) {
         if (batch == null || batch.isEmpty()) {
             setting.setValue(setting.getDefault());
             return true;
@@ -120,7 +120,7 @@ private <T> boolean loadSettingFromBatch(ISetting<T> setting, List<KeyedSetting<
         for (KeyedSetting<?> keyedSetting : batch) {
             if (!keyedSetting.key().equals(setting.getIdentifier())) continue;
 
-            JsonElement jsonElement = gson.toJsonTree(keyedSetting.value());
+            JsonElement jsonElement = this.gson.toJsonTree(keyedSetting.value());
             T value = this.gson.fromJson(jsonElement, setting.getType());
 
             setting.setValue(setting.shouldAllowNull() ? value : value != null ? value : setting.getDefault());
@@ -131,7 +131,7 @@ private <T> boolean loadSettingFromBatch(ISetting<T> setting, List<KeyedSetting<
         return false;
     }
 
-    private boolean saveBatchToFile(File file, List<KeyedSetting<?>> settings) {
+    private boolean saveBatchToFile(@NotNull File file, @NotNull List<KeyedSetting<?>> settings) {
         List<KeyedSetting<?>> currentSettings = this.readBatchFromFile(file);
         if (currentSettings == null) currentSettings = new ArrayList<>();
 
@@ -155,7 +155,7 @@ private boolean saveBatchToFile(File file, List<KeyedSetting<?>> settings) {
         }
     }
 
-    private @Nullable List<KeyedSetting<?>> readBatchFromFile(File file) {
+    private @Nullable List<KeyedSetting<?>> readBatchFromFile(@NotNull File file) {
         try (Reader reader = new FileReader(file)) {
             return this.gson.fromJson(reader, new TypeToken<List<KeyedSetting<?>>>() {
             }.getType());

src/main/java/nl/devpieter/utilize/setting/base/SettingBase.java

@@ -1,6 +1,7 @@
 package nl.devpieter.utilize.setting.base;
 
 import nl.devpieter.utilize.setting.interfaces.ISetting;
+import org.jetbrains.annotations.NotNull;
 
 public abstract class SettingBase<T> implements ISetting<T> {
 
@@ -11,11 +12,11 @@ public abstract class SettingBase<T> implements ISetting<T> {
 
     private T value;
 
-    public SettingBase(String identifier, T defaultValue) {
+    public SettingBase(@NotNull String identifier, T defaultValue) {
         this(identifier, defaultValue, false);
     }
 
-    public SettingBase(String identifier, T defaultValue, boolean allowNull) {
+    public SettingBase(@NotNull String identifier, T defaultValue, boolean allowNull) {
         this.identifier = identifier;
         this.defaultValue = defaultValue;
         this.value = defaultValue;
@@ -24,22 +25,22 @@ public SettingBase(String identifier, T defaultValue, boolean allowNull) {
 
     @Override
     public String getIdentifier() {
-        return identifier;
+        return this.identifier;
     }
 
     @Override
     public boolean shouldAllowNull() {
-        return allowNull;
+        return this.allowNull;
     }
 
     @Override
     public T getValue() {
-        return value;
+        return this.value;
     }
 
     @Override
     public T getDefault() {
-        return defaultValue;
+        return this.defaultValue;
     }
 
     @Override

src/main/java/nl/devpieter/utilize/setting/settings/BooleanSetting.java

@@ -2,19 +2,21 @@
 
 import nl.devpieter.utilize.setting.base.SettingBase;
 import nl.devpieter.utilize.setting.interfaces.IBooleanSetting;
+import org.jetbrains.annotations.NotNull;
 
 public class BooleanSetting extends SettingBase<Boolean> implements IBooleanSetting {
 
-    public BooleanSetting(String identifier, Boolean defaultValue) {
+    public BooleanSetting(@NotNull String identifier, Boolean defaultValue) {
         super(identifier, defaultValue);
     }
 
-    public BooleanSetting(String identifier, Boolean defaultValue, boolean allowNull) {
+    public BooleanSetting(@NotNull String identifier, Boolean defaultValue, boolean allowNull) {
         super(identifier, defaultValue, allowNull);
     }
 
     @Override
     public void toggle() {
+        if (this.getValue() == null) throw new IllegalStateException("Cannot toggle a null value. Use setValue() instead.");
         this.setValue(!this.getValue());
     }
 

src/main/java/nl/devpieter/utilize/setting/settings/FloatSetting.java

@@ -2,37 +2,49 @@
 
 import nl.devpieter.utilize.setting.base.SettingBase;
 import nl.devpieter.utilize.setting.interfaces.INumberSetting;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import java.lang.reflect.Type;
 
 public class FloatSetting extends SettingBase<Float> implements INumberSetting<Float> {
 
-    public FloatSetting(String identifier, Float defaultValue) {
+    public FloatSetting(@NotNull String identifier, Float defaultValue) {
         super(identifier, defaultValue);
     }
 
-    public FloatSetting(String identifier, Float defaultValue, boolean allowNull) {
+    public FloatSetting(@NotNull String identifier, Float defaultValue, boolean allowNull) {
         super(identifier, defaultValue, allowNull);
     }
 
     @Override
     public void increment() {
+        if (this.getValue() == null) throw new IllegalStateException("Cannot increment a null value. Use setValue() instead.");
         this.setValue(this.getValue() + 1.0F);
     }
 
     @Override
-    public void increment(Float amount) {
-        this.setValue(this.getValue() + amount);
+    public void increment(@Nullable Float amount) {
+        if (amount == null && !this.shouldAllowNull()) throw new IllegalArgumentException("Amount cannot be null");
+
+        if (amount == null) this.setValue(0.0F);
+        else if (this.getValue() == null) this.setValue(amount);
+        else this.setValue(this.getValue() + amount);
     }
 
     @Override
     public void decrement() {
+        if (this.getValue() == null) throw new IllegalStateException("Cannot decrement a null value. Use setValue() instead.");
         this.setValue(this.getValue() - 1.0F);
     }
 
     @Override
-    public void decrement(Float amount) {
-        this.setValue(this.getValue() - amount);
+    public void decrement(@Nullable Float amount) {
+        if (amount == null && !this.shouldAllowNull()) throw new IllegalArgumentException("Amount cannot be null");
+
+        if (amount == null) this.setValue(0.0F);
+        else if (this.getValue() == null) this.setValue(-amount);
+        else this.setValue(this.getValue() - amount);
     }
 
     @Override

src/main/java/nl/devpieter/utilize/setting/settings/IntSetting.java

@@ -2,37 +2,49 @@
 
 import nl.devpieter.utilize.setting.base.SettingBase;
 import nl.devpieter.utilize.setting.interfaces.INumberSetting;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import java.lang.reflect.Type;
 
 public class IntSetting extends SettingBase<Integer> implements INumberSetting<Integer> {
 
-    public IntSetting(String identifier, Integer defaultValue) {
+    public IntSetting(@NotNull String identifier, Integer defaultValue) {
         super(identifier, defaultValue);
     }
 
-    public IntSetting(String identifier, Integer defaultValue, boolean allowNull) {
+    public IntSetting(@NotNull String identifier, Integer defaultValue, boolean allowNull) {
         super(identifier, defaultValue, allowNull);
     }
 
     @Override
     public void increment() {
+        if (this.getValue() == null) throw new IllegalStateException("Cannot increment a null value. Use setValue() instead.");
         this.setValue(this.getValue() + 1);
     }
 
     @Override
-    public void increment(Integer amount) {
-        this.setValue(this.getValue() + amount);
+    public void increment(@Nullable Integer amount) {
+        if (amount == null && !this.shouldAllowNull()) throw new IllegalArgumentException("Amount cannot be null");
+
+        if (amount == null) this.setValue(0);
+        else if (this.getValue() == null) this.setValue(amount);
+        else this.setValue(this.getValue() + amount);
     }
 
     @Override
     public void decrement() {
+        if (this.getValue() == null) throw new IllegalStateException("Cannot decrement a null value. Use setValue() instead.");
         this.setValue(this.getValue() - 1);
     }
 
     @Override
-    public void decrement(Integer amount) {
-        this.setValue(this.getValue() - amount);
+    public void decrement(@Nullable Integer amount) {
+        if (amount == null && !this.shouldAllowNull()) throw new IllegalArgumentException("Amount cannot be null");
+
+        if (amount == null) this.setValue(0);
+        else if (this.getValue() == null) this.setValue(-amount);
+        else this.setValue(this.getValue() - amount);
     }
 
     @Override

src/main/java/nl/devpieter/utilize/setting/settings/ListSetting.java

@@ -19,36 +19,49 @@ public ListSetting(String identifier, List<T> defaultValue, boolean allowNull) {
 
     @Override
     public boolean contains(T value) {
+        if (this.getValue() == null) return false;
         return this.getValue().contains(value);
     }
 
     @Override
     public void add(T value) {
+        if (this.getValue() == null) throw new IllegalStateException("List value is null, cannot add element.");
         this.getValue().add(value);
     }
 
     @Override
     public void remove(T value) {
+        if (this.getValue() == null) throw new IllegalStateException("List value is null, cannot remove element.");
         this.getValue().remove(value);
     }
 
     @Override
     public void removeAt(int index) {
+        if (this.getValue() == null) throw new IllegalStateException("List value is null, cannot remove element at index.");
+        if (index < 0 || index >= this.getValue().size()) throw new IndexOutOfBoundsException("Index out of bounds for list.");
+
         this.getValue().remove(index);
     }
 
     @Override
     public void removeFirst() {
+        if (this.getValue() == null) throw new IllegalStateException("List value is null, cannot remove first element.");
+        if (this.getValue().isEmpty()) throw new IllegalStateException("List is empty, cannot remove first element.");
+
         this.getValue().removeFirst();
     }
 
     @Override
     public void removeLast() {
+        if (this.getValue() == null) throw new IllegalStateException("List value is null, cannot remove last element.");
+        if (this.getValue().isEmpty()) throw new IllegalStateException("List is empty, cannot remove last element.");
+
         this.getValue().removeLast();
     }
 
     @Override
     public void clear() {
+        if (this.getValue() == null) throw new IllegalStateException("List value is null, cannot clear.");
         this.getValue().clear();
     }