Package org.smooks.api.memento

Interface Memento

All Known Implementing Classes:

AbstractVisitorMemento, ConsumeSerializerVisitor.ElementMemento, SimpleVisitorMemento, TextAccumulatorMemento, TextAccumulatorVisitorMemento, VisitorMemento

public interface Memento

Holds the state of a Visitor.

A Memento is saved and restored it at a later stage. A Memento is bound to a Visitor and its fragment (e.g., Fragment). Management of Mementos should be delegated to MementoCaretaker.

Method Summary

Modifier and Type	Method	Description
Memento	copy()	Performs a deep clone of this Memento.
String	getAnchor()	Gets the anchor value of this Memento.
Fragment<?>	getFragment()
void	restore(Memento memento)	Combines a Memento state with this Memento

Method Detail

copy

Memento copy()

Performs a deep clone of this Memento.

Returns:

a deep clone of this Memento

restore

void restore(Memento memento)

Combines a Memento state with this Memento

Parameters:

memento - the Memento restoring this Memento

getFragment

Fragment<?> getFragment()

Returns:

the fragment which this Memento is bound to

getAnchor

String getAnchor()

Gets the anchor value of this Memento. Mementos with equal anchor values are considered to be capturing the state of the same object but at different points in time.

Returns:

the ID of this Memento