Template Method Design Pattern

By Sidd Bhattacharjee -

Type : Behavioral Design Pattern

Summary
Template method pattern defines some steps or sequences of procedure and defers implementations of the procedures to the subclasses to implement.

Details
Template method uses in real life is very common.

For instance we want to order some product online, first we have to select product and then add it to cart, then checkout.

Another example would be when we go to a movie theater,  we first decide the show, buy the ticket and that go to the respective screen to enjoy the movie, and finally leave the theater.

When the work can broken in to sub tasks and order of the tasks are important Template method helps in maintaining that order.

Another example would be our day to day routine. We can break the day in several sequence of tasks that we want to carry out.

DayRoutine : Abstract class which declares some tasks like wakeup(), doBreakFast() gotoBed() etc.
                        To maintain the order it also has a final method doDayTask().  Here doDayTask() is
                        the template method.

WeekDayRoutine : Concrete routine for week day, which extends the DayRoutine class.
WeekEndRoutine : Concrete routine for weekend, which extends the DayRoutine class.

Class Diagram


Sample Code

// abstract class which implements the template method
public abstract class DailyRoutine {

  public final void doDayTask() {
    wakeup();
    doBreakfast();
    doAssignment();
    doEntertainment();
    gotoBed();
  }

  public final void wakeup() {
    System.out.println("Wake Up");
  }

  public abstract void doBreakfast();

  public abstract void doAssignment();

  public abstract void doEntertainment();

  public abstract void gotoBed();
}

public class WeekDayRoutine extends DailyRoutine {

  @Override
  public void doBreakfast() {
    System.out.println(" Eat Veggy weekday Breakfast");
  }

  @Override
  public void doAssignment() {
    System.out.println("Complete School Assignment");
  }

  @Override
  public void doEntertainment() {
    System.out.println("Nothing");
  }

  @Override
  public void gotoBed() {
    System.out.println("Sleep at 9:02 PM");
  }

}

public class WeekendRoutine extends DailyRoutine{

  @Override
  public void doBreakfast() {
    System.out.println(" Eat Protein Breakfast");
  }

  @Override
  public void doAssignment() {
    System.out.println("do Laundry, Iron, and Vaccum");
  }

  @Override
  public void doEntertainment() {
    System.out.println("Watch Netflix");
  }

  @Override
  public void gotoBed() {
    System.out.println("Goto bed at 11:00 PM");
  }

}

Comments

Post a Comment

Popular posts from this blog

Difference between volatile and synchronized

By -
volatile is a field modifier, while synchronized modifies code blocks and methods. So we can specify three variations of a simple accessor using those two keywords: int i1; int geti1() {return i1;} volatile int i2; int geti2() {return i2;} int i3; synchronized int geti3() {return i3;} geti1() accesses the value currently stored in i1 in the current thread . Threads can have local copies of variables, and the data does not have to be the same as the data held in other threads. In particular, another thread may have updated i1 in it's thread, but the value in the current thread could be different from that updated value. In fact Java has the idea of a "main" memory, and this is the memory that holds the current "correct" value for variables. Threads can have their own copy of data for variables, and the thread copy can be different from the "main" memory. So in fact, it is possible for the "main...
Read more

Converting Java Map to String

By -
Java Collections framework, String manipulation etc is something that we often encounter in Development process. For processing collections (like checking null/empty, Intersection, Disjunction) We do have some of the very use full libraries. Some of the Collection related libraries are Apche Commons Collections and Google  Collections(Guava). Problem Use Case This article explains how to convert a Java Map to String(and vice versa) using different libraries and technique. One way is to use StringBuilder(Or String) and loop though the Map and build the String by applying some sort of separator ( for key:value and entry). Here we have to take care of the null value etc. Without Any Library If we want to convert the map to a String with key value separator and also individual entry seperator in the resulting String, we have to write code for that. For a simple Map, we have to iterate though the map, take care of the null values etc. Following is...
Read more

Masking Credit Card number in Java

By -
Sometimes we need to mask crucial information like Credit Card Numbers, CVV numbers etc before storing  or logging the information. This example mask Credit Card Number (Except last 4 Digit) from a Text which contains information along with Credit Card Number. The following example demonstrates how we can easily mask the credit card with Matcher and Pattern Classes. This Sample Code uses Matcher and Pattern. Pattern Used in this sample is not optimized for Credit Card Numbers, this pattern will get any numerical numbers in the String Content.  Based on the Credit Card Type a more efficient and Strict RegEx can be used to mask the Credit Card. /**Mask the Credit card number but last four digit value **/   Pattern PATTERN = Pattern.compile( "[0-9]+" ); String message = content; Matcher matcher = PATTERN.matcher(message); String maskingChar = "*"; StringBuilder finalMask = new StringBuilder(maskingChar...
Read more