Test coverage

Author: fugerit79

fj-core-jvfs/src/main/java/org/fugerit/java/core/jvfs/helpers/AbstractJFile.java

@@ -130,7 +130,7 @@ public List<JFile> lsFiles() throws IOException {
 
 	@Override
 	public String describe() {
-		// see SafeFunction.get() [if any Exception is thrown, it will be wrapped by a ConfigRuntimeException]
+		// see SafeFunction : https://jupiterdocs.fugerit.org/fj-core/src/docs/SafeFunction.html
 		return SafeFunction.get( () -> this.getClass().getSimpleName()+"[path:"+this.getPath()+",isDirectory:"+this.isDirectory()+",isFile:"+this.isFile()+"]" );
 	}
 

fj-core/README.md

@@ -5,4 +5,8 @@
 Simple utilities for IO, Configuration, DB, Language types and more.
 
 [![Maven Central](https://img.shields.io/maven-central/v/org.fugerit.java/fj-core.svg)](https://mvnrepository.com/artifact/org.fugerit.java/fj-core) 
-[![javadoc](https://javadoc.io/badge2/org.fugerit.java/fj-core/javadoc.svg)](https://javadoc.io/doc/org.fugerit.java/fj-core)
+[![javadoc](https://javadoc.io/badge2/org.fugerit.java/fj-core/javadoc.svg)](https://javadoc.io/doc/org.fugerit.java/fj-core)
+
+## Main features documentation
+
+- [SafeFunction](src/docs/SafeFunction.md)

fj-core/src/docs/SafeFunction.md

@@ -0,0 +1,38 @@
+# SafeFunction
+
+[fj-core index](../../README.md)
+
+SafeFunction provides API for handling exception without a try catch block.
+
+Imagine, for instance, you are writing some code to append all the lines in a reader to one line, the classic code would look like :
+
+```
+  	public String testExampleToOneLineClassic() {
+		StringBuilder builder = new StringBuilder();
+		try ( BufferedReader reader = new BufferedReader( new StringReader( "test" ) ) ) {
+			reader.lines().forEach( line -> builder.append( line+" " ) );
+		} catch (IOException e) {
+			throw new ConfigRuntimeException( e );
+		}
+		return builder.toString();
+	}
+```
+
+With safe functions it look likes : 
+
+```
+	public String testExampleToOneLineSafeFunction() {
+		return SafeFunction.get(() -> {
+			StringBuilder builder = new StringBuilder();
+			try ( BufferedReader reader = new BufferedReader( new StringReader( "test" ) ) ) {
+				reader.lines().forEach( line -> builder.append( line+" " ) );
+			}	
+			return builder.toString();
+		});
+	}
+```
+
+The default behavior is that any thrown Exception will be wrapped by a ConfigRuntimeException.
+It is possible to provide custom exception handlers.
+
+Read the [SafeFunction javadoc](https://javadoc.io/doc/org.fugerit.java/fj-core/latest/org/fugerit/java/core/function/SafeFunction.html) too.