Memento pattern

related topics
{math, number, function}
{government, party, election}
{style, bgcolor, rowspan}
{build, building, house}
{food, make, wine}
{mi², represent, 1st}

The memento pattern is a software design pattern that provides the ability to restore an object to its previous state (undo via rollback).

The memento pattern is used by two objects: the originator and a caretaker. 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 (or sequence of operations) 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 (one which the caretaker cannot, or should not, change). 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 the seed of a pseudorandom number generator (it will always produce the same sequence thereafter when initialized with the seed state) and the state in a finite state machine.


The following Java program illustrates the "undo" usage of the Memento Pattern.

import java.util.List;
import java.util.ArrayList;
class Originator {
    private String state;
    // The class could also contain additional data that is not part of the
    // state saved in the memento.
    public void set(String state) {
        System.out.println("Originator: Setting state to " + state);
        this.state = state;
    public Memento saveToMemento() {
        System.out.println("Originator: Saving to Memento.");
        return new Memento(state);
    public void restoreFromMemento(Memento memento) {
        state = memento.getSavedState();
        System.out.println("Originator: State after restoring from Memento: " + state);
    public static class Memento {
        private final String state;
        private Memento(String stateToSave) {
            state = stateToSave;
        private String getSavedState() {
            return state;
class Caretaker {
    public static void main(String[] args) {
        List<Originator.Memento> savedStates = new ArrayList<Originator.Memento>();
        Originator originator = new Originator();
        // We can request multiple mementos, and choose which one to roll back to.

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


Full article ▸

related documents
Congruence relation
Convolution theorem
Toeplitz matrix
CYK algorithm
Normal subgroup
Quaternion group
List of logarithmic identities
Interior (topology)
Hidden Markov model
Bézout's theorem
Identity element
Box-Muller transform
Inverse element
Parity (mathematics)
Event (probability theory)
De Moivre's formula
Infinite product
Euphoria (programming language)
Nash embedding theorem
Uncountable set
Convex hull
Chomsky normal form
Linear congruential generator