Dave Jarvis' Repositories

git clone https://repo.autonoma.ca/repo/keenwrite.git

Document reason for XmlStorageHandler to exist

AuthorDaveJarvis <email>
Date2020-12-20 20:07:56 GMT-0800
Commit50d8ef5ee2c51c6ed9b58a00056351951d70c050
Parentf0521b6
Delta9 lines added, 0 lines removed, 9-line increase
src/main/java/com/keenwrite/preferences/XmlStorageHandler.java
package com.keenwrite.preferences;
+import com.dlsc.preferencesfx.PreferencesFx;
import com.dlsc.preferencesfx.util.StorageHandler;
import javafx.collections.ObservableList;
import java.util.prefs.Preferences;
+/**
+ * Prevents {@link PreferencesFx} from saving. Saving and loading preferences
+ * and application window state is accomplished by the {@link Workspace}.
+ * <p>
+ * This implies that undo/redo functionality must be disabled because the
+ * {@link Workspace} does not preserve previous states.
+ * </p>
+ */
public class XmlStorageHandler implements StorageHandler {
@Override