I've been a zone leader with DZone since 2008, and I'm crazy about community. Every day I get to work with the best that JavaScript, HTML5, Android and iOS has to offer, creating apps that truly make at difference, as principal front-end architect at Avego. James is a DZone Zone Leader and has posted 638 posts at DZone. You can read more from them at their website. View Full User Profile

Design Patterns Uncovered: The Memento Pattern

04.21.2010
| 24357 views |
  • submit to reddit

Today's pattern is the Memento pattern which is used in undo frameworks to bring an object back to a previous state.

Memento in the Real World 

In the real world, memento's are used a reminder or reference of how something should look. For example, if you decide to take a phone apart in order to replace an internal part, you may have an identical phone available that you use as a reference, ensuring you can take get the phone back to it's original state.

Design Patterns Refcard
For a great overview of the most popular design patterns, DZone's Design Patterns Refcard is the best place to start. 

The Memento Pattern

The Memento pattern is known as a behavioural pattern, as it's used to manage algorithms, relationships and responsibilities between objects.. The definition of Memento as provided in the original Gang of Four book on Design Patterns states: 

Captures and externalizes an object's internal state so that it can be restored later, all without violating encapsulation.

The following diagram shows how the memento pattern is modelled.

Let's take a look at each of the participants in this pattern. The Originator is the object that knows how to save itself: the class that you want to make stateful. The Caretaker is that object that deals with when, and why, the Originator needs to save or restore itself. The Memento holds the information about the Originator's state, and cannot be modified by the Caretaker.

The flow of events is that the Caretaker asks the Originator for the Memento object and performs any actions that it needs to. To rollback the state before these actions, it returns the memento object to the originator. 

When Would I Use This Pattern?

The Memento pattern is useful when you need to provide an undo mechanism in your applications, when the internal state of an object may need to be restored at a later stage. Using serialization along with this pattern, it's easy to preserve the object state and bring it back later on.

So How Does It Work In Java?

Let's use a simple example in Java to illustrate this pattern.As it's a pattern used for undo frameworks, we'll model a editor. 

First, the memento needs to be able to save editor contents, which will just be plain text: 

//Memento
public class EditorMemento
{

private final String editorState;

public EditorMemento(String state)
{
editorState = state;
}

public String getSavedState()
{
return editorState;
}

}

 

Now our Originator class, the editor, can use the memento:

 

//Originator

public class Editor
{

//state
public String editorContents;

public void setState(String contents)
{
this.editorContents = contents;
}

public EditorMemento save()
{
return new EditorMemento(editorContents);
}

public void restoreToState(EditorMemento memento)
{
editorContents = memento.getSavedState();
}

}

Anytime we want to save the state, we call the save() method, and an undo would call the restoreToState method.
Our caretaker can then keep track of all the memento's in a stack for the undo framework to work.

Watch Out for the Downsides

Some problems with this pattern is that the saving or restoring of state can be a time consuming process. Used incorrectly, it can expose the internal structure of your object, thus allowing any other object to change the state of your object.

 

Other Articles in This Series
The Observer Pattern
The Adapter Pattern
The Facade Pattern
The Factory Method Pattern
The Abstract Factory Pattern
The Singleton Pattern
The Strategy Pattern
The Visitor Pattern

The Decorator Pattern
The Proxy Pattern
The Command Pattern
The Chain of Responsibility Pattern

Next Up

As we start to near the end of the series, we'll look at the Mediator pattern next.

Tags:

Comments

Chris Sherlock replied on Sun, 2011/10/23 - 3:59am

Good article, only I tend to agree with the Wikipedia article that a nested class with a private constructor might be better for the Memento pattern.

Murtaza Khurshe... replied on Thu, 2012/12/20 - 4:00am

public void setState(String contents)

{
this.editorContents = contents;

}	
where are you calling this method ?

Comment viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.