Command design pattern

By Sidd Bhattacharjee -
Type : Behavioral Design Pattern

Summary

Command pattern separates the client which invokes a method from the object which contains the method.
Important points

 Command pattern decouples requestor (Invoker) of the action from the object that perform

 the action (Receiver).

 Command pattern can be used to do undo operations.

 Command pattern is useful when a history of requests is needed.

 Command pattern is useful when  \we need callback functionality

 Advantages
it decouples the client from the actual class who performs the operation.
We can create new commands to have new behaviour.
Undo operations can be designed with command pattern.

 Disadvantages
It increases the number of Classes.
If the Receiver class changes we would need to change the Command Class.

Details

Different  Objects participating  in the pattern are,

 Command - declares an interface for executing an operation;

 ConcreteCommand - extends the Command interface, implementing the execute method by invoking the corresponding operations on Receiver. It defines a link between the Receiver and the action.

 Client - creates a ConcreteCommand object and sets its receiver;

 Invoker - Holds Command Object and executes execute() method of the command object;

 Receiver - knows how to perform the operations;

Example

This example is about a Remote control receiver say like TV which accepts some kind of commands like turn on, turn of change channel etc.. 

Receiver is RemotecontrolReceiver Object which knows how to perform.
Invoker is DeliveryAgentInvoker Object which gets Command object and call execute() method on them.
Client can be assume like a remote control which actually has some action buttons (Command Objects ) and set them to Invoker (DeliveryAgentInvoker)

We have three command objects TurnOffCommand, TurnOnCommand and ChangeChannelCommand.

 Client sets the Commands in Invoker Object  and calls method in Invoker.

Class Diagram

Sample Code



// receiver Object
public class RemotecontrolReceiver {

 String currentChannel = "";
  
 public void turnOn() {
   System.out.println("turn on");
 }
 
 public void turnOff() {
   System.out.println("turn off");
 }

 public void changeChannel(String channel) {
   System.out.println("tune to channel " + channel);
   this.currentChannel = channel;
 }
 
}


// interface command
public interface Command {

  public void execute();

  public void undo();

}

public class TurnOffCommand implements Command {

  RemotecontrolReceiver remote;

  public TurnOffCommand(RemotecontrolReceiver o) {
    remote = o;
  }

  @Override
  public void execute() {
    this.remote.turnOff();
  }

  @Override
  public void undo() {

  }

}


public class TurnOnCommand implements Command {

  RemotecontrolReceiver remote;

  public TurnOnCommand(RemotecontrolReceiver o) {
    remote = o;
  }

  @Override
  public void execute() {
    remote.turnOn();
  }

  @Override
  public void undo() {
    
  }
  
}


// Invoker
public class DeliveryAgentInvoker {
  
  List deliveries = new ArrayList<>();

  public DeliveryAgentInvoker() {}

  public void deliver(Command orderDeliver) {
    deliveries.add(orderDeliver);
    orderDeliver.execute();
  }

}

public class Client {

  public static void main(String[] args) {
    
    RemotecontrolReceiver order = new RemotecontrolReceiver();
    DeliveryAgentInvoker dA = new DeliveryAgentInvoker();
    
    TurnOnCommand aC = new TurnOnCommand(order);
    TurnOffCommand rC = new TurnOffCommand(order);
    ChangeChannelCommand change = new ChangeChannelCommand(order, "2");
   
    dA.deliver(aC);
    dA.deliver(rC);
    dA.deliver(change);

  }

}

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 a sample to get String built
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