Adding CheckedEffect1 and CheckedFn1 static factory method

jnape · jnape · commit dfa22e5ee803 · 2018-08-17T17:59:20.000-05:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,7 +14,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 ### Added
 - `Predicate#predicate` static factory method
 - `Product2-8` left/right rotation methods
-- `Tuple2-8` specializations of left/right product rotation 
+- `Tuple2-8` specializations of left/right product rotation
+- `CheckedEffect`, an `Effect` variant that can throw checked exceptions 
+- `CheckedFn1#checked`, convenience static factory method to aid inference 
 
 ## [3.1.0] - 2018-07-16
 ### Added
diff --git a/src/main/java/com/jnape/palatable/lambda/functions/specialized/checked/CheckedEffect1.java b/src/main/java/com/jnape/palatable/lambda/functions/specialized/checked/CheckedEffect1.java
@@ -0,0 +1,48 @@
+package com.jnape.palatable.lambda.functions.specialized.checked;
+
+import com.jnape.palatable.lambda.functions.Effect;
+
+import static com.jnape.palatable.lambda.functions.specialized.checked.Runtime.throwChecked;
+
+/**
+ * Specialized {@link Effect} that can throw any {@link Throwable}.
+ *
+ * @param <T> The {@link Throwable} type
+ * @param <A> The input type
+ * @see CheckedRunnable
+ * @see CheckedFn1
+ * @see Effect
+ */
+@FunctionalInterface
+public interface CheckedEffect1<T extends Throwable, A> extends Effect<A> {
+
+    @Override
+    default void accept(A a) {
+        try {
+            checkedAccept(a);
+        } catch (Throwable t) {
+            throw throwChecked(t);
+        }
+    }
+
+    /**
+     * A version of {@link Effect#accept} that can throw checked exceptions.
+     *
+     * @param a the effect argument
+     * @throws T any exception that can be thrown by this method
+     */
+    void checkedAccept(A a) throws T;
+
+    /**
+     * Convenience static factory method for constructing a {@link CheckedEffect1} without an explicit cast or type
+     * attribution at the call site.
+     *
+     * @param checkedEffect the checked effect
+     * @param <T>           the inferred Throwable type
+     * @param <A>           the input type
+     * @return the checked effect
+     */
+    static <T extends Throwable, A> CheckedEffect1<T, A> checked(CheckedEffect1<T, A> checkedEffect) {
+        return checkedEffect;
+    }
+}
diff --git a/src/main/java/com/jnape/palatable/lambda/functions/specialized/checked/CheckedFn1.java b/src/main/java/com/jnape/palatable/lambda/functions/specialized/checked/CheckedFn1.java
@@ -34,4 +34,18 @@ default B apply(A a) {
      * @throws T any exception that can be thrown by this method
      */
     B checkedApply(A a) throws T;
+
+    /**
+     * Convenience static factory method for constructing a {@link CheckedFn1} without an explicit cast or type
+     * attribution at the call site.
+     *
+     * @param checkedFn1 the checked fn1
+     * @param <T>        the inferred Throwable type
+     * @param <A>        the input type
+     * @param <B>        the output type
+     * @return the checked fn1
+     */
+    static <T extends Throwable, A, B> CheckedFn1<T, A, B> checked(CheckedFn1<T, A, B> checkedFn1) {
+        return checkedFn1;
+    }
 }
