Save the enabled priorities of PriorityFilter in preferences

And load it from there.
ViolationOutline and ViolationOverview don't do this anymore.

Author: adangel

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/plugin/PMDPlugin.java

@@ -82,6 +82,7 @@
 import net.sourceforge.pmd.eclipse.ui.nls.StringKeys;
 import net.sourceforge.pmd.eclipse.ui.nls.StringTable;
 import net.sourceforge.pmd.eclipse.ui.priority.PriorityDescriptorCache;
+import net.sourceforge.pmd.eclipse.ui.views.PriorityFilter;
 import net.sourceforge.pmd.eclipse.util.ResourceManager;
 import net.sourceforge.pmd.lang.LanguageRegistry;
 import net.sourceforge.pmd.lang.LanguageVersion;
@@ -127,6 +128,7 @@ public class PMDPlugin extends AbstractUIPlugin {
      * The constructor
      */
     public PMDPlugin() {
+        plugin = this;
     }
 
     public Color colorFor(RGB rgb) {
@@ -232,7 +234,6 @@ public static File getPluginFolder() {
      */
     public void start(BundleContext context) throws Exception {
         super.start(context);
-        plugin = this;
 
         // this needs to be executed before the preferences are loaded, because
         // the standard
@@ -253,6 +254,10 @@ public void resourceChanged(IResourceChangeEvent arg0) {
             }
         });
 
+        // the initialization can only take place, after the plugin has been started.
+        // otherwise the preferences are not available yet.
+        PriorityFilter.getInstance().initialize();
+
         version = context.getBundle().getHeaders().get("Bundle-Version");
     }
 

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/views/PriorityFilter.java

@@ -7,9 +7,9 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.EnumSet;
-import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
+import java.util.concurrent.CopyOnWriteArraySet;
 
 import org.eclipse.core.resources.IMarker;
 import org.eclipse.core.runtime.CoreException;
@@ -30,14 +30,19 @@
  * The ViewerFilter for Priorities.
  * This is used for both Violation Outline and Violation Overview.
  *
+ * <p>The current enabled filters are saved automatically in the preferences.
+ * See {@link #PREFERENCE_KEY}.
+ *
  * @author SebastianRaffel ( 17.05.2005 )
  */
 public class PriorityFilter extends ViewerFilter {
     private static final PriorityFilter INSTANCE = new PriorityFilter();
 
+    private static final String PREFERENCE_KEY = PriorityFilter.class.getName() + ".enabledPriorities";
+
     private final Set<RulePriority> enabledPriorities;
 
-    private Set<PriorityFilterChangeListener> listeners = Collections.synchronizedSet(new HashSet<PriorityFilterChangeListener>());
+    private Set<PriorityFilterChangeListener> listeners = new CopyOnWriteArraySet<>();
 
     /**
      * Constructor
@@ -54,6 +59,42 @@ public static PriorityFilter getInstance() {
         return INSTANCE;
     }
 
+    /**
+     * Initialize the priority filter by loading the preferences and making sure, that
+     * any change to the filter is stored to the preferences.
+     */
+    public final void initialize() {
+        addPriorityFilterChangeListener(new PriorityFilterChangeListener() {
+            @Override
+            public void priorityEnabled(RulePriority priority) {
+                saveToPreferenceStore();
+            }
+            @Override
+            public void priorityDisabled(RulePriority priority) {
+                saveToPreferenceStore();
+            }
+        });
+        loadFromPreferenceStore();
+    }
+
+    private void saveToPreferenceStore() {
+        StringBuilder asString = new StringBuilder(50);
+        for (RulePriority rulePriority : enabledPriorities) {
+            asString.append(rulePriority.name()).append(',');
+        }
+        PMDPlugin.getDefault().getPreferenceStore().setValue(PREFERENCE_KEY, asString.toString());
+    }
+
+    private void loadFromPreferenceStore() {
+        String priorities = PMDPlugin.getDefault().getPreferenceStore().getString(PREFERENCE_KEY);
+        if (priorities != null && !priorities.isEmpty()) {
+            enabledPriorities.clear();
+            for (String priority : priorities.split(",")) {
+                enabledPriorities.add(RulePriority.valueOf(priority));
+            }
+        }
+    }
+
     /*
      * @see
      * org.eclipse.jface.viewers.ViewerFilter#select(org.eclipse.jface.viewers.
@@ -92,13 +133,13 @@ private boolean isPriorityEnabled(Integer markerPrio) {
         boolean isEnabled = false;
         // for some unknown reasons markerPrio may be null.
         if (markerPrio != null) {
-            isEnabled = enabledPriorities.contains(RulePriority.valueOf(markerPrio));
+            isEnabled = isPriorityEnabled(RulePriority.valueOf(markerPrio));
         }
         return isEnabled;
     }
 
     public boolean isPriorityEnabled(RulePriority priority) {
-        return isPriorityEnabled(priority.getPriority());
+        return enabledPriorities.contains(priority);
     }
 
     private boolean hasMarkersToShow(AbstractPMDRecord record) {
@@ -118,7 +159,9 @@ private boolean hasMarkersToShow(AbstractPMDRecord record) {
      *
      * @param newList,
      *            an ArrayLust of Integers
+     * @deprecated will be removed. The enabled priorities are stored in the preferences automatically now.
      */
+    @Deprecated
     public void setPriorityFilterList(List<Integer> newList) {
         enabledPriorities.clear();
         for (Integer priority : newList) {
@@ -130,7 +173,9 @@ public void setPriorityFilterList(List<Integer> newList) {
      * Gets the FilterList with the Priorities
      *
      * @return an List of Integers
+     * @deprecated will be removed. Use {@link #isPriorityEnabled(RulePriority)} instead.
      */
+    @Deprecated
     public List<Integer> getPriorityFilterList() {
         List<Integer> priorityList = new ArrayList<>();
         for (RulePriority priority : enabledPriorities) {
@@ -227,18 +272,14 @@ public void removePriorityFilterChangeListener(PriorityFilterChangeListener list
     }
 
     private void notifyPriorityEnabled(RulePriority priority) {
-        synchronized (listeners) {
-            for (PriorityFilterChangeListener listener : listeners) {
-                listener.priorityEnabled(priority);
-            }
+        for (PriorityFilterChangeListener listener : listeners) {
+            listener.priorityEnabled(priority);
         }
     }
 
     private void notifyPriorityDisabled(RulePriority priority) {
-        synchronized (listeners) {
-            for (PriorityFilterChangeListener listener : listeners) {
-                listener.priorityDisabled(priority);
-            }
+        for (PriorityFilterChangeListener listener : listeners) {
+            listener.priorityDisabled(priority);
         }
     }
 

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/views/ViolationOutline.java

@@ -4,8 +4,6 @@
 
 package net.sourceforge.pmd.eclipse.ui.views;
 
-import java.util.List;
-
 import org.eclipse.jface.action.Action;
 import org.eclipse.jface.action.IMenuListener;
 import org.eclipse.jface.action.IMenuManager;
@@ -49,7 +47,6 @@ public class ViolationOutline extends AbstractPMDPagebookView implements ISelect
     private FileRecord resourceRecord;
     private PriorityFilter priorityFilter;
 
-    protected static final String PRIORITY_LIST = "priorityFilterList";
     protected static final String COLUMN_WIDTHS = "tableColumnWidths";
     protected static final String COLUMN_SORTER = "tableColumnSorter";
 
@@ -77,19 +74,11 @@ protected String mementoFileId() {
     @Override
     public void init(IViewSite site) throws PartInitException {
         super.init(site);
-
         priorityFilter = PriorityFilter.getInstance();
-
-        List<Integer> priorityList = getIntegerList(PRIORITY_LIST);
-        if (!priorityList.isEmpty()) {
-            // set the loaded List for the Priority Filter
-            priorityFilter.setPriorityFilterList(priorityList);
-        }
     }
 
     @Override
     public void dispose() {
-        save(PRIORITY_LIST, priorityFilter.getPriorityFilterList());
         super.dispose();
     }
 

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/views/ViolationOverview.java

@@ -32,6 +32,7 @@
 import org.eclipse.ui.PartInitException;
 import org.eclipse.ui.part.ViewPart;
 
+import net.sourceforge.pmd.RulePriority;
 import net.sourceforge.pmd.eclipse.plugin.PMDPlugin;
 import net.sourceforge.pmd.eclipse.runtime.builder.MarkerUtil;
 import net.sourceforge.pmd.eclipse.runtime.cmd.DeleteMarkersCommand;
@@ -71,7 +72,6 @@ public class ViolationOverview extends ViewPart implements ISelectionProvider, I
     private int showType;
 
     protected static final String PACKAGE_SWITCH = "packageSwitch";
-    protected static final String PRIORITY_LIST = "priorityFilterList";
     protected static final String PROJECT_LIST = "projectFilterList";
     protected static final String COLUMN_WIDTHS = "tableColumnWidths";
     protected static final String COLUMN_SORTER = "tableColumnSorter";
@@ -149,8 +149,6 @@ public void createPartControl(Composite parent) {
      */
     @Override
     public void dispose() {
-        memento.putList(PRIORITY_LIST, priorityFilter.getPriorityFilterList());
-
         // on Dispose of the View we save its State into a Memento
 
         // we save the filtered Projects
@@ -302,10 +300,10 @@ private ViewerSorter getViewerSorter(int columnNr) {
     public int getNumberOfFilteredViolations(AbstractPMDRecord record) {
         int number = 0;
 
-        List<Integer> filterList = priorityFilter.getPriorityFilterList();
-        for (int i = 0; i < filterList.size(); i++) {
-            Integer priority = filterList.get(i);
-            number += record.getNumberOfViolationsToPriority(priority.intValue(), getShowType() == SHOW_MARKERS_FILES);
+        for (RulePriority rulePriority : RulePriority.values()) {
+            if (priorityFilter.isPriorityEnabled(rulePriority)) {
+                number += record.getNumberOfViolationsToPriority(rulePriority.getPriority(), getShowType() == SHOW_MARKERS_FILES);
+            }
         }
         return number;
     }
@@ -460,13 +458,7 @@ private String getString(String key) {
      *
      */
     private void restoreFilterSettings() {
-
         // Provide the Filters with their last State
-        List<Integer> priorityList = memento.getIntegerList(PRIORITY_LIST);
-        if (!priorityList.isEmpty()) {
-            priorityFilter.setPriorityFilterList(priorityList);
-        }
-        
         List<String> projectNames = memento.getStringList(PROJECT_LIST);
         if (!projectNames.isEmpty()) {
             List<AbstractPMDRecord> projectList = new ArrayList<AbstractPMDRecord>();