Command Pattern in Kotlin

Command Pattern

Welcome to the lesson on the Command Pattern! This pattern is an essential part of Behavioral Design Patterns and focuses on encapsulating a request as an object. In this way, you can parameterize clients with different requests, queue them, log them, and even support undo operations. It's commonly used in scenarios where you need to decouple the object that invokes an operation from the object that performs it.

What You Will Learn

In this lesson, you will: Understand the basics of the Command Pattern . Learn how to implement this pattern in Kotlin . Recognize the significance of the Command Pattern in real-world applications.

Implementing the Command Pattern

The Command Pattern is a behavioral design pattern that turns a request into a stand-alone object that contains all the information about the request. This transformation allows you to parameterize methods with different requests, queue requests, and log their execution, among other things. At its core, it decouples the object that initiates an action from the object that performs the action. Let's break down the implementation step-by-step using our example of a remote control for a light. We'll create commands to turn the light on and off, demonstrating the flexibility and reusability of the Command Pattern .

Step 1: Define the Command Interface

Kotlin interface Command {fun execute()} The Command interface defines a function called execute, which encapsulates an action. Any class implementing this interface must provide an implementation for the execute method.

Step 2: Implement the Receiver Class

Kotlin class Light {fun on() {println("Light is on.")} fun off() {println("Light is off.")}} The Light class is our receiver. It contains the business logic to turn the light on or off.

Step 3: Implement a Concrete Command for Turning the Light On

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

Kotlin

class LightOnCommand(private val light: Light) : Command {
    override fun execute() {
        light.on()
    }
}

class LightOnCommand(private val light: Light) : Command {
    override fun execute() {
        light.on()
    }
}

The LightOnCommand class implements the Command interface. It has a reference to the Light object and calls its on method when execute is invoked.

Kotlin

class LightOffCommand(private val light: Light) : Command {
    override fun execute() {
        light.off()
    }
}

class LightOffCommand(private val light: Light) : Command {
    override fun execute() {
        light.off()
    }
}

The LightOffCommand class also implements the Command interface. It has a reference to the Light object and calls its off method when execute is invoked.

Kotlin

class RemoteControl {
    private var command: Command? = null

    fun setCommand(command: Command) {
        this.command = command
    }

    fun pressButton() {
        command?.execute()
    }
}

class RemoteControl {
    private var command: Command? = null

    fun setCommand(command: Command) {
        this.command = command
    }

    fun pressButton() {
        command?.execute()
    }
}

The RemoteControl class acts as the invoker. It holds a reference to a Command object and executes it when the button is pressed.

Kotlin

fun main() {
    val light = Light()
    val lightOn = LightOnCommand(light)
    val lightOff = LightOffCommand(light)

    val remote = RemoteControl()
    remote.setCommand(lightOn)
    remote.pressButton()  // Outputs: Light is on.
    remote.setCommand(lightOff)
    remote.pressButton()  // Outputs: Light is off.
}

fun main() {
    val light = Light()
    val lightOn = LightOnCommand(light)
    val lightOff = LightOffCommand(light)

    val remote = RemoteControl()
    remote.setCommand(lightOn)
    remote.pressButton()  // Outputs: Light is on.
    remote.setCommand(lightOff)
    remote.pressButton()  // Outputs: Light is off.
}

In the main function, we create the Light receiver and the LightOnCommand and LightOffCommand concrete commands. We then create a RemoteControl invoker, set the commands, and execute them to see the results.

The Command Pattern is especially useful for:

Decoupling: It decouples the object that requests an operation (invoker) from the one that actually performs the operation (receiver).
Reusability: Commands can be reused and combined in complex scenarios, enhancing code maintainability and flexibility.
History and Undo: It allows for the addition of history and undo features, crucial in applications like text editors, where users may want to revert actions.
Logging: Commands can be logged, enabling actions to be recorded and replayed. This is useful for debugging and auditing purposes.

By the end of this lesson, you'll be more confident in applying the Command Pattern to your projects. Are you ready to practice and see this pattern in action? Let's move on to the practice section and enhance your coding skills!

Command Pattern

What You Will Learn

Implementing the Command Pattern

Step 1: Define the Command Interface

Step 2: Implement the Receiver Class

Step 3: Implement a Concrete Command for Turning the Light On

Join the 1M+ learners on CodeSignal

Step 4: Implement a Concrete Command for Turning the Light Off

Step 5: Implement the Invoker Class

Step 6: Putting It All Together in the Main Function

Why It Is Important