Skip to content

Commit 02c6f8c

Browse files
Update README.md
1 parent 173d822 commit 02c6f8c

1 file changed

Lines changed: 27 additions & 11 deletions

File tree

README.md

Lines changed: 27 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,29 +10,30 @@
1010

1111
This library is a set of Java Utility containing many useful Helper Classes which are described below.
1212

13-
##Stream Util
13+
#Stream Util
14+
<br>
1415
This library contains the StreamUtil, that contains flatten methods to flatten any stream of optionals to the stream of the type contained in the optionals. These flatten methods also supports boxed and non-boxed types of streams.
1516

16-
##Optional Util
17+
#Optional Util
18+
<br>
1719
This library contains the OptionalUtil, that flattens any optional of optional of any type to an optional of the type. Optional of a non-boxed optional type can also be flattened.
1820

19-
##Optional with Throwable
21+
#Optional with Throwable
22+
<br>
2023
A new OptionalWithThrowable is added so that any map/flatMap/filter/ifPresent operation will accept the corresponding 'Funtional Interface with Throwable' which are added in this Java Utlitity.
2124

22-
##Funtional Interfaces with Throwable
25+
#Funtional Interfaces with Throwable
26+
<br>
2327
With regular Functional Interfaces, exceptions or errors are be not able chain the exceptions thrown inside the method to the caller. This required to handle the exception within the method definition itself. To handle this requirement new kind of Funtional Interfaces namely PredicateWithThrowable, FuntionWithThrowable, ConsumerWithThrowable and BiFunctionWithThrowable are added. Some of these are also used with OptionalWithThrowable implementation.
2428

25-
##Tuples
29+
#Tuples
30+
<br>
2631
Inspired by Scala Tuples, this Java Utility includes convinent Generic Tuples from Tuple2 to Tuple10 and a convinient helper factory called Tuples to create them.
2732

28-
##Mappable Optionals
33+
#Mappable Optionals
34+
<br>
2935
This library contains Mappable counterparts of OptionalInt, OptionalLong and OptionalDouble. This Mappable versions allows us to avoid boxing of primitive data typed streams. This implementation is done because the current versions of OptionalInt, OptionalLong and OptionalDouble do not provide a map or flatMap method, which forces us to use the Boxed verison of Optional.
3036

31-
##Examples
32-
Added an example project that demonstrates the use of this Library.
33-
34-
Also, please look into the <a href="https://github.com/loganathan001/Java-Utils/tree/master/projects/java-utils/src/test/java/org/vishag/javautils">Unit tests</a> for all the use-cases and examples.
35-
3637
To install the latest version, add the below pom dependency entry:
3738
```
3839
<dependency>
@@ -41,3 +42,18 @@ To install the latest version, add the below pom dependency entry:
4142
 <version>1.0.0</version>
4243
</dependency>
4344
```
45+
46+
#Examples
47+
<br>
48+
Added an example project that demonstrates the use of this Library.
49+
50+
To install the examples, add the below pom dependency entry:
51+
```
52+
<dependency>
53+
 <groupId>org.vishag</groupId>
54+
<artifactId>java-utils-examples</artifactId>
55+
 <version>1.0.0</version>
56+
</dependency>
57+
```
58+
59+
Also, please look into the <a href="https://github.com/loganathan001/Java-Utils/tree/master/projects/java-utils/src/test/java/org/vishag/javautils">Unit tests</a> for all the use-cases and examples.

0 commit comments

Comments
 (0)