Merge pull request #61 from onixbyte/feature/optimised-generic-type

feat: refactor BranchUtil<T> to BranchUtil

Author: siujamo

devkit-utils/src/main/java/com/onixbyte/devkit/utils/BranchUtil.java

@@ -17,9 +17,6 @@
 
 package com.onixbyte.devkit.utils;
 
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 import java.util.Objects;
 import java.util.function.BooleanSupplier;
 import java.util.function.Supplier;
@@ -66,17 +63,19 @@
  * The {@link #and(Boolean...)} and {@link #or(Boolean...)} methods accept any number of boolean
  * expressions.
  *
- * @param <T> the type of the result to be handled by the methods
  * @author zihluwang
- * @version 1.6.1
+ * @version 2.1.3
  * @see java.util.function.Supplier
  * @see java.util.function.BooleanSupplier
  * @see java.lang.Runnable
  * @since 1.0.0
  */
-public final class BranchUtil<T> {
+public final class BranchUtil {
 
-    private final static Logger log = LoggerFactory.getLogger(BranchUtil.class);
+    /**
+     * The final result of the boolean expression.
+     */
+    private final boolean result;
 
     /**
      * Create a {@code BranchUtil} instance.
@@ -92,75 +91,72 @@ private BranchUtil(boolean result) {
      * boolean expressions.
      *
      * @param values the boolean expressions to be evaluated
-     * @param <T>    the type of the result to be handled by the methods
      * @return a {@code BranchUtil} instance representing the result of the logical OR operation
      */
-    public static <T> BranchUtil<T> or(Boolean... values) {
-        return new BranchUtil<>(BoolUtil.or(values));
+    public static BranchUtil or(Boolean... values) {
+        return new BranchUtil(BoolUtil.or(values));
     }
 
     /**
      * Creates a {@code BranchUtil} instance to evaluate a logical AND operation on the provided
      * boolean expressions.
      *
      * @param values the boolean expressions to be evaluated
-     * @param <T>    the type of the result to be handled by the methods
      * @return a {@code BranchUtil} instance representing the result of the logical AND operation
      */
-    public static <T> BranchUtil<T> and(Boolean... values) {
-        return new BranchUtil<>(BoolUtil.and(values));
+    public static BranchUtil and(Boolean... values) {
+        return new BranchUtil(BoolUtil.and(values));
     }
 
     /**
      * Creates a {@code BranchUtil} instance to evaluate a logical OR operation on the provided
      * boolean suppliers.
      *
      * @param valueSuppliers the boolean suppliers to be evaluated
-     * @param <T>            the type of the result to be handled by the methods
      * @return a {@code BranchUtil} instance representing the result of the
      * logical OR operation
      */
-    public static <T> BranchUtil<T> or(BooleanSupplier... valueSuppliers) {
-        return new BranchUtil<>(BoolUtil.or(valueSuppliers));
+    public static BranchUtil or(BooleanSupplier... valueSuppliers) {
+        return new BranchUtil(BoolUtil.or(valueSuppliers));
     }
 
     /**
      * Creates a {@code BranchUtil} instance to evaluate a logical AND operation on the provided
      * boolean suppliers.
      *
      * @param valueSuppliers the boolean suppliers to be evaluated
-     * @param <T>            the type of the result to be handled by the methods
      * @return a {@code BranchUtil} instance representing the result of the
      * logical AND operation
      */
-    public static <T> BranchUtil<T> and(BooleanSupplier... valueSuppliers) {
-        return new BranchUtil<>(BoolUtil.and(valueSuppliers));
+    public static BranchUtil and(BooleanSupplier... valueSuppliers) {
+        return new BranchUtil(BoolUtil.and(valueSuppliers));
     }
 
     /**
      * Handles the result of the boolean expressions by executing the appropriate handler based
      * on the result.
      * <p>
-     * If the result is {@code true}, the {@code ifHandler} is executed. If the result is
-     * {@code false} and an {@code elseHandler} is provided, it is executed.
+     * If the result is {@code true}, the {@code trueSupplier} is executed. If the result is
+     * {@code false} and an {@code falseSupplier} is provided, it is executed.
      * <p>
-     * Returns the result of the executed handler.
+     * Returns the result of the executed supplier.
      *
-     * @param ifHandler   the handler to be executed if the result is {@code true}
-     * @param elseHandler the handler to be executed if the result is {@code false} (optional)
-     * @return the result of the executed handler, or {@code null} if no {@code elseHandler} is
+     * @param <T>           the type of the result to be handled by the methods
+     * @param trueSupplier  the supplier to be executed if the result is {@code true}
+     * @param falseSupplier the supplier to be executed if the result is {@code false} (optional)
+     * @return the result of the executed supplier, or {@code null} if no {@code falseSupplier} is
      * provided and the result of the evaluation is {@code false}
      */
-    public T handle(Supplier<T> ifHandler, Supplier<T> elseHandler) {
-        if (this.result && Objects.nonNull(ifHandler)) {
-            return ifHandler.get();
+    public <T> T thenSupply(Supplier<T> trueSupplier, Supplier<T> falseSupplier) {
+        if (this.result && Objects.nonNull(trueSupplier)) {
+            return trueSupplier.get();
         }
 
-        if (Objects.isNull(elseHandler)) {
+        if (Objects.isNull(falseSupplier)) {
             return null;
         }
 
-        return elseHandler.get();
+        return falseSupplier.get();
     }
 
     /**
@@ -169,12 +165,12 @@ public T handle(Supplier<T> ifHandler, Supplier<T> elseHandler) {
      * <p>
      * Returns the result of the executed handler.
      *
-     * @param ifHandler the handler to be executed if the result is {@code true}
-     * @return the result of the executed handler, or {@code null} if result of evaluation is
-     * {@code false}
+     * @param <T>          the type of the result to be handled by the methods
+     * @param trueSupplier the supplier to be executed if the result is {@code true}
+     * @return the result of the executed handler, or {@code null} if result of evaluation is {@code false}
      */
-    public T handle(Supplier<T> ifHandler) {
-        return handle(ifHandler, null);
+    public <T> T thenSupply(Supplier<T> trueSupplier) {
+        return thenSupply(trueSupplier, null);
     }
 
     /**
@@ -184,42 +180,42 @@ public T handle(Supplier<T> ifHandler) {
      * If the result is {@code true}, the {@code ifHandler} is executed. If the result is
      * {@code false} and an {@code elseHandler} is provided, it is executed.
      *
-     * @param ifHandler   the handler to be executed if the result is {@code true}
-     * @param elseHandler the handler to be executed if the result is {@code false} (optional)
+     * @param trueHandler  the handler to be executed if the result is {@code true}
+     * @param falseHandler the handler to be executed if the result is {@code false} (optional)
      */
-    public void handle(Runnable ifHandler, Runnable elseHandler) {
-        if (this.result && Objects.nonNull(ifHandler)) {
-            ifHandler.run();
+    public void then(Runnable trueHandler, Runnable falseHandler) {
+        if (this.result && Objects.nonNull(trueHandler)) {
+            trueHandler.run();
             return;
         }
 
-        if (Objects.isNull(elseHandler)) {
+        if (Objects.isNull(falseHandler)) {
             return;
         }
 
-        elseHandler.run();
+        falseHandler.run();
     }
 
     /**
      * Handles the result of the boolean expressions by executing the provided handler if the
      * result is {@code true}.
      *
-     * @param ifHandler the handler to be executed if the result is {@code true}
+     * @param trueHandler the handler to be executed if the result is {@code true}
      */
-    public void handle(Runnable ifHandler) {
-        handle(ifHandler, null);
+    public void then(Runnable trueHandler) {
+        then(trueHandler, null);
     }
 
-    /**
-     * The final result of the boolean expression.
-     */
-    private final boolean result;
-
     /**
      * Get the boolean result.
+     * <p>
+     * <b>Note:</b> {@link BranchUtil} is not responsible for getting a raw boolean result, consider use
+     * {@link BoolUtil} to replace.
      *
      * @return the result
+     * @see BoolUtil
      */
+    @Deprecated(forRemoval = true)
     public boolean getResult() {
         return result;
     }