feat: marked BranchUtil#getResult as deprecated and for removal in future releases

This commit is contained in:
siujamo
2025-05-22 11:52:51 +08:00
parent 0642bd836e
commit 48714e599a
@@ -137,14 +137,14 @@ public final class BranchUtil {
* on the result. * on the result.
* <p> * <p>
* If the result is {@code true}, the {@code trueHandler} is executed. If the result is * If the result is {@code true}, the {@code trueHandler} is executed. If the result is
* {@code false} and an {@code elseHandler} is provided, it is executed. * {@code false} and an {@code falseSupplier} is provided, it is executed.
* <p> * <p>
* Returns the result of the executed handler. * Returns the result of the executed handler.
* *
* @param <T> the type of the result to be handled by the methods * @param <T> the type of the result to be handled by the methods
* @param trueHandler the handler to be executed if the result is {@code true} * @param trueHandler the handler to be executed if the result is {@code true}
* @param falseSupplier the handler to be executed if the result is {@code false} (optional) * @param falseSupplier 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 * @return the result of the executed handler, or {@code null} if no {@code falseSupplier} is
* provided and the result of the evaluation is {@code false} * provided and the result of the evaluation is {@code false}
*/ */
public <T> T thenSupply(Supplier<T> trueHandler, Supplier<T> falseSupplier) { public <T> T thenSupply(Supplier<T> trueHandler, Supplier<T> falseSupplier) {
@@ -167,8 +167,7 @@ public final class BranchUtil {
* *
* @param <T> the type of the result to be handled by the methods * @param <T> the type of the result to be handled by the methods
* @param trueSupplier the handler to be executed if the result is {@code true} * @param trueSupplier 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 * @return the result of the executed handler, or {@code null} if result of evaluation is {@code false}
* {@code false}
*/ */
public <T> T thenSupply(Supplier<T> trueSupplier) { public <T> T thenSupply(Supplier<T> trueSupplier) {
return thenSupply(trueSupplier, null); return thenSupply(trueSupplier, null);
@@ -207,4 +206,18 @@ public final class BranchUtil {
then(trueHandler, null); then(trueHandler, null);
} }
/**
* 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.
*
* @see BoolUtil
* @return the result
*/
@Deprecated(forRemoval = true)
public boolean getResult() {
return result;
}
} }