diff --git a/template-method/src/main/java/com/iluwatar/App.java b/template-method/src/main/java/com/iluwatar/App.java index e44aa5b56..7fc10e327 100644 --- a/template-method/src/main/java/com/iluwatar/App.java +++ b/template-method/src/main/java/com/iluwatar/App.java @@ -2,8 +2,11 @@ package com.iluwatar; /** * - * Template Method (StealingMethod) defines skeleton for the algorithm and - * subclasses (HitAndRunMethod, SubtleMethod) fill in the blanks. + * Template Method defines a skeleton for an algorithm. The algorithm subclasses + * provide implementation for the blank parts. + * + * In this example HalflingThief contains StealingMethod that can be changed. + * First the thief hits with HitAndRunMethod and then with SubtleMethod. * */ public class App { diff --git a/template-method/src/main/java/com/iluwatar/HitAndRunMethod.java b/template-method/src/main/java/com/iluwatar/HitAndRunMethod.java index 99c0d61d1..bee01644b 100644 --- a/template-method/src/main/java/com/iluwatar/HitAndRunMethod.java +++ b/template-method/src/main/java/com/iluwatar/HitAndRunMethod.java @@ -1,5 +1,10 @@ package com.iluwatar; +/** + * + * HitAndRunMethod implementation of StealingMethod. + * + */ public class HitAndRunMethod extends StealingMethod { @Override diff --git a/template-method/src/main/java/com/iluwatar/StealingMethod.java b/template-method/src/main/java/com/iluwatar/StealingMethod.java index f0baabad6..759155b47 100644 --- a/template-method/src/main/java/com/iluwatar/StealingMethod.java +++ b/template-method/src/main/java/com/iluwatar/StealingMethod.java @@ -2,7 +2,7 @@ package com.iluwatar; /** * - * Template Method base class. + * StealingMethod defines skeleton for the algorithm. * */ public abstract class StealingMethod { diff --git a/template-method/src/main/java/com/iluwatar/SubtleMethod.java b/template-method/src/main/java/com/iluwatar/SubtleMethod.java index 830043075..a37616cb4 100644 --- a/template-method/src/main/java/com/iluwatar/SubtleMethod.java +++ b/template-method/src/main/java/com/iluwatar/SubtleMethod.java @@ -1,5 +1,10 @@ package com.iluwatar; +/** + * + * SubtleMethod implementation of StealingMethod. + * + */ public class SubtleMethod extends StealingMethod { @Override