qMerge branch 'master' of https://github.com/gazbert/java-design-patterns

Author: gazbert

src/main/java/com/gazbert/patterns/behavioural/template/AmericanGrowthFund.java

@@ -22,15 +22,17 @@ this software and associated documentation files (the "Software"), to deal in
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.*/
 
 import java.math.BigDecimal;
+import java.util.Arrays;
+import java.util.List;
 
 /**
+ * The American Fund and its implementation of the template method hooks.
  * 
  * @author gazbert
  *
  */
 public class AmericanGrowthFund extends FundInfoCollectionTemplate
 {
-
     @Override
     protected String getFundName()
     {
@@ -60,4 +62,10 @@ protected String getFundCurrency()
         return "USD";
     }
 
+    @Override
+    protected List<String> getHoldings()
+    {
+        final String[] holdings = { "IBM", "Bank Of America", "Oracle", "Chevron"};
+        return Arrays.asList(holdings);
+    }
 }

src/main/java/com/gazbert/patterns/behavioural/template/FundInfoCollectionTemplate.java

@@ -23,6 +23,7 @@ this software and associated documentation files (the "Software"), to deal in
 
 import java.math.BigDecimal;
 import java.text.DecimalFormat;
+import java.util.List;
 
 /**
  * This is the main abstract template class.
@@ -40,6 +41,7 @@ public abstract class FundInfoCollectionTemplate
     protected abstract String getFundType();
     protected abstract String getFundGoal();
     protected abstract BigDecimal calculateManagementFee();
+    protected abstract List<String> getHoldings(); 
 
     // Here we have a hook with a default impl.
     protected String getFundCurrency()
@@ -60,8 +62,15 @@ public final void collectFundInformationForCatalogue()
         System.out.println("Fund Type: " + getFundType());
         System.out.println("Fund Goal: " + getFundGoal());
         System.out.println("Fund Currency: " + getFundCurrency());
-        System.out.println("Fund Management Fee: " + new DecimalFormat("#.###").format(calculateManagementFee()) + "%");        
+        System.out.println("Fund Management Fee: " + new DecimalFormat("#.###").format(calculateManagementFee()) + "%");
 
-        System.out.println("END of main template method.\n");
+        System.out.print("Fund Holdings: ");
+        final List<String> fundHoldings = getHoldings();
+        for (final String stock : fundHoldings)
+        {
+            System.out.print(stock + ", ");
+        }
+        
+        System.out.println("\nEND of main template method.\n");
     }
 }

src/main/java/com/gazbert/patterns/behavioural/template/JapanSpecialSituationsFund.java

@@ -22,15 +22,18 @@ this software and associated documentation files (the "Software"), to deal in
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.*/
 
 import java.math.BigDecimal;
+import java.util.Arrays;
+import java.util.List;
 
 /**
+ * 
+ * The Japanese Special Sits Fund and its implementation of the template method hooks.
  * 
  * @author gazbert
  *
  */
 public class JapanSpecialSituationsFund extends FundInfoCollectionTemplate
 {
-
     @Override
     protected String getFundName()
     {
@@ -59,4 +62,11 @@ protected String getFundCurrency()
     {
         return "JPY";
     }    
+    
+    @Override
+    protected List<String> getHoldings()
+    {
+        final String[] holdings = { "Mitsuba", "Sinko", "Nissei", "Hazama"};
+        return Arrays.asList(holdings);
+    }
 }

src/main/java/com/gazbert/patterns/behavioural/template/UkAllShareTrackingFund.java

@@ -22,15 +22,17 @@ this software and associated documentation files (the "Software"), to deal in
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.*/
 
 import java.math.BigDecimal;
+import java.util.Arrays;
+import java.util.List;
 
 /**
+ * The UK FTSE All Share Tracker Fund and its implementation of the template method hooks.
  * 
  * @author gazbert
  *
  */
 public class UkAllShareTrackingFund extends FundInfoCollectionTemplate
 {
-
     @Override
     protected String getFundName()
     {
@@ -54,4 +56,11 @@ protected BigDecimal calculateManagementFee()
     {
         return new BigDecimal(0.01);
     }
+    
+    @Override
+    protected List<String> getHoldings()
+    {
+        final String[] holdings = { "BP", "HSBC", "John Lewis", "Virgin"};
+        return Arrays.asList(holdings);
+    }
 }

src/main/java/com/gazbert/patterns/behavioural/template/UkMidCapEquityFund.java

@@ -22,15 +22,17 @@ this software and associated documentation files (the "Software"), to deal in
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.*/
 
 import java.math.BigDecimal;
+import java.util.Arrays;
+import java.util.List;
 
 /**
+ * The UK Mid Caps (FTSE 250) Fund and its implementation of the template method hooks.
  * 
  * @author gazbert
  *
  */
 public class UkMidCapEquityFund extends FundInfoCollectionTemplate
 {
-
     @Override
     protected String getFundName()
     {
@@ -54,4 +56,11 @@ protected BigDecimal calculateManagementFee()
     {
         return new BigDecimal(0.014);
     }
+    
+    @Override
+    protected List<String> getHoldings()
+    {
+        final String[] holdings = { "Aston Martin", "Harrods", "Telegraph Media Group", "Ocado"};
+        return Arrays.asList(holdings);
+    }
 }

src/main/java/com/gazbert/patterns/behavioural/template/package-info.java

@@ -8,7 +8,7 @@
  * flow of the behaviour and call down to the subclasses to provide specific behaviour.  The template
  * pattern <em>must</em> be final in order to prevent subclasses from changing the overall behaviour.
  * <p>
- * Some of the hooks can have default behaviour - in case the subclasses choose not to override them - but
+ * It makes use of the 'Hollywood Principle' - don't call us, we'll call you. Some of the hooks can have default behaviour - in case the subclasses choose not to override them - but
  * there should always be at least 1 abstract hook to in a Template pattern.
  * <p>
  * One final thing, the hook methods should have protected access - only subclasses should be able to use them. They are