Memento pattern


The memento pattern is a software design pattern that exposes the private internal state of an object.
One example of how this can be used is to restore an object to its previous state, another is versioning, another is custom serialization.
The memento pattern is implemented with three objects: the originator, a caretaker and a memento. The originator is some object that has an internal state. The caretaker is going to do something to the originator, but wants to be able to undo the change. The caretaker first asks the originator for a memento object. Then it does whatever operation it was going to do. To roll back to the state before the operations, it returns the memento object to the originator. The memento object itself is an opaque object. When using this pattern, care should be taken if the originator may change other objects or resources—the memento pattern operates on a single object.
Classic examples of the memento pattern include a pseudorandom number generator with the same seed and the state in a finite state machine.

Structure

UML class and sequence diagram

In the above UML class diagram,
the Caretaker class refers to the Originator class
for saving and restoring originator's internal state.
The Originator class implements
createMemento by creating and returning a Memento object that stores originator's current internal state
and
restore by restoring state from the passed in Memento object.
The UML sequence diagram
shows the run-time interactions:
Saving originator's internal state: The Caretaker object calls createMemento on the Originator object,
which creates a Memento object, saves
its current internal state, and returns the Memento to the Caretaker.
Restoring originator's internal state: The Caretaker calls restore on the Originator object and specifies the Memento object that stores the state that should be restored. The Originator gets the state from the Memento to set its own state.

Java example

The following Java program illustrates the "undo" usage of the memento pattern.

package org.wikipedia.examples;
import java.util.ArrayList;
import java.util.List;
class Originator
class Caretaker

The output is:
Originator: Setting state to State1
Originator: Setting state to State2
Originator: Saving to Memento.
Originator: Setting state to State3
Originator: Saving to Memento.
Originator: Setting state to State4
Originator: State after restoring from Memento: State3
This example uses a String as the state, which is an immutable object in Java. In real-life scenarios the state will
almost always be a mutable object, in which case a copy of the state must be made.
It must be said that the implementation shown has a drawback: it declares an internal class. It would be better if this memento strategy could apply to more than one originator.
There are mainly three other ways to achieve Memento:
  1. Serialization.
  2. A class declared in the same package.
  3. The object can also be accessed via a proxy, which can achieve any save/restore operation on the object.

C# example

The memento pattern allows one to capture the internal state of an object without violating encapsulation such that later one can undo/revert the changes if required. Here one can see that the memento object is actually used to revert the changes made in the object.

namespace Wikipedia.Examples;
class Memento
class Caretaker

Python example


"""
Memento pattern example.
"""
class Originator:
state: str = ""
def set -> None:
print
self.state = state
def save_to_memento -> "Memento":
return self.Memento
def restore_from_memento -> None:
self.state = memento.get_saved_state
print
class Memento:
state: str
def __init__ -> None:
self.state = state
def get_saved_state -> str:
return self.state
saved_states: list =
originator: Originator = Originator
originator.set
originator.set
saved_states.append)
originator.set
saved_states.append)
originator.set
originator.restore_from_memento

JavaScript example


// The Memento pattern is used to save and restore the state of an object.
// A memento is a snapshot of an object's state.
let Memento = ;
// The Originator is the object that creates the memento.
// defines a method for saving the state inside a memento.
let Originator = ;
// The Caretaker stores mementos of the objects and
// provides operations to retrieve them.
let Caretaker = ;
let action_step = "Foo"; // The action to be executed/the object state to be stored.
let action_step_2 = "Bar"; // The action to be executed/the object state to be stored.
// set the initial state
Originator.state = action_step;
Caretaker.addMemento);// save the state to the history
console.log; // Foo
// change the state
Originator.state = action_step_2;
Caretaker.addMemento); // save the state to the history
console.log; // Bar
// restore the first state - undo
Originator.setMemento;
console.log; // Foo
// restore the second state - redo
Originator.setMemento;
console.log; // Bar