javadoc/throwingcallable.

Author: mihxil

mihxil-functional/src/main/java/org/meeuw/functional/Functions.java

@@ -35,6 +35,8 @@ public static <A, R> Function<A, R> always(R returnValue, String description) {
     }
 
     /**
+     * Provides an implementation of {@link Function} always returning the same value
+     *
      * @param <A> the type of the argument to the function (which will be ignored)
      * @param <R> the type of the return value of the function
      * @param returnValue the desired value to always return
@@ -60,6 +62,8 @@ public static <A1, A2,  R> BiFunction<A1, A2, R> biAlways(R returnValue, String
     }
 
     /**
+     * Provides an implementation of {@link BiFunction} always returning the same value
+     *
      * @param <A1> the type of the first argument to the function (which will be ignored)
      * @param <A2> the type of the second argument to the function (which will be ignored)
      * @param <R>  the type of the return value
@@ -87,6 +91,7 @@ public static <A1, A2, A3,  R> TriFunction<A1, A2, A3,  R> triAlways(R returnVal
     }
 
     /**
+     * Provides an implementation of {@link TriFunction} always returning the same value
      *
      * @param <A1> the type of the first argument to the function (which will be ignored)
      * @param <A2> the type of the second argument to the function (which will be ignored)
@@ -116,6 +121,8 @@ public static <A1, A2, A3, A4,  R> QuadriFunction<A1, A2, A3, A4,  R> quadriAlwa
     }
 
     /**
+     * Provides an implementation of {@link QuadriFunction} always returning the same value
+     *
      * @param <A1> the type of the first argument to the function (which will be ignored)
      * @param <A2> the type of the second argument to the function (which will be ignored)
      * @param <A3> the type of the third argument to the function (which will be ignored)

mihxil-functional/src/main/java/org/meeuw/functional/OptionalBoolean.java

@@ -38,8 +38,15 @@ public enum OptionalBoolean {
      */
     EMPTY,
 
+    /**
+     * Common instance for {@code true}.
+     */
     TRUE(true),
 
+
+    /**
+     * Common instance for {@code false}.
+     */
     FALSE(false);
 
 

mihxil-functional/src/main/java/org/meeuw/functional/Suppliers.java

@@ -56,8 +56,15 @@ public static <T> UnwrappableSupplier<T, Supplier<T>> memoize(Supplier<T> suppli
         return new MemoizeSupplier<T>(supplier);
     }
 
+    /**
+     * Wrap a given supplier. The result of the suppletion is memoized after the first call. Subsequent calls will give the same value, without calling the supplier again. The result is als {@link CloseableSupplier}
+     *
+     * @param supplier the supplier to memoize
+     * @param <T> The type of the objects to supply
+     * @return a new supplier that uses the argument supplier only once
+     */
     public static <T, S extends CloseableSupplier<T>> UnwrappableCloseableSupplier<T, Supplier<T>> memoize(S supplier) {
-        return  new CloseableSupplierWrapper<>(memoize((Supplier<T>) supplier),
+        return new CloseableSupplierWrapper<>(memoize((Supplier<T>) supplier),
             new SupplierConsumerWrapper<>(supplier), null);
     }
 
@@ -72,6 +79,13 @@ public static <T> UnwrappableCloseableSupplier<T, Supplier<T>> closeable(Supplie
         return  new CloseableSupplierWrapper<>(supplier, closer, "closeable");
     }
 
+
+    /**
+     * Wraps a {@link Supplier} in a {@link UnwrappableCloseableSupplier}, which can be closed to release resources.
+     * @param supplier the supplier to wrap to make it closeable.
+     * @return A new {@link UnwrappableCloseableSupplier} that wraps the given supplier and can be closed.
+     * @param <T> the type of the value supplied
+     */
     public static <T, S extends Supplier<T> & AutoCloseable> UnwrappableCloseableSupplier<T, Supplier<T>> closeable(S supplier) {
         SupplierConsumerWrapper<T, S> consumerWrapper = new SupplierConsumerWrapper<>(supplier);
         return new CloseableSupplierWrapper<>(supplier, consumerWrapper, "wrapper");

mihxil-functional/src/main/java/org/meeuw/functional/ThrowingBiFunction.java

@@ -24,6 +24,13 @@ default R apply(A a, B b) {
         }
     }
 
+    /**
+     * Applies this function to the given arguments.
+     * @param a  the first function argument
+     * @param b  the second function argument
+     * @return the function result
+     * @throws E Checked exception that might occur.
+     */
     R applyWithException(A a, B b) throws E;
 
 }

mihxil-functional/src/main/java/org/meeuw/functional/ThrowingCallable.java

@@ -0,0 +1,18 @@
+package org.meeuw.functional;
+
+import java.util.concurrent.Callable;
+
+
+/**
+ * An extension of {@link Callable} with a type of the exception
+ * @since 1.15
+ * @param <R> the return type of the callable
+ * @param <E> the type of the exception that can be thrown
+ */
+@FunctionalInterface
+public interface ThrowingCallable<R, E extends Exception> extends Callable<R> {
+
+    @Override
+    R call() throws E;
+
+}

mihxil-functional/src/main/java/org/meeuw/functional/ThrowingFunction.java

@@ -23,6 +23,12 @@ default R apply(A a) {
         }
     }
 
+     /**
+     * Applies this function to the given arguments.
+     * @param a  the first function argument
+     * @return the function result
+     * @throws E Checked exception that might occur.
+     */
     R applyWithException(A a) throws E;
 
 }

mihxil-functional/src/main/java/org/meeuw/functional/ThrowingQuadriFunction.java

@@ -23,6 +23,15 @@ default R apply(A a, B b, C c, D d) {
             return sneakyThrow(e);
         }
     }
+    /**
+     * Applies this function to the given arguments.
+     * @param a  the first function argument
+     * @param b  the second function argument
+     * @param c  the third function argument
+     * @param d  the fourth function argument
+     * @return the function result
+     * @throws E Checked exception that might occur.
+     */
 
     R applyWithException(A a, B b, C c, D d) throws E;
 

mihxil-functional/src/main/java/org/meeuw/functional/ThrowingTriFunction.java

@@ -25,6 +25,16 @@ default R apply(A a, B b, C c) {
         }
     }
 
+
+    /**
+     * Applies this function to the given arguments.
+     * @param a  the first function argument
+     * @param b  the second function argument
+     * @param c  the third function argument
+     * @return the function result
+     * @throws E Checked exception that might occur.
+     */
+
     R applyWithException(A a, B b, C c) throws E;
 
 }

mihxil-functional/src/main/java/org/meeuw/functional/TriConsumer.java

@@ -31,6 +31,8 @@ public interface TriConsumer<T, U, V> {
     void accept(T t, U u, V v);
 
     /**
+     * Returns a composed TriConsumer that performs, in sequence, this operation followed by the after operation. If performing either operation throws an exception, it is relayed to the caller of the composed operation. If performing this operation throws an exception, the after operation will not be performed.
+     *
      * @param after the operation to perform after this operation
      * @return a composed {@code TriConsumer} that performs in sequence this operation followed by the {@code after} operation
      * @throws NullPointerException if {@code after} is null

mihxil-functional/src/main/java/org/meeuw/functional/TriFunction.java

@@ -31,6 +31,8 @@ public interface TriFunction <T,U,V,R> {
     R apply(T t, U u, V v);
 
     /**
+     * Returns a composed function that first applies this function to its input, and then applies the after function to the result. If evaluation of either function throws an exception, it is relayed to the caller of the composed function.
+     *
      * @param <S> – the type of output of the after function, and of the composed function
      * @param after the function to apply after this function is applied
      * @return a composed function that first applies this function and then