applyWithMessage() and getWithMessage() special function to SafeFunction

Author: fugerit79

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+- applyWithMessage() and getWithMessage() special function to SafeFunction
+
 ## [8.4.3] - 2023-10-22
 
 ### Added

fj-core/src/main/java/org/fugerit/java/core/function/SafeFunction.java

@@ -77,6 +77,10 @@ private SafeFunction() {}
 	 */
 	private static final Consumer<Exception> DEFAULT_EX_CONSUMER = EX_CONSUMER_RETHROW_RTE_OR_CONVERT_CHECKED_TO_CRE;
 
+	private static Consumer<Exception> createRethrowWithMessageExHandler( String message ) {
+		return e -> { throw new ConfigRuntimeException( message+" caused by ("+e+")" , e); };
+	}
+	
 	/**
 	 * <p>Get a value returned by an UnsafeSupplier, and convert any raised Exception</p>
 	 * 
@@ -109,19 +113,60 @@ public static <T> T get( UnsafeSupplier<T, Exception> supplier ) {
 		return get( supplier, DEFAULT_EX_CONSUMER );
 	}
 
+	/**
+	 * <p>Return the value of an UnsafeSupplier, only logging (level WARN) any error.</p>
+	 * 
+	 * @param <T>			the returned type
+	 * @param supplier		the {@link UnsafeSupplier}  function
+	 * @return				the value evaluated by the {@link UnsafeSupplier}
+	 */
+	public static <T> T getSilent( UnsafeSupplier<T, Exception> supplier ) {
+		return get( supplier, EX_CONSUMER_LOG_WARN );
+	}
+	
+	/**
+	 * <p>Return the value of an UnsafeSupplier, converting any raised Exception to ConfigRuntimeException, a message will be prefixed to the thrown ConfigRuntimeException.</p>
+	 * 
+	 * @param <T>			the returned type
+	 * @param supplier		the {@link UnsafeSupplier}  function
+	 * @param message		the message to be prefixed to the thrown ConfigRuntimeException
+	 * @return				the value evaluated by the {@link UnsafeSupplier} 
+	 * @throws ConfigRuntimeException 	may throw ConfigRuntimeException in case of exceptions
+	 */
+	public static <T> T getWithMessage( UnsafeSupplier<T, Exception> supplier, String message ) {
+		return get( supplier, createRethrowWithMessageExHandler( message ) );
+	}
+
 	/**
 	 * <p>Apply an UnsafeVoid function, converting any raised Exception to ConfigRuntimeException.</p>
 	 * 
 	 * @param fun	the {@link UnsafeVoid} function
+	 * @throws ConfigRuntimeException 	may throw ConfigRuntimeException in case of exceptions
 	 */
 	public static void apply( UnsafeVoid<Exception> fun ) {
 		apply( fun , DEFAULT_EX_CONSUMER );
 	}
 
+	/**
+	 * <p>Apply an UnsafeVoid function, only logging (level WARN) any error.</p>
+	 * 
+	 * @param fun	the {@link UnsafeVoid} function
+	 */
 	public static void applySilent( UnsafeVoid<Exception> fun ) {
 		apply( fun , EX_CONSUMER_LOG_WARN );
 	}
 
+	/**
+	 * <p>Apply an UnsafeVoid function, converting any raised Exception to ConfigRuntimeExceptiona, message will be prefixed to the thrown ConfigRuntimeException.</p>
+	 * 
+	 * @param fun	the {@link UnsafeVoid} function
+	 * @param message		the message to be prefixed to the thrown ConfigRuntimeException
+	 * @throws ConfigRuntimeException 	may throw ConfigRuntimeException in case of exceptions
+	 */
+	public static void applyWithMessage( UnsafeVoid<Exception> fun, String message ) {
+		apply( fun , createRethrowWithMessageExHandler( message ) );
+	}
+
 	/**
 	 * <p>Return the value provided by the supplier, handling any exception with a {@link Consumer} function.</p>
 	 * 

fj-core/src/test/java/test/org/fugerit/java/core/function/TestSafeFunction.java

@@ -11,6 +11,7 @@
 import org.fugerit.java.core.db.dao.DAOException;
 import org.fugerit.java.core.db.dao.DAORuntimeException;
 import org.fugerit.java.core.function.SafeFunction;
+import org.fugerit.java.core.lang.helpers.BooleanUtils;
 import org.fugerit.java.core.xml.XMLException;
 import org.junit.Assert;
 import org.junit.Test;
@@ -72,6 +73,34 @@ public void testGetLogGen() {
 		Assert.assertNull( res );
 	}
 
+	@Test
+	public void testApplyWithMessage() {
+		Assert.assertThrows( ConfigRuntimeException.class , () -> SafeFunction.applyWithMessage( () -> { throw new IOException( "exApplyWithMessage" ); }, "error test" ) );
+	}
+	
+	@Test
+	public void testGetWithMessage() {
+		Assert.assertThrows( ConfigRuntimeException.class , () -> SafeFunction.getWithMessage( () -> { throw new IOException( "exGetWithMessage" ); }, "error test" ) );
+	}
+	
+	@Test
+	public void testApplyWithMessageOk() {
+		boolean ok = true;
+		SafeFunction.applyWithMessage( () -> log.info( "ok" ), "no error apply" );
+		Assert.assertTrue( ok );
+	}
+	
+	@Test
+	public void testGetWithMessageOk() {
+		Assert.assertEquals( BooleanUtils.BOOLEAN_1 , SafeFunction.getWithMessage( () -> BooleanUtils.BOOLEAN_1, "no error get" ) );
+	}
+	
+	@Test
+	public void testGetSilent() {
+		String res = SafeFunction.getSilent( () -> { throw new IOException( "exGetSilent" ); } );
+		Assert.assertNull( res );
+	}
+	
 	@Test
 	public void testGetWithDefaultLogGen() {
 		String res = SafeFunction.getWithDefault( () -> { throw new IOException( "ex3" ); }, e -> {