This object is used to store/restore editor state between restarts.
For example, text editor can store caret position, scroll position,
information about folded regions, etc.
Undo subsystem expects a sensible implementation of Object.equals(Object)
method of state instances.
In particular, state1
and state2
in the following situation
FileEditorState state1 = fileEditor.getState(FileEditorStateLevel.UNDO);
...
fileEditor.setState(state1);
FileEditorState state2 = fileEditor.getState(FileEditorStateLevel.UNDO);
are expected to be 'equal'.