Bug 186404 - [Viewers] Update PatternFilter API to allow extensionsv20120222-1910

2 files changed, 181 insertions, 174 deletions

diff --git a/bundles/org.eclipse.ui.workbench/.settings/.api_filters b/bundles/org.eclipse.ui.workbench/.settings/.api_filters
index 4b417e9f45c..74ad68913ed 100644
--- a/bundles/org.eclipse.ui.workbench/.settings/.api_filters
+++ b/bundles/org.eclipse.ui.workbench/.settings/.api_filters
@@ -1,143 +1,170 @@
-<?xml version="1.0" encoding="UTF-8"?><component id="org.eclipse.ui.workbench" version="2">
-    <resource path="Eclipse UI/org/eclipse/ui/IMemento.java" type="org.eclipse.ui.IMemento">
-        <filter id="1209008130">
-            <message_arguments>
-                <message_argument value="3.8"/>
-                <message_argument value="3.103"/>
-                <message_argument value="getChildren()"/>
-            </message_arguments>
-        </filter>
-    </resource>
-    <resource path="Eclipse UI/org/eclipse/ui/IWorkingSetManager.java" type="org.eclipse.ui.IWorkingSetManager">
-        <filter id="1209008130">
-            <message_arguments>
-                <message_argument value="3.7"/>
-                <message_argument value="3.103"/>
-                <message_argument value="getRecentWorkingSetsLength()"/>
-            </message_arguments>
-        </filter>
-        <filter id="1209008130">
-            <message_arguments>
-                <message_argument value="3.7"/>
-                <message_argument value="3.103"/>
-                <message_argument value="setRecentWorkingSetsLength(int)"/>
-            </message_arguments>
-        </filter>
-    </resource>
-    <resource path="Eclipse UI/org/eclipse/ui/XMLMemento.java" type="org.eclipse.ui.XMLMemento">
-        <filter id="1143996420">
-            <message_arguments>
-                <message_argument value="getChildren()"/>
-            </message_arguments>
-        </filter>
-    </resource>
-    <resource path="Eclipse UI/org/eclipse/ui/branding/IBundleGroupConstants.java" type="org.eclipse.ui.branding.IBundleGroupConstants">
-        <filter id="403767336">
-            <message_arguments>
-                <message_argument value="org.eclipse.ui.branding.IBundleGroupConstants"/>
-                <message_argument value="BRANDING_BUNDLE_ID"/>
-            </message_arguments>
-        </filter>
-        <filter id="403767336">
-            <message_arguments>
-                <message_argument value="org.eclipse.ui.branding.IBundleGroupConstants"/>
-                <message_argument value="BRANDING_BUNDLE_VERSION"/>
-            </message_arguments>
-        </filter>
-    </resource>
-    <resource path="Eclipse UI/org/eclipse/ui/menus/CommandContributionItemParameter.java" type="org.eclipse.ui.menus.CommandContributionItemParameter">
-        <filter id="338948223">
-            <message_arguments>
-                <message_argument value="org.eclipse.ui.menus.CommandContributionItemParameter"/>
-                <message_argument value="CommandContributionItemParameter(IServiceLocator, String, String, Map, ImageDescriptor, ImageDescriptor, ImageDescriptor, String, String, String, int, String, boolean)"/>
-            </message_arguments>
-        </filter>
-    </resource>
-    <resource path="Eclipse UI/org/eclipse/ui/menus/MenuUtil.java" type="org.eclipse.ui.menus.MenuUtil">
-        <filter id="336744520">
-            <message_arguments>
-                <message_argument value="org.eclipse.ui.menus.MenuUtil"/>
-            </message_arguments>
-        </filter>
-    </resource>
-    <resource path="Eclipse UI/org/eclipse/ui/part/AbstractMultiEditor.java" type="org.eclipse.ui.part.AbstractMultiEditor">
-        <filter id="338944126">
-            <message_arguments>
-                <message_argument value="org.eclipse.ui.part.AbstractMultiEditor"/>
-                <message_argument value="setChildren(IEditorPart[])"/>
-            </message_arguments>
-        </filter>
-    </resource>
-    <resource path="Eclipse UI/org/eclipse/ui/part/MultiPageEditorPart.java" type="org.eclipse.ui.part.MultiPageEditorPart">
-        <filter id="420630660">
-            <message_arguments>
-                <message_argument value="org.eclipse.ui.part.MultiPageEditorPart"/>
-                <message_argument value="getActiveEditor()"/>
-            </message_arguments>
-        </filter>
-        <filter id="420630660">
-            <message_arguments>
-                <message_argument value="org.eclipse.ui.part.MultiPageEditorPart"/>
-                <message_argument value="getActivePage()"/>
-            </message_arguments>
-        </filter>
-        <filter id="421679236">
-            <message_arguments>
-                <message_argument value="org.eclipse.ui.part.MultiPageEditorPart"/>
-                <message_argument value="getActiveEditor()"/>
-            </message_arguments>
-        </filter>
-        <filter id="421679236">
-            <message_arguments>
-                <message_argument value="org.eclipse.ui.part.MultiPageEditorPart"/>
-                <message_argument value="getActivePage()"/>
-            </message_arguments>
-        </filter>
-    </resource>
-    <resource path="Eclipse UI/org/eclipse/ui/presentations/PresentationUtil.java" type="org.eclipse.ui.presentations.PresentationUtil">
-        <filter id="1108344834">
-            <message_arguments>
-                <message_argument value="3.0"/>
-                <message_argument value="3.103"/>
-                <message_argument value="org.eclipse.ui.presentations.PresentationUtil"/>
-            </message_arguments>
-        </filter>
-    </resource>
-    <resource path="Eclipse UI/org/eclipse/ui/progress/IProgressConstants.java" type="org.eclipse.ui.progress.IProgressConstants">
-        <filter id="403767336">
-            <message_arguments>
-                <message_argument value="org.eclipse.ui.progress.IProgressConstants"/>
-                <message_argument value="COMMAND_PROPERTY"/>
-            </message_arguments>
-        </filter>
-    </resource>
-    <resource path="Eclipse UI/org/eclipse/ui/services/IEvaluationReference.java" type="org.eclipse.ui.services.IEvaluationReference">
-        <filter id="403853384">
-            <message_arguments>
-                <message_argument value="org.eclipse.ui.services.IEvaluationReference"/>
-            </message_arguments>
-        </filter>
-    </resource>
-    <resource path="Eclipse UI/org/eclipse/ui/services/IServiceScopes.java" type="org.eclipse.ui.services.IServiceScopes">
-        <filter id="403853384">
-            <message_arguments>
-                <message_argument value="org.eclipse.ui.services.IServiceScopes"/>
-            </message_arguments>
-        </filter>
-    </resource>
-    <resource path="Eclipse UI/org/eclipse/ui/statushandlers/WorkbenchStatusDialogManager.java" type="org.eclipse.ui.statushandlers.WorkbenchStatusDialogManager">
-        <filter id="336744520">
-            <message_arguments>
-                <message_argument value="org.eclipse.ui.statushandlers.WorkbenchStatusDialogManager"/>
-            </message_arguments>
-        </filter>
-    </resource>
-    <resource path="META-INF/MANIFEST.MF">
-        <filter id="923795461">
-            <message_arguments>
-                <message_argument value="3.6.0.qualifier"/>
-                <message_argument value="3.5.0.I20090603-2000"/>
-            </message_arguments>
-        </filter>
-    </resource>
-</component>
\ No newline at end of file
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>

+<component id="org.eclipse.ui.workbench" version="2">

+    <resource path="Eclipse UI/org/eclipse/ui/IMemento.java" type="org.eclipse.ui.IMemento">

+        <filter id="1209008130">

+            <message_arguments>

+                <message_argument value="3.8"/>

+                <message_argument value="3.103"/>

+                <message_argument value="getChildren()"/>

+            </message_arguments>

+        </filter>

+    </resource>

+    <resource path="Eclipse UI/org/eclipse/ui/IWorkingSetManager.java" type="org.eclipse.ui.IWorkingSetManager">

+        <filter id="1209008130">

+            <message_arguments>

+                <message_argument value="3.7"/>

+                <message_argument value="3.103"/>

+                <message_argument value="getRecentWorkingSetsLength()"/>

+            </message_arguments>

+        </filter>

+        <filter id="1209008130">

+            <message_arguments>

+                <message_argument value="3.7"/>

+                <message_argument value="3.103"/>

+                <message_argument value="setRecentWorkingSetsLength(int)"/>

+            </message_arguments>

+        </filter>

+    </resource>

+    <resource path="Eclipse UI/org/eclipse/ui/XMLMemento.java" type="org.eclipse.ui.XMLMemento">

+        <filter id="1143996420">

+            <message_arguments>

+                <message_argument value="getChildren()"/>

+            </message_arguments>

+        </filter>

+    </resource>

+    <resource path="Eclipse UI/org/eclipse/ui/branding/IBundleGroupConstants.java" type="org.eclipse.ui.branding.IBundleGroupConstants">

+        <filter id="403767336">

+            <message_arguments>

+                <message_argument value="org.eclipse.ui.branding.IBundleGroupConstants"/>

+                <message_argument value="BRANDING_BUNDLE_ID"/>

+            </message_arguments>

+        </filter>

+        <filter id="403767336">

+            <message_arguments>

+                <message_argument value="org.eclipse.ui.branding.IBundleGroupConstants"/>

+                <message_argument value="BRANDING_BUNDLE_VERSION"/>

+            </message_arguments>

+        </filter>

+    </resource>

+    <resource path="Eclipse UI/org/eclipse/ui/dialogs/PatternFilter.java" type="org.eclipse.ui.dialogs.PatternFilter">

+        <filter comment="Reverting temporary change for bug 186404" id="338792546">

+            <message_arguments>

+                <message_argument value="org.eclipse.ui.dialogs.PatternFilter"/>

+                <message_argument value="doFilter(Viewer, Object, Object[])"/>

+            </message_arguments>

+        </filter>

+        <filter comment="Reverting temporary change for bug 186404" id="388018290">

+            <message_arguments>

+                <message_argument value="org.eclipse.ui.dialogs.PatternFilter"/>

+                <message_argument value="foundAnyCache"/>

+            </message_arguments>

+        </filter>

+        <filter comment="Reverting temporary change for bug 186404" id="388018290">

+            <message_arguments>

+                <message_argument value="org.eclipse.ui.dialogs.PatternFilter"/>

+                <message_argument value="useCache"/>

+            </message_arguments>

+        </filter>

+        <filter comment="Reverting temporary change for bug 186404" id="421654647">

+            <message_arguments>

+                <message_argument value="org.eclipse.ui.dialogs.PatternFilter"/>

+                <message_argument value="select(Viewer, Object, Object)"/>

+            </message_arguments>

+        </filter>

+    </resource>

+    <resource path="Eclipse UI/org/eclipse/ui/menus/CommandContributionItemParameter.java" type="org.eclipse.ui.menus.CommandContributionItemParameter">

+        <filter id="338948223">

+            <message_arguments>

+                <message_argument value="org.eclipse.ui.menus.CommandContributionItemParameter"/>

+                <message_argument value="CommandContributionItemParameter(IServiceLocator, String, String, Map, ImageDescriptor, ImageDescriptor, ImageDescriptor, String, String, String, int, String, boolean)"/>

+            </message_arguments>

+        </filter>

+    </resource>

+    <resource path="Eclipse UI/org/eclipse/ui/menus/MenuUtil.java" type="org.eclipse.ui.menus.MenuUtil">

+        <filter id="336744520">

+            <message_arguments>

+                <message_argument value="org.eclipse.ui.menus.MenuUtil"/>

+            </message_arguments>

+        </filter>

+    </resource>

+    <resource path="Eclipse UI/org/eclipse/ui/part/AbstractMultiEditor.java" type="org.eclipse.ui.part.AbstractMultiEditor">

+        <filter id="338944126">

+            <message_arguments>

+                <message_argument value="org.eclipse.ui.part.AbstractMultiEditor"/>

+                <message_argument value="setChildren(IEditorPart[])"/>

+            </message_arguments>

+        </filter>

+    </resource>

+    <resource path="Eclipse UI/org/eclipse/ui/part/MultiPageEditorPart.java" type="org.eclipse.ui.part.MultiPageEditorPart">

+        <filter id="420630660">

+            <message_arguments>

+                <message_argument value="org.eclipse.ui.part.MultiPageEditorPart"/>

+                <message_argument value="getActiveEditor()"/>

+            </message_arguments>

+        </filter>

+        <filter id="420630660">

+            <message_arguments>

+                <message_argument value="org.eclipse.ui.part.MultiPageEditorPart"/>

+                <message_argument value="getActivePage()"/>

+            </message_arguments>

+        </filter>

+        <filter id="421679236">

+            <message_arguments>

+                <message_argument value="org.eclipse.ui.part.MultiPageEditorPart"/>

+                <message_argument value="getActiveEditor()"/>

+            </message_arguments>

+        </filter>

+        <filter id="421679236">

+            <message_arguments>

+                <message_argument value="org.eclipse.ui.part.MultiPageEditorPart"/>

+                <message_argument value="getActivePage()"/>

+            </message_arguments>

+        </filter>

+    </resource>

+    <resource path="Eclipse UI/org/eclipse/ui/presentations/PresentationUtil.java" type="org.eclipse.ui.presentations.PresentationUtil">

+        <filter id="1108344834">

+            <message_arguments>

+                <message_argument value="3.0"/>

+                <message_argument value="3.103"/>

+                <message_argument value="org.eclipse.ui.presentations.PresentationUtil"/>

+            </message_arguments>

+        </filter>

+    </resource>

+    <resource path="Eclipse UI/org/eclipse/ui/progress/IProgressConstants.java" type="org.eclipse.ui.progress.IProgressConstants">

+        <filter id="403767336">

+            <message_arguments>

+                <message_argument value="org.eclipse.ui.progress.IProgressConstants"/>

+                <message_argument value="COMMAND_PROPERTY"/>

+            </message_arguments>

+        </filter>

+    </resource>

+    <resource path="Eclipse UI/org/eclipse/ui/services/IEvaluationReference.java" type="org.eclipse.ui.services.IEvaluationReference">

+        <filter id="403853384">

+            <message_arguments>

+                <message_argument value="org.eclipse.ui.services.IEvaluationReference"/>

+            </message_arguments>

+        </filter>

+    </resource>

+    <resource path="Eclipse UI/org/eclipse/ui/services/IServiceScopes.java" type="org.eclipse.ui.services.IServiceScopes">

+        <filter id="403853384">

+            <message_arguments>

+                <message_argument value="org.eclipse.ui.services.IServiceScopes"/>

+            </message_arguments>

+        </filter>

+    </resource>

+    <resource path="Eclipse UI/org/eclipse/ui/statushandlers/WorkbenchStatusDialogManager.java" type="org.eclipse.ui.statushandlers.WorkbenchStatusDialogManager">

+        <filter id="336744520">

+            <message_arguments>

+                <message_argument value="org.eclipse.ui.statushandlers.WorkbenchStatusDialogManager"/>

+            </message_arguments>

+        </filter>

+    </resource>

+    <resource path="META-INF/MANIFEST.MF">

+        <filter id="923795461">

+            <message_arguments>

+                <message_argument value="3.6.0.qualifier"/>

+                <message_argument value="3.5.0.I20090603-2000"/>

+            </message_arguments>

+        </filter>

+    </resource>

+</component>

diff --git a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/dialogs/PatternFilter.java b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/dialogs/PatternFilter.java
index 184ae1a971a..f63de998401 100644
--- a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/dialogs/PatternFilter.java
+++ b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/dialogs/PatternFilter.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2004, 2011 IBM Corporation and others.
+ * Copyright (c) 2004, 2012 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -11,11 +11,11 @@
  *******************************************************************************/
 package org.eclipse.ui.dialogs;
 
-import com.ibm.icu.text.BreakIterator;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+
 import org.eclipse.jface.viewers.AbstractTreeViewer;
 import org.eclipse.jface.viewers.ILabelProvider;
 import org.eclipse.jface.viewers.ITreeContentProvider;
@@ -24,6 +24,8 @@ import org.eclipse.jface.viewers.Viewer;
 import org.eclipse.jface.viewers.ViewerFilter;
 import org.eclipse.ui.internal.misc.StringMatcher;
 
+import com.ibm.icu.text.BreakIterator;
+
 /**
  * A filter used in conjunction with <code>FilteredTree</code>. In order to
  * determine if a node should be filtered it uses the content and label provider
@@ -40,19 +42,12 @@ public class PatternFilter extends ViewerFilter {
 	 */
     private Map cache = new HashMap();
     
-	/**
-	 * Maps parent elements to TRUE or FALSE
-	 * 
-	 * @since 3.103
-	 */
-    protected Map foundAnyCache = new HashMap();
+    /*
+     * Maps parent elements to TRUE or FALSE
+     */
+    private Map foundAnyCache = new HashMap();
     
-	/**
-	 * Specifies if caching of filter results should be used.
-	 * 
-	 * @since 3.103
-	 */
-	protected boolean useCache = false;
+    private boolean useCache = false;
     
 	/**
 	 * Whether to include a leading wildcard for all provided patterns.  A
@@ -83,22 +78,7 @@ public class PatternFilter extends ViewerFilter {
         if (!useCache) {
         	return super.filter(viewer, parent, elements);
         }
-		return doFilter(viewer, parent, elements);
-	}
-
-	/**
-	 * Filters the given elements for the given viewer using local cache.
-	 * 
-	 * @param viewer
-	 *            the viewer
-	 * @param parent
-	 *            the parent element
-	 * @param elements
-	 *            the elements to filter
-	 * @return the filtered elements
-	 * @since 3.103
-	 */
-	protected Object[] doFilter(Viewer viewer, Object parent, Object[] elements) {
+        
         Object[] filtered = (Object[]) cache.get(parent);
         if (filtered == null) {
         	Boolean foundAny = (Boolean) foundAnyCache.get(parent);
@@ -162,7 +142,7 @@ public class PatternFilter extends ViewerFilter {
     /* (non-Javadoc)
      * @see org.eclipse.jface.viewers.ViewerFilter#select(org.eclipse.jface.viewers.Viewer, java.lang.Object, java.lang.Object)
      */
-    public boolean select(Viewer viewer, Object parentElement,
+    public final boolean select(Viewer viewer, Object parentElement,
 			Object element) {
         return isElementVisible(viewer, element);
     }