PMD Preferences are overridden and lost

Fixes #46

Author: adangel

ReleaseNotes.md

@@ -28,6 +28,7 @@ Eclipse Update Site:
 *   [#32](https://github.com/pmd/pmd-eclipse-plugin/issues/32): Upgrade PMD to 6.2.0
 *   [#42](https://github.com/pmd/pmd-eclipse-plugin/issues/42): Marker colors not updated in all views after change
 *   [#43](https://github.com/pmd/pmd-eclipse-plugin/issues/43): Update unit tests to use new ruleset categories
+*   [#46](https://github.com/pmd/pmd-eclipse-plugin/issues/46): PMD Preferences are overridden and lost
 
 ### External Contributions
 

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/preferences/IPreferences.java

@@ -74,6 +74,10 @@ public interface IPreferences {
 
     boolean GLOBAL_RULE_MANAGEMENT_DEFAULT = false;
 
+    int TABLE_FRACTION_DEFAULT = 55;
+    boolean DEFAULT_SORT_UP = false;
+    String DEFAULT_GROUPING_COLUMN = "";
+
     /**
      * Get a comma-separated list of rules that are active by default.
      */
@@ -278,4 +282,28 @@ public interface IPreferences {
      */
     void sync();
 
+    int tableFraction();
+
+    void tableFraction(int aFraction);
+
+    Set<String> getHiddenColumnIds();
+
+    void setHiddenColumnIds(Set<String> names);
+
+    boolean isSortDirectionUp();
+
+    void setSortDirectionUp(boolean isUp);
+
+    String getGroupingColumn();
+
+    void setGroupingColumn(String columnName);
+
+    Set<String> getSelectedRuleNames();
+
+    void setSelectedRuleNames(Set<String> ruleNames);
+
+    int getSelectedPropertyTab();
+
+    void setSelectedPropertyTab(int anIndex);
+
 }

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/preferences/impl/PreferenceUIStore.java

@@ -1,158 +1,88 @@
 
 package net.sourceforge.pmd.eclipse.runtime.preferences.impl;
 
-import java.io.IOException;
-import java.util.Collection;
-import java.util.HashSet;
 import java.util.Set;
 
-import org.eclipse.core.resources.IWorkspaceRoot;
-import org.eclipse.core.resources.ResourcesPlugin;
-import org.eclipse.core.runtime.IPath;
-import org.eclipse.jface.preference.PreferenceStore;
-
 import net.sourceforge.pmd.eclipse.plugin.PMDPlugin;
-import net.sourceforge.pmd.eclipse.ui.preferences.br.RuleColumnDescriptor;
-import net.sourceforge.pmd.eclipse.ui.preferences.br.RuleTableColumns;
-import net.sourceforge.pmd.eclipse.ui.preferences.editors.SWTUtil;
+import net.sourceforge.pmd.eclipse.runtime.preferences.IPreferences;
 
 /**
- * 
- * 
+ * Stores preferences to restore UI state, such as selected row in the rule table.
+ * TODO - replace this with the existing ViewMemento
+ *
  * @author Brian Remedios
  */
 public class PreferenceUIStore {
 
-    private PreferenceStore preferenceStore;
-
-    private static final String TABLE_FRACTION = PMDPlugin.PLUGIN_ID + ".ruletable.fraction";
-    private static final String TABLE_HIDDEN_COLS = PMDPlugin.PLUGIN_ID + ".ruletable.hiddenColumns";
-    private static final String TABLE_COLUMN_SORT_UP = PMDPlugin.PLUGIN_ID + ".ruletable.sortUp";
-    private static final String GROUPING_COLUMN = PMDPlugin.PLUGIN_ID + ".ruletable.groupingColumn";
-    private static final String SELECTED_RULE_NAMES = PMDPlugin.PLUGIN_ID + ".ruletable.selectedRules";
-    private static final String SELECTED_PROPERTY_TAB = PMDPlugin.PLUGIN_ID + ".ruletable.selectedPropertyTab";
-    private static final String GLOBAL_RULE_MANAGEMENT = PMDPlugin.PLUGIN_ID + ".globalRuleManagement";
-
-    private static final int TABLE_FRACTION_DEFAULT = 55;
-    private static final char STRING_SEPARATOR = ',';
-
-    private static final RuleColumnDescriptor[] DEFAULT_HIDDEN_COLUMNS = new RuleColumnDescriptor[] {
-        RuleTableColumns.EXTERNAL_URL, RuleTableColumns.MIN_LANGUAGE_VERSION, RuleTableColumns.FIX_COUNT,
-        RuleTableColumns.EXAMPLE_COUNT, RuleTableColumns.MAX_LANGUAGE_VERSION, RuleTableColumns.SINCE,
-        RuleTableColumns.MOD_COUNT };
-
-    private static final boolean DEFAULT_SORT_UP = false;
-
     public static final PreferenceUIStore INSTANCE = new PreferenceUIStore();
 
+    private IPreferences preferences;
+
     private PreferenceUIStore() {
         initialize();
     }
 
-    private static String defaultHiddenColumnIds() {
-        Set<String> colNames = new HashSet<String>(DEFAULT_HIDDEN_COLUMNS.length);
-        for (RuleColumnDescriptor rcDesc : DEFAULT_HIDDEN_COLUMNS) {
-            colNames.add(rcDesc.id());
-        }
-        return SWTUtil.asString(colNames, STRING_SEPARATOR);
-    }
-
     private void initialize() {
-
-        IWorkspaceRoot root = ResourcesPlugin.getWorkspace().getRoot();
-        IPath path = root.getLocation();
-        String fileName = path.append(PreferencesManagerImpl.NEW_PREFERENCE_LOCATION).toString();
-
-        // TODO - replace this with the existing ViewMemento
-        preferenceStore = new PreferenceStore(fileName);
-        preferenceStore.setDefault(GLOBAL_RULE_MANAGEMENT, false);
-
-        try {
-            preferenceStore.load();
-        } catch (IOException e) {
-            createNewStore();
-        }
-    }
-
-    private void createNewStore() {
-
-        preferenceStore.setValue(TABLE_FRACTION, TABLE_FRACTION_DEFAULT);
-        preferenceStore.setValue(TABLE_HIDDEN_COLS, defaultHiddenColumnIds());
-        preferenceStore.setValue(TABLE_COLUMN_SORT_UP, DEFAULT_SORT_UP);
-        preferenceStore.setValue(GROUPING_COLUMN, "");
-        preferenceStore.setValue(SELECTED_RULE_NAMES, "");
-        preferenceStore.setValue(SELECTED_PROPERTY_TAB, 0);
-        preferenceStore.setValue(GLOBAL_RULE_MANAGEMENT, false);
-
-        save();
+        preferences = PMDPlugin.getDefault().loadPreferences();
     }
 
     public void save() {
-
-        try {
-            preferenceStore.save();
-        } catch (IOException e) {
-            e.printStackTrace();
-        }
+        preferences.sync();
     }
 
     public int tableFraction() {
-        return preferenceStore.getInt(TABLE_FRACTION);
+        return preferences.tableFraction();
     }
 
     public void tableFraction(int aFraction) {
-        preferenceStore.setValue(TABLE_FRACTION, aFraction);
+        preferences.tableFraction(aFraction);
     }
 
     public Set<String> hiddenColumnIds() {
-        String names = preferenceStore.getString(TABLE_HIDDEN_COLS);
-        return SWTUtil.asStringSet(names, STRING_SEPARATOR);
+        return preferences.getHiddenColumnIds();
     }
 
     public void hiddenColumnIds(Set<String> names) {
-        String nameStr = SWTUtil.asString(names, STRING_SEPARATOR);
-        preferenceStore.setValue(TABLE_HIDDEN_COLS, nameStr);
+        preferences.setHiddenColumnIds(names);
     }
 
     public int selectedPropertyTab() {
-        return preferenceStore.getInt(SELECTED_PROPERTY_TAB);
+        return preferences.getSelectedPropertyTab();
     }
 
     public void selectedPropertyTab(int anIndex) {
-        preferenceStore.setValue(SELECTED_PROPERTY_TAB, anIndex);
+        preferences.setSelectedPropertyTab(anIndex);
     }
 
     public boolean globalRuleManagement() {
-        return preferenceStore.getBoolean(GLOBAL_RULE_MANAGEMENT);
+        return preferences.getGlobalRuleManagement();
     }
 
     public void globalRuleManagement(boolean b) {
-        preferenceStore.setValue(GLOBAL_RULE_MANAGEMENT, b);
+        preferences.setGlobalRuleManagement(b);
     }
 
     public Set<String> selectedRuleNames() {
-        String names = preferenceStore.getString(SELECTED_RULE_NAMES);
-        return SWTUtil.asStringSet(names, STRING_SEPARATOR);
+        return preferences.getSelectedRuleNames();
     }
 
-    public void selectedRuleNames(Collection<String> ruleNames) {
-        String nameStr = SWTUtil.asString(ruleNames, STRING_SEPARATOR);
-        preferenceStore.setValue(SELECTED_RULE_NAMES, nameStr);
+    public void selectedRuleNames(Set<String> ruleNames) {
+        preferences.setSelectedRuleNames(ruleNames);
     }
 
     public boolean sortDirectionUp() {
-        return preferenceStore.getBoolean(TABLE_COLUMN_SORT_UP);
+        return preferences.isSortDirectionUp();
     }
 
     public void sortDirectionUp(boolean isUp) {
-        preferenceStore.setValue(TABLE_COLUMN_SORT_UP, isUp);
+        preferences.setSortDirectionUp(isUp);
     }
 
     public String groupingColumnName() {
-        return preferenceStore.getString(GROUPING_COLUMN);
+        return preferences.getGroupingColumn();
     }
 
     public void groupingColumnName(String columnName) {
-        preferenceStore.setValue(GROUPING_COLUMN, columnName);
+        preferences.setGroupingColumn(columnName);
     }
 }

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/preferences/impl/PreferencesImpl.java

@@ -85,6 +85,13 @@ class PreferencesImpl implements IPreferences {
     private Map<RulePriority, PriorityDescriptor> uiDescriptorsByPriority = new HashMap<RulePriority, PriorityDescriptor>(
             5);
 
+    private int tableFraction;
+    private Set<String> hiddenColumnIds;
+    private boolean sortDirectionUp;
+    private String groupingColumn;
+    private Set<String> selectedRuleNames;
+    private int selectedPropertyTab;
+
     /**
      * Is constructed from a preferences manager
      * 
@@ -354,4 +361,62 @@ public void setPmdViolationsOutlineEnabled(boolean pmdViolationsOutlineEnabled)
         this.pmdViolationsOutlineEnabled = pmdViolationsOutlineEnabled;
     }
 
+    @Override
+    public int tableFraction() {
+        return tableFraction;
+    }
+    @Override
+    public void tableFraction(int aFraction) {
+        this.tableFraction = aFraction;
+    }
+
+    @Override
+    public Set<String> getHiddenColumnIds() {
+        return hiddenColumnIds;
+    }
+
+    @Override
+    public void setHiddenColumnIds(Set<String> names) {
+        hiddenColumnIds = names;
+    }
+
+    @Override
+    public boolean isSortDirectionUp() {
+        return sortDirectionUp;
+    }
+
+    @Override
+    public void setSortDirectionUp(boolean isUp) {
+        sortDirectionUp = isUp;
+    }
+
+    @Override
+    public String getGroupingColumn() {
+        return groupingColumn;
+    }
+
+    @Override
+    public void setGroupingColumn(String columnName) {
+        groupingColumn = columnName;
+    }
+
+    @Override
+    public Set<String> getSelectedRuleNames() {
+        return selectedRuleNames;
+    }
+
+    @Override
+    public void setSelectedRuleNames(Set<String> ruleNames) {
+        selectedRuleNames = ruleNames;
+    }
+
+    @Override
+    public int getSelectedPropertyTab() {
+        return selectedPropertyTab;
+    }
+
+    @Override
+    public void setSelectedPropertyTab(int anIndex) {
+        selectedPropertyTab = anIndex;
+    }
 }