Add unchecked operations

Author: Col-E

README.md

@@ -18,6 +18,7 @@ Handy utilities for things I wish were in Java's collections api.
   - Treated as additions to `Map<K, Tree<K,V>>`
 - Tuples
   - Pair
+- Lambdas that `throw Throwable`
 - Common utilities for `List`, `Map`, and `Set` types with features such as:
   - Creating singleton collections
   - Creating disjoint & union collection of two input collections

src/main/java/software/coley/collections/Unchecked.java

@@ -0,0 +1,216 @@
+package software.coley.collections;
+
+import software.coley.collections.func.*;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import java.util.function.*;
+
+/**
+ * Convenience calls for the error-able lambda types.
+ *
+ * @author Matt Coley
+ */
+public class Unchecked {
+	/**
+	 * @param value
+	 * 		Value to cast.
+	 * @param <T>
+	 * 		Target type.
+	 *
+	 * @return Value casted.
+	 */
+	@SuppressWarnings("unchecked")
+	public static <T> T cast(@Nullable Object value) {
+		return (T) value;
+	}
+
+	/**
+	 * @param runnable
+	 * 		Runnable.
+	 */
+	public static void run(@Nonnull UncheckedRunnable runnable) {
+		runnable.run();
+	}
+
+	/**
+	 * @param supplier
+	 * 		Supplier.
+	 * @param <T>
+	 * 		Supplier type.
+	 *
+	 * @return Supplied value.
+	 */
+	public static <T> T get(@Nonnull UncheckedSupplier<T> supplier) {
+		return supplier.get();
+	}
+
+	/**
+	 * @param supplier
+	 * 		Supplier.
+	 * @param fallback
+	 * 		Value to return if supplier fails.
+	 * @param <T>
+	 * 		Supplier type.
+	 *
+	 * @return Supplied value, or fallback if supplier failed.
+	 */
+	public static <T> T getOr(@Nullable UncheckedSupplier<T> supplier, T fallback) {
+		if (supplier == null)
+			return fallback;
+		try {
+			return supplier.get();
+		} catch (Throwable t) {
+			return fallback;
+		}
+	}
+
+	/**
+	 * @param consumer
+	 * 		Consumer.
+	 * @param value
+	 * 		Consumed value.
+	 * @param <T>
+	 * 		Consumer type.
+	 */
+	public static <T> void accept(@Nonnull UncheckedConsumer<T> consumer, T value) {
+		consumer.accept(value);
+	}
+
+	/**
+	 * @param consumer
+	 * 		Consumer.
+	 * @param t
+	 * 		First value.
+	 * @param u
+	 * 		Second value.
+	 * @param <T>
+	 * 		First type.
+	 * @param <U>
+	 * 		Second type.
+	 */
+	public static <T, U> void baccept(@Nonnull UncheckedBiConsumer<T, U> consumer, T t, U u) {
+		consumer.accept(t, u);
+	}
+
+	/**
+	 * @param fn
+	 * 		Function.
+	 * @param value
+	 * 		Function value.
+	 * @param <T>
+	 * 		Input type.
+	 * @param <R>
+	 * 		Output type.
+	 */
+	public static <T, R> R map(@Nonnull UncheckedFunction<T, R> fn, T value) {
+		return fn.apply(value);
+	}
+
+	/**
+	 * @param fn
+	 * 		Function.
+	 * @param t
+	 * 		First function value.
+	 * @param u
+	 * 		Second function value.
+	 * @param <T>
+	 * 		First input type.
+	 * @param <U>
+	 * 		Second input type.
+	 * @param <R>
+	 * 		Output type.
+	 */
+	public static <T, U, R> R bmap(@Nonnull UncheckedBiFunction<T, U, R> fn, T t, U u) {
+		return fn.apply(t, u);
+	}
+
+	/**
+	 * Helper method to created unchecked runnable.
+	 *
+	 * @param runnable
+	 * 		Unchecked runnable.
+	 *
+	 * @return Unchecked runnable.
+	 */
+	@Nonnull
+	public static Runnable runnable(@Nonnull UncheckedRunnable runnable) {
+		return runnable;
+	}
+
+	/**
+	 * Helper method to created unchecked supplier.
+	 *
+	 * @param supplier
+	 * 		Unchecked supplier.
+	 *
+	 * @return Unchecked supplier.
+	 */
+	@Nonnull
+	public static <T> Supplier<T> supply(@Nonnull UncheckedSupplier<T> supplier) {
+		return supplier;
+	}
+
+	/**
+	 * Helper method to created unchecked consumer.
+	 *
+	 * @param consumer
+	 * 		Unchecked consumer.
+	 *
+	 * @return Unchecked consumer.
+	 */
+	@Nonnull
+	public static <T> Consumer<T> consumer(@Nonnull UncheckedConsumer<T> consumer) {
+		return consumer;
+	}
+
+	/**
+	 * Helper method to created unchecked consumer.
+	 *
+	 * @param consumer
+	 * 		Unchecked consumer.
+	 *
+	 * @return Unchecked consumer.
+	 */
+	@Nonnull
+	public static <T, U> BiConsumer<T, U> bconsumer(@Nonnull UncheckedBiConsumer<T, U> consumer) {
+		return consumer;
+	}
+
+	/**
+	 * Helper method to created unchecked function.
+	 *
+	 * @param fn
+	 * 		Unchecked function.
+	 *
+	 * @return Unchecked function.
+	 */
+	@Nonnull
+	public static <T, R> Function<T, R> function(@Nonnull UncheckedFunction<T, R> fn) {
+		return fn;
+	}
+
+	/**
+	 * Helper method to created unchecked function.
+	 *
+	 * @param fn
+	 * 		Unchecked function.
+	 *
+	 * @return Unchecked function.
+	 */
+	@Nonnull
+	public static <T, U, R> BiFunction<T, U, R> bfunction(@Nonnull UncheckedBiFunction<T, U, R> fn) {
+		return fn;
+	}
+
+	/**
+	 * Propagates throwable.
+	 *
+	 * @param t
+	 * 		Throwable to propagate.
+	 */
+	@SuppressWarnings("unchecked")
+	public static <X extends Throwable> void propagate(@Nonnull Throwable t) throws X {
+		throw (X) t;
+	}
+}

src/main/java/software/coley/collections/func/TriFunction.java

@@ -0,0 +1,29 @@
+package software.coley.collections.func;
+
+/**
+ * Generic function for 3 arguments.
+ *
+ * @param <A>
+ * 		First parameter type.
+ * @param <B>
+ * 		Second parameter type.
+ * @param <C>
+ * 		Third parameter type.
+ * @param <R>
+ * 		Return type.
+ *
+ * @author Matt Coley
+ */
+interface TriFunction<A, B, C, R> {
+	/**
+	 * @param a
+	 * 		First arg.
+	 * @param b
+	 * 		Second arg.
+	 * @param c
+	 * 		Third arg.
+	 *
+	 * @return Return value.
+	 */
+	R apply(A a, B b, C c);
+}

src/main/java/software/coley/collections/func/UncheckedBiConsumer.java

@@ -0,0 +1,24 @@
+package software.coley.collections.func;
+
+import software.coley.collections.Unchecked;
+
+import java.util.function.BiConsumer;
+
+/**
+ * Its {@link BiConsumer} but can throw an exception.
+ *
+ * @author xDark
+ */
+@FunctionalInterface
+public interface UncheckedBiConsumer<T, U> extends BiConsumer<T, U> {
+	@Override
+	default void accept(T t, U u) {
+		try {
+			uncheckedAccept(t, u);
+		} catch (Throwable th) {
+			Unchecked.propagate(th);
+		}
+	}
+
+	void uncheckedAccept(T t, U u) throws Throwable;
+}

src/main/java/software/coley/collections/func/UncheckedBiFunction.java

@@ -0,0 +1,36 @@
+package software.coley.collections.func;
+
+import software.coley.collections.Unchecked;
+
+import java.util.function.BiFunction;
+
+/**
+ * Its {@link BiFunction} but can throw an exception.
+ *
+ * @author xDark
+ */
+@FunctionalInterface
+public interface UncheckedBiFunction<T, U, R> extends BiFunction<T, U, R> {
+	@Override
+	default R apply(T t, U u) {
+		try {
+			return uncheckedApply(t, u);
+		} catch (Throwable th) {
+			Unchecked.propagate(th);
+			return null;
+		}
+	}
+
+	/**
+	 * @param t
+	 * 		First input.
+	 * @param u
+	 * 		Second input.
+	 *
+	 * @return The function result.
+	 *
+	 * @throws Throwable
+	 * 		Whenever.
+	 */
+	R uncheckedApply(T t, U u) throws Throwable;
+}

src/main/java/software/coley/collections/func/UncheckedConsumer.java

@@ -0,0 +1,31 @@
+package software.coley.collections.func;
+
+import software.coley.collections.Unchecked;
+
+import java.util.function.Consumer;
+
+/**
+ * Its {@link Consumer} but can throw an exception.
+ *
+ * @author Matt Coley
+ */
+@FunctionalInterface
+public interface UncheckedConsumer<T> extends Consumer<T> {
+	@Override
+	default void accept(T t) {
+		try {
+			uncheckedAccept(t);
+		} catch (Throwable th) {
+			Unchecked.propagate(th);
+		}
+	}
+
+	/**
+	 * @param input
+	 * 		Consumer input.
+	 *
+	 * @throws Throwable
+	 * 		Whenever.
+	 */
+	void uncheckedAccept(T input) throws Throwable;
+}

src/main/java/software/coley/collections/func/UncheckedFunction.java

@@ -0,0 +1,34 @@
+package software.coley.collections.func;
+
+import software.coley.collections.Unchecked;
+
+import java.util.function.Function;
+
+/**
+ * Its {@link Function} but can throw an exception.
+ *
+ * @author xDark
+ */
+@FunctionalInterface
+public interface UncheckedFunction<T, R> extends Function<T, R> {
+	@Override
+	default R apply(T t) {
+		try {
+			return uncheckedApply(t);
+		} catch (Throwable th) {
+			Unchecked.propagate(th);
+			return null;
+		}
+	}
+
+	/**
+	 * @param input
+	 * 		Function input.
+	 *
+	 * @return The function result.
+	 *
+	 * @throws Throwable
+	 * 		Whenever.
+	 */
+	R uncheckedApply(T input) throws Throwable;
+}