Pamiątka (memento) - wzorzec projektowy (design pattern)

I. Wzorce kreacyjne
1. Singleton
2. Budowniczy
3. Prototyp
4. Fabryka
5. Fabryka abstrakcyjna
II. Wzorce strukturalne
1. Adapter
2. Most
3. Kompozyt
4. Dekorator
5. Fasada
6. Pyłek
7. Pełnomocnik
III. Wzorce czynnościowe
1. Łańcuch zobowiązań
2. Polecenie
3. Interpreter
4. Iterator
5. Mediator
6. Pamiątka
7. Obserwator
8. Stan
9. Strategia
10. Metoda szablonowa
11. Odwiedzający

Pamiątka (memento) - wzorzec projektowy (design pattern) - java

1. Cel:
Wzorzec Pamiątka (memento) służy do uzewnętrznienia stan obiektu, zazwyczaj do dostarczenia funkcjonalność przywracania.
Użyty jest gdy chcemy przywrócić obiekt do poprzedniego stanu.
2. Problem:
Chcemy mieć możliwość powrócić do poprzedniego stanu obiektu.
Chcemy zaimplementować funkcję cofnij (undo) lub wycofaj (rollback).

3. Rozwiązanie:
Osiągamy to poprzez uzewnętrznienie obiektu w stan wewnętrzny, taki że można do niego później zwrócić.
Inna zaleta użycia tego wzorca powoduje że osłania on złożone elementy wewnętrzne przed innymi obiektami.
Wzorzec memento opiera się na trzech klasach: Originator, Memento i Caretaker.
Originator: to obiekt, dla którego musimy zapamiętać stan na wypadek, gdybyśmy musieli go kiedyś przywrócić.
Caretaker: jest to klasa odpowiedzialna za wyzwalanie zmian w inicjatorze lub za wyzwalanie akcji,
przez którą inicjator powraca do poprzedniego stanu.
Memento: Jest to klasa odpowiedzialna za przechowywanie wewnętrznego stanu inicjatora.

4. Diagram klas wzorca Pamiątka (memento):

5. Implementacja:
Klasa testująca:

public class MementoTest {
    public static void main(String[] args) {
 
        FileWriterCaretaker caretaker = new FileWriterCaretaker();
 
        FileWriterUtil fileWriter = new FileWriterUtil("data.txt");
        fileWriter.write("*Wypisanie pierwszej linii\n");
        System.out.println("Pierwsza edycja");
        System.out.print(fileWriter);
        System.out.println("zapisanie stanu i dodanie drugiej linii");
        caretaker.save(fileWriter);
        fileWriter.write("*Dopisanie drugiej linii\n");
        System.out.println("Wypisanie po drugiej edycji stanu");
        System.out.print(fileWriter);
        System.out.println("Przywrócenie starego stanu i wyświetlenie");
        caretaker.undo(fileWriter);
        System.out.print(fileWriter);
 
    }
}

// Caretaker
public class FileWriterCaretaker {
 
    private Memento obj;
 
    public void save(FileWriterUtil fileWriter) {
        this.obj = fileWriter.save();
    }
 
    public void undo(FileWriterUtil fileWriter) {
        fileWriter.revert(obj);
    }
}
 
// Originator
public class FileWriterUtil {
 
    private String fileName;
    private StringBuilder content;
 
    public FileWriterUtil(String file) {
        this.fileName = file;
        this.content = new StringBuilder();
    }
 
    @Override
    public String toString() {
        return this.content.toString();
    }
 
    public void write(String str) {
        content.append(str);
    }
 
    public Memento save() {
        return new Memento(this.fileName, this.content);
    }
 
    public void revert(Memento memento) {
        this.fileName = memento.getFileName();
        this.content = memento.getContent();
    }
}
 
// Memento
public class Memento {
    private String fileName;
    private StringBuilder content;
 
    public Memento(String file, StringBuilder content) {
        this.fileName = file;
        this.content = new StringBuilder(content);
    }
 
    public String getFileName() {
        return fileName;
    }
 
    public StringBuilder getContent() {
        return content;
    }
}

Wynik programu jest następujący:
Pierwsza edycja
*Wypisanie pierwszej linii
zapisanie stanu i dodanie drugiej linii
Wypisanie po drugiej edycji stanu
*Wypisanie pierwszej linii
*Dopisanie drugiej linii
Przywrócenie starego stanu i wyświetlenie
*Wypisanie pierwszej linii
6. Zastosowanie w kodzie java:
- java.util.Date
- java.io.Serializable
- javax.faces.component.StateHolder - wszystkie implementacje