State

Allow an object to alter its behavior when its internal state changes. The object will appear to change its class.

Introduction

• State Pattern is a design pattern that belongs to the Behavioral Pattern group - design patterns that define common communication patterns between objects. From there, these patterns increase flexibility in implementing communication between objects.

• State Pattern is a behavioral design pattern that allows an object to change its behavior when its internal state changes.

• It is one of the Gang of Four designs.

• Frequency of use: average

Problem

The State pattern is closely related to the concept of a Finite-State Machine .

Finite-State Machine.

The main idea is that, at any given moment, there’s a finite number of states which a program can be in. Within any unique state, the program behaves differently, and the program can be switched from one state to another instantaneously. However, depending on a current state, the program may or may not switch to certain other states. These switching rules, called transitions, are also finite and predetermined.

You can also apply this approach to objects. Imagine that we have a Document class. A document can be in one of three states: Draft, Moderation and Published. The publish method of the document works a little bit differently in each state:

• In Draft, it moves the document to moderation.

• In Moderation, it makes the document public, but only if the current user is an administrator.

• In Published, it doesn’t do anything at all.

Possible states and transitions of a document object.

State machines are usually implemented with lots of conditional statements (if or switch) that select the appropriate behavior depending on the current state of the object. Usually, this “state” is just a set of values of the object’s fields. Even if you’ve never heard about finite-state machines before, you’ve probably implemented a state at least once. Does the following code structure ring a bell?

class Document is
    field state: string
    // ...
    method publish() is
        switch (state)
            "draft":
                state = "moderation"
                break
            "moderation":
                if (currentUser.role == "admin")
                    state = "published"
                break
            "published":
                // Do nothing.
                break
    // ...

The biggest weakness of a state machine based on conditionals reveals itself once we start adding more and more states and state-dependent behaviors to the Document class. Most methods will contain monstrous conditionals that pick the proper behavior of a method according to the current state. Code like this is very difficult to maintain because any change to the transition logic may require changing state conditionals in every method.

The problem tends to get bigger as a project evolves. It’s quite difficult to predict all possible states and transitions at the design stage. Hence, a lean state machine built with a limited set of conditionals can grow into a bloated mess over time.

Solution

The State pattern suggests that you create new classes for all possible states of an object and extract all state-specific behaviors into these classes.

Instead of implementing all behaviors on its own, the original object, called context, stores a reference to one of the state objects that represents its current state, and delegates all the state-related work to that object.

Document delegates the work to a state object.

To transition the context into another state, replace the active state object with another object that represents that new state. This is possible only if all state classes follow the same interface and the context itself works with these objects through that interface.

This structure may look similar to the Strategy pattern, but there’s one key difference. In the State pattern, the particular states may be aware of each other and initiate transitions from one state to another, whereas strategies almost never know about each other.

Real-World Analogy

The buttons and switches in your smartphone behave differently depending on the current state of the device:

• When the phone is unlocked, pressing buttons leads to executing various functions.

• When the phone is locked, pressing any button leads to the unlock screen.

• When the phone’s charge is low, pressing any button shows the charging screen.

Structure

Components in the model:

• Context: As a class with many states, class behavior will be changed by state. Used by Client. Client does not directly access the Object's State. This Context class contains information about the ConcreteState object, telling which behavior corresponds to which state is currently being executed

• State Interface: Is the interface or abstract class that defines the basic characteristics of all ConcreteState Objects. They will be used by the Context object to access mutable functionality.

• Concrete States: Is a specific class of state corresponding to each state of the context

• Both Context and ConcreteState can set the next state of the context and perform the actual state transition by replacing the state object associated with the context.

In this example, the State Pattern allows the media player controls to behave differently, depending on the current playback state.

The player's main object is always associated with a state object that does most of the work for the player. Some actions replace the player's current state object with another object, which changes how the player reacts to user interactions.

Advantages & disadvantages

Advantage

• Ensure the Single Responsibility principle (SRP): Separate each State corresponding to a separate class.

• Ensuring the Open/Closed Principle (OCP): we can add a new State without affecting other States or existing Contexts.

• Keep specific behavior corresponding to each State.

• Helps transfer State clearly.

• Eliminating case statements (If, Switch case) helps simplify the context code

Disadvantage

• Using the state pattern can be overkill if the state machine only has a few states or rarely changes which can lead to increased code complexity.

When to use it

• Use the State pattern when you have an object that behaves differently depending on its current state, the number of states is very large, and the code of the particular state changes frequently.

• Use the State pattern when you have a class with many large conditions that change the way the class behaves according to the current values ​​of the class's fields.

• Use the State Pattern when you have a lot of code that overlaps across similar states and transitions of the State Pattern based on conditions.

• Change object behavior based on object state

• Replaces the use of lots of conditions that change how the class acts based on the class's values

Applicability

• Use the State pattern when you have an object that behaves differently depending on its current state, the number of states is enormous, and the state-specific code changes frequently.

  • The pattern suggests that you extract all state-specific code into a set of distinct classes. As a result, you can add new states or change existing ones independently of each other, reducing the maintenance cost.

• Use the pattern when you have a class polluted with massive conditionals that alter how the class behaves according to the current values of the class’s fields.

  • The State pattern lets you extract branches of these conditionals into methods of corresponding state classes. While doing so, you can also clean temporary fields and helper methods involved in state-specific code out of your main class.

• Use State when you have a lot of duplicate code across similar states and transitions of a condition-based state machine.

  • The State pattern lets you compose hierarchies of state classes and reduce duplication by extracting common code into abstract base classes.

How to Implement

1. Decide what class will act as the context. It could be an existing class which already has the state-dependent code; or a new class, if the state-specific code is distributed across multiple classes.

2. Declare the state interface. Although it may mirror all the methods declared in the context, aim only for those that may contain state-specific behavior.

3. For every actual state, create a class that derives from the state interface. Then go over the methods of the context and extract all code related to that state into your newly created class.

   While moving the code to the state class, you might discover that it depends on private members of the context. There are several workarounds:

   • Make these fields or methods public.

   • Turn the behavior you’re extracting into a public method in the context and call it from the state class. This way is ugly but quick, and you can always fix it later.

   • Nest the state classes into the context class, but only if your programming language supports nesting classes.

4. In the context class, add a reference field of the state interface type and a public setter that allows overriding the value of that field.

5. Go over the method of the context again and replace empty state conditionals with calls to corresponding methods of the state object.

6. To switch the state of the context, create an instance of one of the state classes and pass it to the context. You can do this within the context itself, or in various states, or in the client. Wherever this is done, the class becomes dependent on the concrete state class that it instantiates.

Relations with Other Patterns

• Bridge, State, Strategy (and to some degree Adapter) have very similar structures. Indeed, all of these patterns are based on composition, which is delegating work to other objects. However, they all solve different problems. A pattern isn’t just a recipe for structuring your code in a specific way. It can also communicate to other developers the problem the pattern solves.
• State can be considered as an extension of Strategy. Both patterns are based on composition: they change the behavior of the context by delegating some work to helper objects. Strategy makes these objects completely independent and unaware of each other. However, State doesn’t restrict dependencies between concrete states, letting them alter the state of the context at will.