Rework PriorityFilter:

* Move singleton of PriorityFilter inside PriorityFilter
* Deprecate PriorityUtil
* Use PriorityFilter singleton for ViolationOutline as well

Author: adangel

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

@@ -12,6 +12,7 @@
 import org.eclipse.jface.viewers.Viewer;
 import org.eclipse.jface.viewers.ViewerFilter;
 
+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;
@@ -23,26 +24,32 @@
 import net.sourceforge.pmd.eclipse.ui.nls.StringKeys;
 
 /**
- * The ViewerFilter for Priorities
+ * The ViewerFilter for Priorities.
+ * This is used for both Violation Outline and Violation Overview.
  *
  * @author SebastianRaffel ( 17.05.2005 )
  */
 public class PriorityFilter extends ViewerFilter {
 
     private List<Integer> priorityList;
 
+    private static final PriorityFilter INSTANCE = new PriorityFilter();
+
     /**
      * Constructor
      *
      * @author SebastianRaffel ( 29.06.2005 )
+     * @deprecated will be made private in the future.
      */
+    @Deprecated
     public PriorityFilter() {
-        super();
-        // priorityList = new
-        // ArrayList<Integer>(Arrays.asList(PMDPlugin.getDefault().getPriorityValues()));
         priorityList = UISettings.getPriorityIntValues();
     }
 
+    public static PriorityFilter getInstance() {
+        return INSTANCE;
+    }
+
     /*
      * @see
      * org.eclipse.jface.viewers.ViewerFilter#select(org.eclipse.jface.viewers.
@@ -70,12 +77,7 @@ public boolean select(Viewer viewer, Object parentElement, Object element) {
         } else if (element instanceof MarkerRecord) {
             // ViolationOverview
             final MarkerRecord markerRec = (MarkerRecord) element;
-            for (Integer priority : priorityList) {
-                if (markerRec.getPriority() == priority.intValue()) {
-                    select = true;
-                    break;
-                }
-            }
+            select = isPriorityEnabled(markerRec.getPriority());
         } else if (element instanceof FileToMarkerRecord) {
             select = true;
         }
@@ -96,6 +98,10 @@ private boolean isPriorityEnabled(Integer markerPrio) {
         return isEnabled;
     }
 
+    public boolean isPriorityEnabled(RulePriority priority) {
+        return isPriorityEnabled(priority.getPriority());
+    }
+
     private boolean hasMarkersToShow(AbstractPMDRecord record) {
         boolean hasMarkers = false;
         for (Integer priority : priorityList) {

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

@@ -78,7 +78,7 @@ protected String mementoFileId() {
     public void init(IViewSite site) throws PartInitException {
         super.init(site);
 
-        priorityFilter = new PriorityFilter();
+        priorityFilter = PriorityFilter.getInstance();
 
         List<Integer> priorityList = getIntegerList(PRIORITY_LIST);
         if (!priorityList.isEmpty()) {

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

@@ -43,7 +43,6 @@
 import net.sourceforge.pmd.eclipse.ui.model.PackageRecord;
 import net.sourceforge.pmd.eclipse.ui.model.RootRecord;
 import net.sourceforge.pmd.eclipse.ui.nls.StringKeys;
-import net.sourceforge.pmd.eclipse.util.PriorityUtil;
 import net.sourceforge.pmd.util.NumericConstants;
 
 /**
@@ -96,7 +95,7 @@ public void init(IViewSite site) throws PartInitException {
         root = (RootRecord) getInitialInput();
         contentProvider = new ViolationOverviewContentProvider(this);
         labelProvider = new ViolationOverviewLabelProvider(this);
-        priorityFilter = PriorityUtil.getPriorityFilter();
+        priorityFilter = PriorityFilter.getInstance();
         projectFilter = new ProjectFilter();
         doubleClickListener = new ViolationOverviewDoubleClickListener(this);
         menuManager = new ViolationOverviewMenuManager(this);
@@ -106,7 +105,7 @@ public void init(IViewSite site) throws PartInitException {
         // we can load the Memento here
         memento = new ViewMemento(PMDUiConstants.MEMENTO_OVERVIEW_FILE);
         if (memento != null) {
-            rememberFilterSettings();
+            restoreFilterSettings();
         }
     }
 
@@ -141,7 +140,7 @@ public void createPartControl(Composite parent) {
 
         // load the State from a Memento into the View if there is one
         if (memento != null) {
-            rememberTreeSettings();
+            restoreTreeSettings();
         }
     }
 
@@ -458,7 +457,7 @@ private String getString(String key) {
      * must be sure memento is not null.
      *
      */
-    private void rememberFilterSettings() {
+    private void restoreFilterSettings() {
 
         // Provide the Filters with their last State
         List<Integer> priorityList = memento.getIntegerList(PRIORITY_LIST);
@@ -491,7 +490,7 @@ private void rememberFilterSettings() {
      * one must be sure memento is not null.
      *
      */
-    private void rememberTreeSettings() {
+    private void restoreTreeSettings() {
 
         // the Memento sets the Widths of Columns
         List<Integer> widthList = memento.getIntegerList(COLUMN_WIDTHS);

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

@@ -27,7 +27,6 @@
 import net.sourceforge.pmd.eclipse.ui.views.actions.PriorityFilterAction;
 import net.sourceforge.pmd.eclipse.ui.views.actions.ProjectFilterAction;
 import net.sourceforge.pmd.eclipse.ui.views.actions.ViolationPresentationTypeAction;
-import net.sourceforge.pmd.eclipse.util.PriorityUtil;
 
 /**
  *
@@ -54,7 +53,7 @@ public void setupActions() {
         // create the Actions for the PriorityFilter
         for (int i = 0; i < priorities.length; i++) {
             priorityActions[i] = new PriorityFilterAction(priorities[i], overview); // NOPMD by Herlin on 09/10/06 15:02
-            priorityActions[i].setChecked(PriorityUtil.isPriorityActive(priorities[i]));
+            priorityActions[i].setChecked(PriorityFilter.getInstance().isPriorityEnabled(priorities[i]));
         }
     }
 

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

@@ -17,11 +17,11 @@
  * 
  * @author Phillip Krall
  *
+ * @deprecated use directly {@link PriorityFilter} instead.
  */
+@Deprecated
 public class PriorityUtil {
 
-    private static PriorityFilter priorityFilter = new PriorityFilter();
-
     private PriorityUtil() {
     }
 
@@ -30,32 +30,43 @@ private PriorityUtil() {
      * 
      * @param priority
      * @return
+     * @deprecated use {@link PriorityFilter#isPriorityEnabled(RulePriority)} instead.
      */
+    @Deprecated
     public static boolean isPriorityActive(RulePriority priority) {
-        return getActivePriorites().contains(priority);
+        return PriorityFilter.getInstance().isPriorityEnabled(priority);
     }
 
     /**
      * Get all the priorities that are turned on right now.
      * 
      * @return
+     * @deprecated not needed, will be removed.
      */
+    @Deprecated
     public static List<RulePriority> getActivePriorites() {
         List<RulePriority> active = new ArrayList<RulePriority>();
         for (RulePriority priority : UISettings.currentPriorities(true)) {
-            if (priorityFilter.getPriorityFilterList().contains(priority.getPriority())) {
+            if (PriorityFilter.getInstance().getPriorityFilterList().contains(priority.getPriority())) {
                 active.add(priority);
             }
         }
         return active;
     }
 
+    /**
+     * @deprecated use {@link PriorityFilter#getInstance()} instead.
+     */
+    @Deprecated
     public static PriorityFilter getPriorityFilter() {
-        return priorityFilter;
+        return PriorityFilter.getInstance();
     }
 
+    /**
+     * @deprecated to be removed without replacement.
+     */
+    @Deprecated
     public static void setPriorityFilter(PriorityFilter priorityFilter) {
-        PriorityUtil.priorityFilter = priorityFilter;
     }
 
 }