Synchronize PriorityFilter changes between violation outline

and violation overview

Author: adangel

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

@@ -5,7 +5,11 @@
 package net.sourceforge.pmd.eclipse.ui.views;
 
 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 org.eclipse.core.resources.IMarker;
 import org.eclipse.core.runtime.CoreException;
@@ -14,7 +18,6 @@
 
 import net.sourceforge.pmd.RulePriority;
 import net.sourceforge.pmd.eclipse.plugin.PMDPlugin;
-import net.sourceforge.pmd.eclipse.plugin.UISettings;
 import net.sourceforge.pmd.eclipse.ui.PMDUiConstants;
 import net.sourceforge.pmd.eclipse.ui.model.AbstractPMDRecord;
 import net.sourceforge.pmd.eclipse.ui.model.FileRecord;
@@ -30,10 +33,11 @@
  * @author SebastianRaffel ( 17.05.2005 )
  */
 public class PriorityFilter extends ViewerFilter {
+    private static final PriorityFilter INSTANCE = new PriorityFilter();
 
-    private List<Integer> priorityList;
+    private final Set<RulePriority> enabledPriorities;
 
-    private static final PriorityFilter INSTANCE = new PriorityFilter();
+    private Set<PriorityFilterChangeListener> listeners = Collections.synchronizedSet(new HashSet<PriorityFilterChangeListener>());
 
     /**
      * Constructor
@@ -43,7 +47,7 @@ public class PriorityFilter extends ViewerFilter {
      */
     @Deprecated
     public PriorityFilter() {
-        priorityList = UISettings.getPriorityIntValues();
+        enabledPriorities = Collections.synchronizedSet(EnumSet.allOf(RulePriority.class));
     }
 
     public static PriorityFilter getInstance() {
@@ -88,12 +92,7 @@ private boolean isPriorityEnabled(Integer markerPrio) {
         boolean isEnabled = false;
         // for some unknown reasons markerPrio may be null.
         if (markerPrio != null) {
-            for (Integer priority : priorityList) {
-                if (markerPrio.equals(priority)) {
-                    isEnabled = true;
-                    break;
-                }
-            }
+            isEnabled = enabledPriorities.contains(RulePriority.valueOf(markerPrio));
         }
         return isEnabled;
     }
@@ -104,8 +103,8 @@ public boolean isPriorityEnabled(RulePriority priority) {
 
     private boolean hasMarkersToShow(AbstractPMDRecord record) {
         boolean hasMarkers = false;
-        for (Integer priority : priorityList) {
-            final IMarker[] markers = record.findMarkersByAttribute(PMDUiConstants.KEY_MARKERATT_PRIORITY, priority);
+        for (RulePriority priority : enabledPriorities) {
+            final IMarker[] markers = record.findMarkersByAttribute(PMDUiConstants.KEY_MARKERATT_PRIORITY, priority.getPriority());
             if (markers.length > 0) {
                 hasMarkers = true;
                 break;
@@ -121,7 +120,10 @@ private boolean hasMarkersToShow(AbstractPMDRecord record) {
      *            an ArrayLust of Integers
      */
     public void setPriorityFilterList(List<Integer> newList) {
-        priorityList = newList;
+        enabledPriorities.clear();
+        for (Integer priority : newList) {
+            enabledPriorities.add(RulePriority.valueOf(priority));
+        }
     }
 
     /**
@@ -130,6 +132,10 @@ public void setPriorityFilterList(List<Integer> newList) {
      * @return an List of Integers
      */
     public List<Integer> getPriorityFilterList() {
+        List<Integer> priorityList = new ArrayList<>();
+        for (RulePriority priority : enabledPriorities) {
+            priorityList.add(priority.getPriority());
+        }
         return priorityList;
     }
 
@@ -139,7 +145,12 @@ public List<Integer> getPriorityFilterList() {
      * @param priority
      */
     public void addPriorityToList(Integer priority) {
-        priorityList.add(priority);
+        if (priority != null) {
+            RulePriority rulePriority = RulePriority.valueOf(priority);
+            if (enabledPriorities.add(rulePriority)) {
+                notifyPriorityEnabled(rulePriority);
+            }
+        }
     }
 
     /**
@@ -148,7 +159,12 @@ public void addPriorityToList(Integer priority) {
      * @param priority
      */
     public void removePriorityFromList(Integer priority) {
-        priorityList.remove(priority);
+        if (priority != null) {
+            RulePriority rulePriority = RulePriority.valueOf(priority);
+            if (enabledPriorities.remove(rulePriority)) {
+                notifyPriorityDisabled(rulePriority);
+            }
+        }
     }
 
     /**
@@ -159,7 +175,9 @@ public void removePriorityFromList(Integer priority) {
      *            the List-String
      * @param splitter,
      *            the List splitter (in general ",")
+     * @deprecated will be removed
      */
+    @Deprecated
     public void setPriorityFilterListFromString(String newList, String splitter) {
         if (newList != null) {
             final String[] newArray = newList.split(splitter);
@@ -169,7 +187,7 @@ public void setPriorityFilterListFromString(String newList, String splitter) {
                 priorities.add(Integer.valueOf(element));
             }
 
-            priorityList = priorities;
+            setPriorityFilterList(priorities);
         }
     }
 
@@ -180,16 +198,52 @@ public void setPriorityFilterListFromString(String newList, String splitter) {
      * @param splitter,
      *            The String splitter (in general ",")
      * @return the List-String
+     * @deprecated will be removed
      */
+    @Deprecated
     public String getPriorityFilterListAsString(String splitter) {
-        if (priorityList.isEmpty()) {
+        if (enabledPriorities.isEmpty()) {
             return "";
         }
 
-        final StringBuilder listString = new StringBuilder(priorityList.get(0));
-        for (int i = 1; i < priorityList.size(); i++) {
-            listString.append(splitter).append(priorityList.get(i));
+        StringBuilder listString = new StringBuilder();
+        int i = 0;
+        for (RulePriority priority : enabledPriorities) {
+            if (i > 0) {
+                listString.append(splitter);
+            }
+            listString.append(priority.getPriority());
+            i++;
         }
         return listString.toString();
     }
+
+    public void addPriorityFilterChangeListener(PriorityFilterChangeListener listener) {
+        listeners.add(listener);
+    }
+
+    public void removePriorityFilterChangeListener(PriorityFilterChangeListener listener) {
+        listeners.remove(listener);
+    }
+
+    private void notifyPriorityEnabled(RulePriority priority) {
+        synchronized (listeners) {
+            for (PriorityFilterChangeListener listener : listeners) {
+                listener.priorityEnabled(priority);
+            }
+        }
+    }
+
+    private void notifyPriorityDisabled(RulePriority priority) {
+        synchronized (listeners) {
+            for (PriorityFilterChangeListener listener : listeners) {
+                listener.priorityDisabled(priority);
+            }
+        }
+    }
+
+    public interface PriorityFilterChangeListener {
+        void priorityEnabled(RulePriority priority);
+        void priorityDisabled(RulePriority priority);
+    }
 }

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

@@ -135,13 +135,12 @@ protected void doDestroyPage(IWorkbenchPart part, PageRec pageRecord) {
      */
     private void addFilterControls() {
         IMenuManager manager = getViewSite().getActionBars().getMenuManager();
-        List<Integer> filterList = priorityFilter.getPriorityFilterList();
 
         // we add the PriorityFilter-Actions to this Menu
         RulePriority[] priorities = UISettings.currentPriorities(true);
         for (RulePriority priority : priorities) {
             Action filterAction = new PriorityFilterAction(priority, this);
-            if (filterList.contains(priority.getPriority())) {
+            if (priorityFilter.isPriorityEnabled(priority)) {
                 filterAction.setChecked(true);
             }
 

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

@@ -342,7 +342,9 @@ public List<AbstractPMDRecord> getProjectFilterList() {
      * Delegate method for {@link ProjectFilter#getProjectFilterList()}.
      * 
      * @return project filter list
+     * @deprecated not needed - will be removed
      */
+    @Deprecated
     public List<Integer> getPriorityFilterList() {
         return priorityFilter.getPriorityFilterList();
     }

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

@@ -18,14 +18,15 @@
 import net.sourceforge.pmd.eclipse.ui.views.PriorityFilter;
 import net.sourceforge.pmd.eclipse.ui.views.ViolationOutline;
 import net.sourceforge.pmd.eclipse.ui.views.ViolationOverview;
+import net.sourceforge.pmd.eclipse.ui.views.PriorityFilter.PriorityFilterChangeListener;
 
 /**
  * Filters elements by the Marker priorities
  * 
  * @author SebastianRaffel ( 22.05.2005 )
  * @author bremedios (15.9.2010)
  */
-public class PriorityFilterAction extends Action {
+public class PriorityFilterAction extends Action implements PriorityFilterChangeListener {
 
     private ViolationOutline outlineView;
     private ViolationOverview overviewView;
@@ -71,6 +72,7 @@ private void setFilterFrom(ViewerFilter[] filters) {
         for (Object filter : filters) {
             if (filter instanceof PriorityFilter) {
                 priorityFilter = (PriorityFilter) filter;
+                priorityFilter.addPriorityFilterChangeListener(this);
             }
         }
     }
@@ -119,4 +121,17 @@ public void run() {
         }
     }
 
+    @Override
+    public void priorityEnabled(RulePriority priority) {
+        if (this.priority == priority) {
+            this.setChecked(true);
+        }
+    }
+
+    @Override
+    public void priorityDisabled(RulePriority priority) {
+        if (this.priority == priority) {
+            this.setChecked(false);
+        }
+    }
 }

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/util/PriorityUtil.java

@@ -41,7 +41,7 @@ public static boolean isPriorityActive(RulePriority priority) {
      * Get all the priorities that are turned on right now.
      * 
      * @return
-     * @deprecated not needed, will be removed.
+     * @deprecated not needed, will be removed. Use {@link PriorityFilter#isPriorityEnabled(RulePriority)}.
      */
     @Deprecated
     public static List<RulePriority> getActivePriorites() {