Merge pull request #73 from /issues/72

Add support of default value other than null/0 and also fixes #72

Author: boretti

src/main/java/ch/powerunit/extensions/exceptions/BiFunctionWithException.java

@@ -103,15 +103,16 @@ default BiFunction<T, U, Optional<R>> lift() {
 
 	/**
 	 * Converts this {@code BiFunctionWithException} to a lifted {@code BiFunction}
-	 * returning {@code null} in case of exception.
+	 * returning {@code null} (or the value redefined by the method
+	 * {@link #defaultValue()}) in case of exception.
 	 *
 	 * @return the function that ignore error
 	 * @see #ignored(BiFunctionWithException)
 	 * @see BiFunction
 	 */
 	@Override
 	default BiFunction<T, U, R> ignore() {
-		return lift().andThen(o -> o.orElse(null));
+		return lift().andThen(o -> o.orElse(defaultValue()));
 	}
 
 	/**
@@ -309,6 +310,48 @@ static <T, U, R, E extends Exception> BiFunction<T, U, R> ignored(BiFunctionWith
 		return verifyFunction(function).ignore();
 	}
 
+	/**
+	 * Converts a {@code BiFunctionWithException} to a lifted {@code BiFunction}
+	 * returning a default in case of exception.
+	 *
+	 * @param function
+	 *            to be lifted
+	 * @param defaultValue
+	 *            the value to be returned in case of error
+	 * @param <T>
+	 *            the type of the first argument to the function
+	 * @param <U>
+	 *            the type of the second argument to the function
+	 * @param <R>
+	 *            the type of the result of the function
+	 * @param <E>
+	 *            the type of the potential exception
+	 * @return the lifted function
+	 * @see #ignore()
+	 * @see #ignored(BiFunctionWithException)
+	 * @throws NullPointerException
+	 *             if function is null
+	 * @since 3.0.0
+	 */
+	static <T, U, R, E extends Exception> BiFunction<T, U, R> ignored(BiFunctionWithException<T, U, R, E> function,
+			R defaultValue) {
+		verifyFunction(function);
+		return new BiFunctionWithException<T, U, R, E>() {
+
+			@Override
+			public R apply(T t, U u) throws E {
+				return function.apply(t, u);
+			}
+
+			@Override
+			public R defaultValue() {
+				return defaultValue;
+			}
+
+		}.ignore();
+
+	}
+
 	/**
 	 * Convert this {@code BiFunctionWithException} to a lifted {@code BiFunction}
 	 * return {@code CompletionStage} as return value.

src/main/java/ch/powerunit/extensions/exceptions/BiPredicateWithException.java

@@ -51,7 +51,7 @@
  */
 @FunctionalInterface
 public interface BiPredicateWithException<T, U, E extends Exception>
-		extends PrimitiveReturnExceptionHandlerSupport<BiPredicate<T, U>> {
+		extends PrimitiveReturnExceptionHandlerSupport<BiPredicate<T, U>>, BooleanDefaultValue {
 
 	/**
 	 * Evaluates this predicate on the given arguments.
@@ -75,7 +75,7 @@ default BiPredicate<T, U> uncheckOrIgnore(boolean uncheck) {
 				return test(t, u);
 			} catch (Exception e) {
 				PrimitiveReturnExceptionHandlerSupport.handleException(uncheck, e, exceptionMapper());
-				return false;
+				return defaultValue();
 			}
 		};
 	}
@@ -281,4 +281,43 @@ static <T, U, E extends Exception> BiPredicate<T, U> ignored(BiPredicateWithExce
 		return verifyPredicate(predicate).ignore();
 	}
 
+	/**
+	 * Converts a {@code BiPredicateWithException} to a lifted {@code BiPredicate}
+	 * returning a default value in case of exception.
+	 *
+	 * @param predicate
+	 *            to be lifted
+	 * @param defaultValue
+	 *            value in case of exception
+	 * @param <T>
+	 *            the type of the first argument to the predicate
+	 * @param <U>
+	 *            the type of the second argument the predicate
+	 * @param <E>
+	 *            the type of the potential exception
+	 * @return the lifted predicate
+	 * @see #ignore()
+	 * @see #ignored(BiPredicateWithException)
+	 * @throws NullPointerException
+	 *             if predicate is null
+	 * @since 3.0.0
+	 */
+	static <T, U, E extends Exception> BiPredicate<T, U> ignored(BiPredicateWithException<T, U, E> predicate,
+			boolean defaultValue) {
+		verifyPredicate(predicate);
+		return new BiPredicateWithException<T, U, E>() {
+
+			@Override
+			public boolean test(T t, U u) throws E {
+				return predicate.test(t, u);
+			}
+
+			@Override
+			public boolean defaultValue() {
+				return defaultValue;
+			}
+
+		}.ignore();
+	}
+
 }

src/main/java/ch/powerunit/extensions/exceptions/BooleanDefaultValue.java

@@ -0,0 +1,34 @@
+/**
+ * Powerunit - A JDK1.8 test framework
+ * Copyright (C) 2014 Mathieu Boretti.
+ *
+ * This file is part of Powerunit
+ *
+ * Powerunit is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Powerunit is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Powerunit. If not, see <http://www.gnu.org/licenses/>.
+ */
+package ch.powerunit.extensions.exceptions;
+
+interface BooleanDefaultValue {
+
+	/**
+	 * Defines the default value returned by the ignore and ignored method.
+	 *
+	 * @return the default value for the ignore/ignored method.
+	 * @since 3.0.0
+	 */
+	default boolean defaultValue() {
+		return false;
+	}
+
+}

src/main/java/ch/powerunit/extensions/exceptions/BooleanSupplierWithException.java

@@ -45,7 +45,7 @@
  */
 @FunctionalInterface
 public interface BooleanSupplierWithException<E extends Exception>
-		extends PrimitiveReturnExceptionHandlerSupport<BooleanSupplier> {
+		extends PrimitiveReturnExceptionHandlerSupport<BooleanSupplier>, BooleanDefaultValue {
 
 	/**
 	 * Gets a result.
@@ -64,7 +64,7 @@ default BooleanSupplier uncheckOrIgnore(boolean uncheck) {
 				return getAsBoolean();
 			} catch (Exception e) {
 				PrimitiveReturnExceptionHandlerSupport.handleException(uncheck, e, exceptionMapper());
-				return false;
+				return defaultValue();
 			}
 		};
 	}
@@ -172,4 +172,39 @@ static <E extends Exception> BooleanSupplier ignored(BooleanSupplierWithExceptio
 		return verifySupplier(supplier).ignore();
 	}
 
+	/**
+	 * Converts a {@code BooleanSupplierWithException} to a lifted
+	 * {@code BooleanSupplier} returning a default value in case of exception.
+	 *
+	 * @param supplier
+	 *            to be lifted
+	 * @param defaultValue
+	 *            value in case of exception
+	 * @param <E>
+	 *            the type of the potential exception
+	 * @return the lifted supplier
+	 * @see #ignore()
+	 * @see #ignored(BooleanSupplierWithException)
+	 * @throws NullPointerException
+	 *             if supplier is null
+	 * @since 3.0.0
+	 */
+	static <E extends Exception> BooleanSupplier ignored(BooleanSupplierWithException<E> supplier,
+			boolean defaultValue) {
+		verifySupplier(supplier);
+		return new BooleanSupplierWithException<E>() {
+
+			@Override
+			public boolean getAsBoolean() throws E {
+				return supplier.getAsBoolean();
+			}
+
+			@Override
+			public boolean defaultValue() {
+				return defaultValue;
+			}
+
+		}.ignore();
+	}
+
 }

src/main/java/ch/powerunit/extensions/exceptions/CommonsCollections4Helper.java

@@ -19,12 +19,12 @@
  */
 package ch.powerunit.extensions.exceptions;
 
+import static ch.powerunit.extensions.exceptions.Constants.verifyConsumer;
+import static ch.powerunit.extensions.exceptions.Constants.verifyFunction;
+import static ch.powerunit.extensions.exceptions.Constants.verifyPredicate;
 import static ch.powerunit.extensions.exceptions.Constants.verifySupplier;
 import static ch.powerunit.extensions.exceptions.ExceptionMapper.forException;
 import static ch.powerunit.extensions.exceptions.ExceptionMapper.forExceptions;
-import static ch.powerunit.extensions.exceptions.Constants.verifyPredicate;
-import static ch.powerunit.extensions.exceptions.Constants.verifyFunction;
-import static ch.powerunit.extensions.exceptions.Constants.verifyConsumer;
 
 import java.util.function.Function;
 
@@ -42,7 +42,7 @@
  * <p>
  * The mapping between the interface from <i>commons-collections4</i> and this
  * library is the following :
- * 
+ *
  * <table border="1">
  * <caption>Mapping between interfaces</caption>
  * <tr>
@@ -66,7 +66,7 @@
  * <td>ConsumerWithException</td>
  * </tr>
  * </table>
- * 
+ *
  * @since 2.2.0
  *
  */
@@ -82,7 +82,7 @@ private CommonsCollections4Helper() {
 	/**
 	 * Transforms a {@link PredicateWithException} to the one from
 	 * commons-collections.
-	 * 
+	 *
 	 * @param predicate
 	 *            the {@link PredicateWithException} to be transformed to the one
 	 *            from commons-collections.
@@ -105,7 +105,7 @@ public static <T> org.apache.commons.collections4.Predicate<T> asPredicate(Predi
 	/**
 	 * Transforms a {@link SupplierWithException} to the one from
 	 * commons-collections.
-	 * 
+	 *
 	 * @param supplier
 	 *            the {@link SupplierWithException} to be transformed to the one
 	 *            from commons-collections.
@@ -126,7 +126,7 @@ public static <T> Factory<T> asFactory(SupplierWithException<T, ?> supplier) {
 	/**
 	 * Transforms a {@link FunctionWithException} to the one from
 	 * commons-collections.
-	 * 
+	 *
 	 * @param function
 	 *            the {@link FunctionWithException} to be transformed to the one
 	 *            from commons-collections.
@@ -150,7 +150,7 @@ public static <I, O> Transformer<I, O> asTransformer(FunctionWithException<I, O,
 	/**
 	 * Transforms a {@link ConsumerWithException} to the one from
 	 * commons-collections.
-	 * 
+	 *
 	 * @param consumer
 	 *            the {@link ConsumerWithException} to be transformed to the one
 	 *            from commons-collections.

src/main/java/ch/powerunit/extensions/exceptions/DoubleBinaryOperatorWithException.java

@@ -46,7 +46,7 @@
  */
 @FunctionalInterface
 public interface DoubleBinaryOperatorWithException<E extends Exception>
-		extends PrimitiveReturnExceptionHandlerSupport<DoubleBinaryOperator> {
+		extends PrimitiveReturnExceptionHandlerSupport<DoubleBinaryOperator>, DoubleDefaultValue {
 
 	/**
 	 * Applies this operator to the given operands.
@@ -69,7 +69,7 @@ default DoubleBinaryOperator uncheckOrIgnore(boolean uncheck) {
 				return applyAsDouble(left, right);
 			} catch (Exception e) {
 				PrimitiveReturnExceptionHandlerSupport.handleException(uncheck, e, exceptionMapper());
-				return 0;
+				return defaultValue();
 			}
 		};
 	}
@@ -180,4 +180,40 @@ static <E extends Exception> DoubleBinaryOperator ignored(DoubleBinaryOperatorWi
 		return verifyFunction(function).ignore();
 	}
 
+	/**
+	 * Converts a {@code DoubleBinaryOperatorWithException} to a lifted
+	 * {@code DoubleBinaryOperator} with a default value as return value in case of
+	 * exception.
+	 *
+	 * @param function
+	 *            to be lifted
+	 * @param defaultValue
+	 *            value in case of exception
+	 * @param <E>
+	 *            the type of the potential exception
+	 * @return the lifted function
+	 * @see #ignore()
+	 * @see #ignored(DoubleBinaryOperatorWithException)
+	 * @throws NullPointerException
+	 *             if function is null
+	 * @since 3.0.0
+	 */
+	static <E extends Exception> DoubleBinaryOperator ignored(DoubleBinaryOperatorWithException<E> function,
+			double defaultValue) {
+		verifyFunction(function);
+		return new DoubleBinaryOperatorWithException<E>() {
+
+			@Override
+			public double applyAsDouble(double left, double right) throws E {
+				return function.applyAsDouble(left, right);
+			}
+
+			@Override
+			public double defaultValue() {
+				return defaultValue;
+			}
+
+		}.ignore();
+	}
+
 }

src/main/java/ch/powerunit/extensions/exceptions/DoubleDefaultValue.java

@@ -0,0 +1,34 @@
+/**
+ * Powerunit - A JDK1.8 test framework
+ * Copyright (C) 2014 Mathieu Boretti.
+ *
+ * This file is part of Powerunit
+ *
+ * Powerunit is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Powerunit is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Powerunit. If not, see <http://www.gnu.org/licenses/>.
+ */
+package ch.powerunit.extensions.exceptions;
+
+interface DoubleDefaultValue {
+
+	/**
+	 * Defines the default value returned by the ignore and ignored method.
+	 *
+	 * @return the default value for the ignore/ignored method.
+	 * @since 3.0.0
+	 */
+	default double defaultValue() {
+		return 0;
+	}
+
+}