diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100755 index 0000000..e69de29 diff --git a/pom.xml b/pom.xml index e864771..9471031 100755 --- a/pom.xml +++ b/pom.xml @@ -30,6 +30,8 @@ sddevelopment_coding-utils ${jacoco.build.dir}/jacoco.xml + **/*.html + **/*.html ${project.build.directory}/jacoco 21 diff --git a/src/main/java/be/sddevelopment/commons/exceptions/ExceptionSuppressor.java b/src/main/java/be/sddevelopment/commons/exceptions/ExceptionSuppressor.java index e10a483..735bc37 100755 --- a/src/main/java/be/sddevelopment/commons/exceptions/ExceptionSuppressor.java +++ b/src/main/java/be/sddevelopment/commons/exceptions/ExceptionSuppressor.java @@ -32,20 +32,21 @@ *

* When using functional programming techniques in java 8+, * a common issue is the inability to chain operations using method references if those - * called methods throw a checked exception.
+ * called methods throw a checked exception. * This class is meant to suppress these checked exceptions. - *

- * It can also be used to write your exception handling in a more fluent way, - * and to facilitate designs based on using Unchecked Exceptions. *

* - *
Example usage
- * - *
References
- * * @author Stijn Dejongh * @version 1.0.0 * @created 01.11.20, Sunday + * @apiNote {@link ExceptionSuppressor} can also be used to write your exception handling in a + * more fluent way, + * and to facilitate designs based on throwing Unchecked {@link Exception}s from various + * architectural levels in your codebase. + * See + * and the documentation of Lombok's @SneakyThrows implementation. * @since 1.0.0 */ @Utility diff --git a/src/main/java/be/sddevelopment/commons/exceptions/FallibleFunction.java b/src/main/java/be/sddevelopment/commons/exceptions/FallibleFunction.java index 8f539d6..667cb92 100755 --- a/src/main/java/be/sddevelopment/commons/exceptions/FallibleFunction.java +++ b/src/main/java/be/sddevelopment/commons/exceptions/FallibleFunction.java @@ -25,16 +25,17 @@ /** *

- * Interface for a Function that can throw an {@link Exception} + * An interface to generically represent {@link java.util.function.Function}s that possibly throw an Exception. + * To be used in combination with the {@link ExceptionSuppressor} class. *

* - *
References
- * {@link java.util.function.Function} * * @author Stijn Dejongh * @version 1.0.0 * @created 01.11.20, Sunday * @since 1.0.0 + * @apiNote Not to be used outside the scope of generic {@link Exception} flow processing. + * */ @FunctionalInterface interface FallibleFunction {