changes fixing mistakes

pom.xml

@@ -147,13 +147,13 @@
         <module>event-sourcing</module>
         <module>data-transfer-object</module>
         <module>throttling</module>
-
         <module>unit-of-work</module>
         <module>partial-response</module>
         <module>eip-wire-tap</module>
         <module>eip-splitter</module>
         <module>eip-aggregator</module>
         <module>retry</module>
+		<module>trampoline</module>
     </modules>
 
     <repositories>

trampoline/README.md

@@ -12,13 +12,16 @@ tags:
 ---
 
 ## Intent
-By representing a computation in one of 2 states 
+Trampoline pattern is used for implementing algorithms recursively in Java without blowing the stack 
+and to interleave the execution of functions without hard coding them together
+It is possible by representing a computation in one of 2 states : done | more 
 (completed with result, or a reference to the reminder of the computation, 
-something like the way a java.util.Supplier does) 
-it is possible to implement algorithms recursively in Java without blowing the stack 
-and to interleave the execution of functions without hard coding them together or even using threads.
+something like the way a java.util.Supplier does).
 
 
+## Explanation
+Trampoline pattern allows to define recursive algorithms by iterative loop.
+
 
 ## Applicability
 Use the Trampoline pattern when
@@ -32,9 +35,11 @@ The time overhead of a reflection call is traded for the space overhead of an in
 Trampolines in Java usually involve the creation of a GenericListener to pass events to an outer class.
 
 
-## Credits
-
+## Tutorials 
 * [Trampolining: a practical guide for awesome Java Developers](https://medium.com/@johnmcclean/trampolining-a-practical-guide-for-awesome-java-developers-4b657d9c3076)
 * [Trampoline in java ](http://mindprod.com/jgloss/trampoline.html)
-* [cyclops-react](https://github.com/aol/cyclops-react)
+
+## Credits
+* [library 'cyclops-react' uses the pattern](https://github.com/aol/cyclops-react)
+
 

trampoline/pom.xml

@@ -34,19 +34,16 @@
     </parent>
     <artifactId>trampoline</artifactId>
     <dependencies>
-        <!-- https://mvnrepository.com/artifact/junit/junit -->
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>
             <version>4.12</version>
             <scope>test</scope>
         </dependency>
-        <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
         <dependency>
             <groupId>org.projectlombok</groupId>
             <artifactId>lombok</artifactId>
             <version>1.16.18</version>
-            <scope>provided</scope>
         </dependency>
 
 

trampoline/src/main/java/com/iluwatar/trampoline/Trampoline.java

@@ -2,13 +2,13 @@ package com.iluwatar.trampoline;
 
 import java.util.stream.Stream;
 
-/**When get is called on the returned Trampoline, internally it will iterate calling ‘jump’
- on the returned Trampoline as long as the concrete instance returned is More,
- stopping once the returned instance is Done. Essential we convert looping via recursion into iteration,
- the key enabling mechanism is the fact that Trampoline.more is a lazy operation.
- Trampoline in cyclops-react extends java.util.Supplier. Calling Trampoline.more we are basically creating
- a Supplier that defers the actual recursive call, and having defered the call we can move it outside of the recursive loop.
- This means we can define algorithms recursively in Java but execute them iteratively.*/
+/**<p>Trampoline pattern allows to define recursive algorithms by iterative loop </p>
+ * <p>When get is called on the returned Trampoline, internally it will iterate calling ‘jump’
+ on the returned Trampoline as long as the concrete instance returned is {@link #more(Trampoline)},
+ stopping once the returned instance is {@link #done(Object)}.</p>
+ <p>Essential we convert looping via recursion into iteration,
+ the key enabling mechanism is the fact that {@link #more(Trampoline)} is a lazy operation.</p>
+*/
 
 public interface Trampoline<T>  {
     T get();

trampoline/src/main/java/com/iluwatar/trampoline/TrampolineApp.java

@@ -1,17 +1,17 @@
 /**
  * The MIT License
  * Copyright (c) 2014-2016 Ilkka Seppälä
- *
+ * <p>
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  * copies of the Software, and to permit persons to whom the Software is
  * furnished to do so, subject to the following conditions:
- *
+ * <p>
  * The above copyright notice and this permission notice shall be included in
  * all copies or substantial portions of the Software.
- *
+ * <p>
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -27,23 +27,9 @@ package com.iluwatar.trampoline;
 import lombok.extern.slf4j.Slf4j;
 
 /**
- * <div>
- * By representing a computation in one of 2 states
- (completed with result, or a reference to the reminder of the computation,
- something like the way a java.util.Supplier does)
- it is possible to implement algorithms recursively in Java without blowing the stack
- and to interleave the execution of functions without hard coding them together or even using threads.
- </div>
- <div>
- Trampoline has 2 state : [done], [ more]
- </div>
- When get is called on the returned Trampoline, internally it will iterate calling ‘jump’
- on the returned Trampoline as long as the concrete instance returned is More,
- stopping once the returned instance is Done. Essential we convert looping via recursion into iteration,
- the key enabling mechanism is the fact that Trampoline.more is a lazy operation.
- Trampoline in cyclops-react extends java.util.Supplier. Calling Trampoline.more we are basically creating
- a Supplier that defers the actual recursive call, and having defered the call we can move it outside of the recursive loop.
- This means we can define algorithms recursively in Java but execute them iteratively.
+ * <p>Trampoline pattern allows to define recursive algorithms by iterative loop </p>
+ * <p>it is possible to implement algorithms recursively in Java without blowing the stack
+ * and to interleave the execution of functions without hard coding them together or even using threads.</p>
  */
 
 @Slf4j
@@ -51,17 +37,18 @@ public class TrampolineApp {
     public static void main(String[] args) {
         log.info("start pattern");
         Integer result = loop(10, 1).result();
-        log.info("result {}" ,result);
+        log.info("result {}", result);
 
     }
+
     /**
-     * Manager for pattern.
+     * Manager for pattern. Define it with a factorial function.
      * */
-    public static Trampoline<Integer> loop(int times,int prod){
-        if(times==0)
+    public static Trampoline<Integer> loop(int times, int prod) {
+        if (times == 0)
             return Trampoline.done(prod);
         else
-            return Trampoline.more(()->loop(times-1,prod*times));
+            return Trampoline.more(() -> loop(times - 1, prod * times));
     }
 
 }

trampoline/src/test/java/com/iluwatar/trampoline/TrampolineAppTest.java

@@ -8,8 +8,9 @@ import static org.junit.Assert.*;
 
 public class TrampolineAppTest {
 
+
     @Test
-    public void test()throws IOException{
+    public void testTrampolineWithFactorialFunction()throws IOException{
         int result = TrampolineApp.loop(10, 1).result();
         assertEquals("Be equal",3628800,result);
     }