Skip to content

Commit 775057d

Browse files
committed
Issue #64 - Add javadoc and README
1 parent e4c6e7a commit 775057d

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,13 @@ Also, some dedicated, _ready to used_, Exception Mapper are provided :
161161
* `saxExceptionMapper()` - Return an exception mapper that adds to the message of the `RuntimeException` the SAX Error from the underlying exception. **This is only usable when the module java.xml is available**.
162162
* `transformerExceptionMapper()` - Return an exception mapper that adds to the message of the `RuntimeException` the Transformer Error from the underlying exception. **This is only usable when the module java.xml is available**.
163163

164+
### CommonsCollections4Helper
165+
166+
_This helper is only available since version 2.2.0 and only if the commons-collections4 library is available_
167+
168+
The class `CommonsCollections4Helper` provides several static methods to convert interface
169+
from this library to the corresponding version in commons-collections4.
170+
164171
## Reference
165172

166173
The following classes are provided:

src/main/java/ch/powerunit/extensions/exceptions/CommonsCollections4Helper.java

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,16 @@
3737
* "https://commons.apache.org/proper/commons-collections">commons-collections4</a>.
3838
* <p>
3939
* <b>This class is only available if commons-collections4 is available</b>
40+
* <p>
41+
* The mapping between the interface from <i>commons-collections4</i> and this library is the following :
42+
*
43+
* <table border="1" summary="Mapping between interfaces">
44+
* <tr><th>commons-collections4</th><th>powerunit-extensions-exceptions</th></tr>
45+
* <tr><td>Predicate</td><td>PredicateWithException</td></tr>
46+
* <tr><td>Factory</td><td>SupplierWithException</td></tr>
47+
* <tr><td>Transformer</td><td>FunctionWithException</td></tr>
48+
* <tr><td>Closure</td><td>ConsumerWithException</td></tr>
49+
* </table>
4050
*
4151
* @since 2.2.0
4252
*

0 commit comments

Comments
 (0)