State Pattern

The State Pattern is one of the Behavioral Design Patterns, which focuses on allowing objects to alter their behavior when their internal state changes. In our previous lessons, we explored other behavioral patterns like Observer and Command . The State Pattern continues this journey by giving objects the ability to change their behavior dynamically.

Key Concepts You Will Learn

Before diving into the implementation, let's outline what you'll learn in this lesson. In this lesson, you will learn: The fundamentals of the State Pattern. How to implement the State Pattern in Java. The practical applications and importance of using the State Pattern. Let's get started!

Understanding and Implementing the State Pattern

The State Pattern is a behavioral design pattern that allows an object to change its behavior when its internal state changes. This pattern is particularly useful for objects that can exist in multiple states and need to transition between them, altering their behavior dynamically based on the current state. By encapsulating state-specific behavior within separate classes, the State Pattern promotes cleaner, more maintainable code and simplifies the management of an object's state transitions. Let's break down the example of a Music Player context, which will illustrate how the State Pattern is used to manage the player's behavior based on its state. In this example, we'll create a music player that can be in one of several states: playing, paused, or stopped. Each state will define how the player should behave when various actions are performed.

Defining the State Interface

The first step in implementing the State Pattern is to create an interface that defines all possible actions. Here's how we define our State interface: Java public interface State {void play(MusicPlayerContext context); void pause(MusicPlayerContext context); void stop(MusicPlayerContext context); String getName();} This interface serves as a contract for all concrete states, ensuring they implement all necessary methods. The inclusion of the getName() method allows us to track state transitions and provide meaningful feedback during state changes.

Join the 1M+ learners on CodeSignal

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

Java

public class PlayingState implements State {
    @Override
    public void play(MusicPlayerContext context) {
        System.out.println("Already playing.");
    }

    @Override
    public void pause(MusicPlayerContext context) {
        System.out.println("Pausing music.");
        context.setState(new PausedState());
    }

    @Override
    public void stop(MusicPlayerContext context) {
        System.out.println("Stopping music.");
        context.setState(new StoppedState());
    }

    @Override
    public String getName() {
        return "Playing State";
    }
}

public class PlayingState implements State {
    @Override
    public void play(MusicPlayerContext context) {
        System.out.println("Already playing.");
    }

    @Override
    public void pause(MusicPlayerContext context) {
        System.out.println("Pausing music.");
        context.setState(new PausedState());
    }

    @Override
    public void stop(MusicPlayerContext context) {
        System.out.println("Stopping music.");
        context.setState(new StoppedState());
    }

    @Override
    public String getName() {
        return "Playing State";
    }
}

Java

public class MusicPlayerContext {
    private State state;

    public MusicPlayerContext() {
        // Initial state is stopped
        this.state = new StoppedState();
    }

    public void setState(State state) {
        System.out.println("Transitioning from " + this.state.getName() + 
                          " to " + state.getName());
        this.state = state;
    }

    public void play() {
        state.play(this);
    }

    public void pause() {
        state.pause(this);
    }

    public void stop() {
        state.stop(this);
    }

    public State getCurrentState() {
        return state;
    }
}

public class MusicPlayerContext {
    private State state;

    public MusicPlayerContext() {
        // Initial state is stopped
        this.state = new StoppedState();
    }

    public void setState(State state) {
        System.out.println("Transitioning from " + this.state.getName() + 
                          " to " + state.getName());
        this.state = state;
    }

    public void play() {
        state.play(this);
    }

    public void pause() {
        state.pause(this);
    }

    public void stop() {
        state.stop(this);
    }

    public State getCurrentState() {
        return state;
    }
}

Java

public class Main {
    public static void main(String[] args) {
        MusicPlayerContext player = new MusicPlayerContext();

        // Initial state is stopped
        System.out.println("Initial state: " + player.getCurrentState().getName());

        // Start playing
        player.play();  // Outputs: Starting music. Transitioning from Stopped State to Playing State

        // Try to play again
        player.play();  // Outputs: Already playing.

        // Pause
        player.pause(); // Outputs: Pausing music. Transitioning from Playing State to Paused State

        // Resume
        player.play();  // Outputs: Resuming music. Transitioning from Paused State to Playing State

        // Stop
        player.stop();  // Outputs: Stopping music. Transitioning from Playing State to Stopped State
    }
}

public class Main {
    public static void main(String[] args) {
        MusicPlayerContext player = new MusicPlayerContext();

        // Initial state is stopped
        System.out.println("Initial state: " + player.getCurrentState().getName());

        // Start playing
        player.play();  // Outputs: Starting music. Transitioning from Stopped State to Playing State

        // Try to play again
        player.play();  // Outputs: Already playing.

        // Pause
        player.pause(); // Outputs: Pausing music. Transitioning from Playing State to Paused State

        // Resume
        player.play();  // Outputs: Resuming music. Transitioning from Paused State to Playing State

        // Stop
        player.stop();  // Outputs: Stopping music. Transitioning from Playing State to Stopped State
    }
}

Java

public class PlayingState implements State {
    @Override
    public void play(MusicPlayerContext context) {
        System.out.println("Already playing.");
    }

    @Override
    public void pause(MusicPlayerContext context) {
        System.out.println("Pausing music.");
        context.setState(new PausedState());
    }

    @Override
    public void stop(MusicPlayerContext context) {
        System.out.println("Stopping music.");
        context.setState(new StoppedState());
    }

    @Override
    public String getName() {
        return "Playing State";
    }
}

Java

public class MusicPlayerContext {
    private State state;

    public MusicPlayerContext() {
        // Initial state is stopped
        this.state = new StoppedState();
    }

    public void setState(State state) {
        System.out.println("Transitioning from " + this.state.getName() + 
                          " to " + state.getName());
        this.state = state;
    }

    public void play() {
        state.play(this);
    }

    public void pause() {
        state.pause(this);
    }

    public void stop() {
        state.stop(this);
    }

    public State getCurrentState() {
        return state;
    }
}

Java

public class Main {
    public static void main(String[] args) {
        MusicPlayerContext player = new MusicPlayerContext();

        // Initial state is stopped
        System.out.println("Initial state: " + player.getCurrentState().getName());

        // Start playing
        player.play();  // Outputs: Starting music. Transitioning from Stopped State to Playing State

        // Try to play again
        player.play();  // Outputs: Already playing.

        // Pause
        player.pause(); // Outputs: Pausing music. Transitioning from Playing State to Paused State

        // Resume
        player.play();  // Outputs: Resuming music. Transitioning from Paused State to Playing State

        // Stop
        player.stop();  // Outputs: Stopping music. Transitioning from Playing State to Stopped State
    }
}

State Pattern

Key Concepts You Will Learn

Understanding and Implementing the State Pattern

Defining the State Interface

Join the 1M+ learners on CodeSignal

Implementing Concrete States

Creating the Context Class

Using the State Pattern

Importance of the State Pattern

Ready to Practice?