Bug 487303 - [Search] Remove "Classic Search" viewI20211018-1800I20211017-1800I20211016-1800I20211015-1800

Mark old API as deprecated for removal

Change-Id: I53422e13138062dff02089c9ad74fde9d81bf65a
Reviewed-on: https://git.eclipse.org/r/c/platform/eclipse.platform.text/+/186526
Tested-by: Platform Bot <platform-bot@eclipse.org>
Reviewed-by: Alexander Kurtakov <akurtako@redhat.com>

7 files changed, 257 insertions, 48 deletions

diff --git a/org.eclipse.search/.settings/.api_filters b/org.eclipse.search/.settings/.api_filters
index 7b25d242e3e..12ba7a376a7 100644
--- a/org.eclipse.search/.settings/.api_filters
+++ b/org.eclipse.search/.settings/.api_filters
@@ -16,4 +16,160 @@
             </message_arguments>
         </filter>
     </resource>
+    <resource path="search/org/eclipse/search/ui/IActionGroupFactory.java" type="org.eclipse.search.ui.IActionGroupFactory">
+        <filter comment="https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303" id="403853384">
+            <message_arguments>
+                <message_argument value="@noimplement"/>
+                <message_argument value="org.eclipse.search.ui.IActionGroupFactory"/>
+            </message_arguments>
+        </filter>
+        <filter comment="https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303" id="406052990">
+            <message_arguments>
+                <message_argument value="org.eclipse.search.ui.IActionGroupFactory"/>
+                <message_argument value="createActionGroup(ISearchResultView)"/>
+            </message_arguments>
+        </filter>
+    </resource>
+    <resource path="search/org/eclipse/search/ui/IContextMenuContributor.java" type="org.eclipse.search.ui.IContextMenuContributor">
+        <filter comment="https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303" id="403853384">
+            <message_arguments>
+                <message_argument value="@noimplement"/>
+                <message_argument value="org.eclipse.search.ui.IContextMenuContributor"/>
+            </message_arguments>
+        </filter>
+        <filter comment="https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303" id="406052990">
+            <message_arguments>
+                <message_argument value="org.eclipse.search.ui.IContextMenuContributor"/>
+                <message_argument value="fill(IMenuManager, IInputSelectionProvider)"/>
+            </message_arguments>
+        </filter>
+    </resource>
+    <resource path="search/org/eclipse/search/ui/IGroupByKeyComputer.java" type="org.eclipse.search.ui.IGroupByKeyComputer">
+        <filter comment="https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303" id="403853384">
+            <message_arguments>
+                <message_argument value="@noimplement"/>
+                <message_argument value="org.eclipse.search.ui.IGroupByKeyComputer"/>
+            </message_arguments>
+        </filter>
+        <filter comment="https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303" id="406052990">
+            <message_arguments>
+                <message_argument value="org.eclipse.search.ui.IGroupByKeyComputer"/>
+                <message_argument value="computeGroupByKey(IMarker)"/>
+            </message_arguments>
+        </filter>
+    </resource>
+    <resource path="search/org/eclipse/search/ui/ISearchResultView.java" type="org.eclipse.search.ui.ISearchResultView">
+        <filter comment="https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303" id="406052990">
+            <message_arguments>
+                <message_argument value="org.eclipse.search.ui.ISearchResultView"/>
+                <message_argument value="addMatch(String, Object, IResource, IMarker)"/>
+            </message_arguments>
+        </filter>
+        <filter comment="https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303" id="406052990">
+            <message_arguments>
+                <message_argument value="org.eclipse.search.ui.ISearchResultView"/>
+                <message_argument value="getLabelProvider()"/>
+            </message_arguments>
+        </filter>
+        <filter comment="https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303" id="406052990">
+            <message_arguments>
+                <message_argument value="org.eclipse.search.ui.ISearchResultView"/>
+                <message_argument value="getSelection()"/>
+            </message_arguments>
+        </filter>
+        <filter comment="https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303" id="406052990">
+            <message_arguments>
+                <message_argument value="org.eclipse.search.ui.ISearchResultView"/>
+                <message_argument value="searchFinished()"/>
+            </message_arguments>
+        </filter>
+        <filter comment="https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303" id="406052990">
+            <message_arguments>
+                <message_argument value="org.eclipse.search.ui.ISearchResultView"/>
+                <message_argument value="searchStarted(IActionGroupFactory, String, String, ImageDescriptor, String, ILabelProvider, IAction, IGroupByKeyComputer, IRunnableWithProgress)"/>
+            </message_arguments>
+        </filter>
+        <filter comment="https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303" id="406052990">
+            <message_arguments>
+                <message_argument value="org.eclipse.search.ui.ISearchResultView"/>
+                <message_argument value="searchStarted(String, String, ImageDescriptor, IContextMenuContributor, ILabelProvider, IAction, IGroupByKeyComputer, IRunnableWithProgress)"/>
+            </message_arguments>
+        </filter>
+        <filter comment="https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303" id="406052990">
+            <message_arguments>
+                <message_argument value="org.eclipse.search.ui.ISearchResultView"/>
+                <message_argument value="searchStarted(String, String, String, ImageDescriptor, IContextMenuContributor, ILabelProvider, IAction, IGroupByKeyComputer, IRunnableWithProgress)"/>
+            </message_arguments>
+        </filter>
+    </resource>
+    <resource path="search/org/eclipse/search/ui/ISearchResultViewEntry.java" type="org.eclipse.search.ui.ISearchResultViewEntry">
+        <filter comment="https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303" id="406052990">
+            <message_arguments>
+                <message_argument value="org.eclipse.search.ui.ISearchResultViewEntry"/>
+                <message_argument value="getGroupByKey()"/>
+            </message_arguments>
+        </filter>
+        <filter comment="https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303" id="406052990">
+            <message_arguments>
+                <message_argument value="org.eclipse.search.ui.ISearchResultViewEntry"/>
+                <message_argument value="getMatchCount()"/>
+            </message_arguments>
+        </filter>
+        <filter comment="https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303" id="406052990">
+            <message_arguments>
+                <message_argument value="org.eclipse.search.ui.ISearchResultViewEntry"/>
+                <message_argument value="getResource()"/>
+            </message_arguments>
+        </filter>
+        <filter comment="https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303" id="406052990">
+            <message_arguments>
+                <message_argument value="org.eclipse.search.ui.ISearchResultViewEntry"/>
+                <message_argument value="getSelectedMarker()"/>
+            </message_arguments>
+        </filter>
+    </resource>
+    <resource path="search/org/eclipse/search/ui/SearchUI.java" type="org.eclipse.search.ui.SearchUI">
+        <filter comment="https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303" id="338944126">
+            <message_arguments>
+                <message_argument value="org.eclipse.search.ui.SearchUI"/>
+                <message_argument value="activateSearchResultView()"/>
+            </message_arguments>
+        </filter>
+        <filter comment="https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303" id="338944126">
+            <message_arguments>
+                <message_argument value="org.eclipse.search.ui.SearchUI"/>
+                <message_argument value="arePotentialMatchesIgnored()"/>
+            </message_arguments>
+        </filter>
+        <filter comment="https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303" id="338944126">
+            <message_arguments>
+                <message_argument value="org.eclipse.search.ui.SearchUI"/>
+                <message_argument value="getDefaultPerspectiveId()"/>
+            </message_arguments>
+        </filter>
+        <filter comment="https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303" id="338944126">
+            <message_arguments>
+                <message_argument value="org.eclipse.search.ui.SearchUI"/>
+                <message_argument value="getSearchMarkerImage()"/>
+            </message_arguments>
+        </filter>
+        <filter comment="https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303" id="338944126">
+            <message_arguments>
+                <message_argument value="org.eclipse.search.ui.SearchUI"/>
+                <message_argument value="getSearchResultView()"/>
+            </message_arguments>
+        </filter>
+        <filter comment="https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303" id="338944126">
+            <message_arguments>
+                <message_argument value="org.eclipse.search.ui.SearchUI"/>
+                <message_argument value="openSearchDialog(IWorkbenchWindow, String)"/>
+            </message_arguments>
+        </filter>
+        <filter comment="https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303" id="338944126">
+            <message_arguments>
+                <message_argument value="org.eclipse.search.ui.SearchUI"/>
+                <message_argument value="reuseEditor()"/>
+            </message_arguments>
+        </filter>
+    </resource>
 </component>
diff --git a/org.eclipse.search/search/org/eclipse/search/ui/IActionGroupFactory.java b/org.eclipse.search/search/org/eclipse/search/ui/IActionGroupFactory.java
index a6fbec4a276..b36f71d08c6 100644
--- a/org.eclipse.search/search/org/eclipse/search/ui/IActionGroupFactory.java
+++ b/org.eclipse.search/search/org/eclipse/search/ui/IActionGroupFactory.java
@@ -21,24 +21,34 @@ import org.eclipse.jface.viewers.ILabelProvider;
 import org.eclipse.ui.actions.ActionGroup;
 
 /**
- * Allows to specify an <code>ActionGroup</code> factory
- * which will be used by the Search view to create an
- * <code>ActionGroup</code> which is used to build the
- * actions bars and the context menu.
+ * Allows to specify an <code>ActionGroup</code> factory which will be used by
+ * the Search view to create an <code>ActionGroup</code> which is used to build
+ * the actions bars and the context menu.
  * <p>
  * Note: Local tool bar contributions are not supported in 2.0.
  * </p>
  *
- * Clients can implement this interface and pass an
- * instance to the search result view.
+ * Clients can implement this interface and pass an instance to the search
+ * result view.
  *
- * @see	org.eclipse.ui.actions.ActionGroup
- * @see	ISearchResultView#searchStarted(IActionGroupFactory, String, String, ImageDescriptor, String, ILabelProvider, IAction, IGroupByKeyComputer, IRunnableWithProgress)
- * @since 	2.0
- * @deprecated Part of the old ('classic') search result view. Since 3.0 clients can create their own search result view pages (see {@link ISearchResultPage}), leaving it up to the page
- * how to create actions.
+ * @see org.eclipse.ui.actions.ActionGroup
+ * @see ISearchResultView#searchStarted(IActionGroupFactory, String, String,
+ *      ImageDescriptor, String, ILabelProvider, IAction, IGroupByKeyComputer,
+ *      IRunnableWithProgress)
+ * @since 2.0
+ * @deprecated Part of the old ('classic') search result view. Since 3.0 clients
+ *             can create their own search result view pages (see
+ *             {@link ISearchResultPage}), leaving it up to the page how to
+ *             create actions. This class will be removed after 2023-09 release.
+ *             See https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303 for more
+ *             information.
+ *
+ * @noinstantiate This class is not intended to be instantiated by clients.
+ * @noreference
+ * @noextend
+ * @noimplement
  */
-@Deprecated
+@Deprecated(forRemoval = true)
 public interface IActionGroupFactory {
 
 	/**
diff --git a/org.eclipse.search/search/org/eclipse/search/ui/IContextMenuContributor.java b/org.eclipse.search/search/org/eclipse/search/ui/IContextMenuContributor.java
index 57e19adee04..804dfd8afae 100644
--- a/org.eclipse.search/search/org/eclipse/search/ui/IContextMenuContributor.java
+++ b/org.eclipse.search/search/org/eclipse/search/ui/IContextMenuContributor.java
@@ -21,17 +21,27 @@ import org.eclipse.jface.viewers.IInputSelectionProvider;
 import org.eclipse.jface.viewers.ILabelProvider;
 
 /**
- * Specify how clients can add menu items
- * to the context menu of the search result view.
- * A class that contributes context menu items
- * must implement this interface and pass an
- * instance of itself to the search result view.
+ * Specify how clients can add menu items to the context menu of the search
+ * result view. A class that contributes context menu items must implement this
+ * interface and pass an instance of itself to the search result view.
  *
- * @see	ISearchResultView#searchStarted(IActionGroupFactory, String, String, ImageDescriptor, String, ILabelProvider, IAction, IGroupByKeyComputer, IRunnableWithProgress)
- * @deprecated Part of the old ('classic') search result view. Since 3.0 clients can create their own search result view pages (see {@link ISearchResultPage}), leaving it up to the page
- * how to create actions in context menus.
+ * @see ISearchResultView#searchStarted(IActionGroupFactory, String, String,
+ *      ImageDescriptor, String, ILabelProvider, IAction, IGroupByKeyComputer,
+ *      IRunnableWithProgress)
+ * @deprecated Part of the old ('classic') search result view. Since 3.0 clients
+ *             can create their own search result view pages (see
+ *             {@link ISearchResultPage}), leaving it up to the page how to
+ *             create actions in context menus. This class will be removed after
+ *             2023-09 release. See
+ *             https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303 for more
+ *             information.
+ *
+ * @noinstantiate This class is not intended to be instantiated by clients.
+ * @noreference
+ * @noextend
+ * @noimplement
  */
-@Deprecated
+@Deprecated(forRemoval = true)
 public interface IContextMenuContributor {
 
 	/**
diff --git a/org.eclipse.search/search/org/eclipse/search/ui/IGroupByKeyComputer.java b/org.eclipse.search/search/org/eclipse/search/ui/IGroupByKeyComputer.java
index a8dcd16dac3..ca94fee299d 100644
--- a/org.eclipse.search/search/org/eclipse/search/ui/IGroupByKeyComputer.java
+++ b/org.eclipse.search/search/org/eclipse/search/ui/IGroupByKeyComputer.java
@@ -16,17 +16,25 @@ package org.eclipse.search.ui;
 import org.eclipse.core.resources.IMarker;
 
 /**
- * Computes the key by which the markers in the search result view
- * are grouped.
+ * Computes the key by which the markers in the search result view are grouped.
  *
  * <p>
  * Clients may implement this interface.
  * </p>
  *
- * @deprecated Part of the old ('classic') search result view. Since 3.0 clients can create their own search result view pages (see {@link ISearchResultPage}), leaving it up to the page
- * how to group search results.
+ * @deprecated Part of the old ('classic') search result view. Since 3.0 clients
+ *             can create their own search result view pages (see
+ *             {@link ISearchResultPage}), leaving it up to the page how to
+ *             group search results. This class will be removed after 2023-09
+ *             release. See https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303
+ *             for more information.
+ *
+ * @noinstantiate This class is not intended to be instantiated by clients.
+ * @noreference
+ * @noextend
+ * @noimplement
  */
-@Deprecated
+@Deprecated(forRemoval = true)
 public interface IGroupByKeyComputer {
 
 	/**
diff --git a/org.eclipse.search/search/org/eclipse/search/ui/ISearchResultView.java b/org.eclipse.search/search/org/eclipse/search/ui/ISearchResultView.java
index 180084c81ab..9023d7f1800 100644
--- a/org.eclipse.search/search/org/eclipse/search/ui/ISearchResultView.java
+++ b/org.eclipse.search/search/org/eclipse/search/ui/ISearchResultView.java
@@ -25,25 +25,32 @@ import org.eclipse.jface.viewers.ISelection;
 import org.eclipse.ui.IViewPart;
 
 /**
- * Provides client access to the search result view.
- * Each element in the view is a <code>ISearchResultViewEntry</code>,
- * which groups markers based on the <code>groupByKey</code> provided
- * by the client each time when adding a match. If every match should
- * show up in the search result view then the match itself can be used
- * as key.
+ * Provides client access to the search result view. Each element in the view is
+ * a <code>ISearchResultViewEntry</code>, which groups markers based on the
+ * <code>groupByKey</code> provided by the client each time when adding a match.
+ * If every match should show up in the search result view then the match itself
+ * can be used as key.
  * <p>
- * The search result view has id <code>"org.eclipse.search.SearchResultView"</code>.
+ * The search result view has id
+ * <code>"org.eclipse.search.SearchResultView"</code>.
  * </p>
  * <p>
  * This interface is not intended to be implemented by clients.
  * </p>
- * @deprecated Part of the old ('classic') search result view. Since 3.0 clients can create their own search result view pages.
- * To access the parent view, {@link org.eclipse.search.ui.ISearchResultViewPart} is used instead.
+ * 
+ * @deprecated Part of the old ('classic') search result view. Since 3.0 clients
+ *             can create their own search result view pages. To access the
+ *             parent view, {@link org.eclipse.search.ui.ISearchResultViewPart}
+ *             is used instead. This class will be removed after 2023-09
+ *             release. See https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303
+ *             for more information.
  *
+ * @noinstantiate This class is not intended to be instantiated by clients.
+ * @noreference
  * @noimplement This interface is not intended to be implemented by clients.
  * @noextend This interface is not intended to be extended by clients.
  */
-@Deprecated
+@Deprecated(forRemoval = true)
 public interface ISearchResultView extends IViewPart {
 
 	/**
diff --git a/org.eclipse.search/search/org/eclipse/search/ui/ISearchResultViewEntry.java b/org.eclipse.search/search/org/eclipse/search/ui/ISearchResultViewEntry.java
index f7bb84653cc..d71bc573dc2 100644
--- a/org.eclipse.search/search/org/eclipse/search/ui/ISearchResultViewEntry.java
+++ b/org.eclipse.search/search/org/eclipse/search/ui/ISearchResultViewEntry.java
@@ -17,9 +17,8 @@ import org.eclipse.core.resources.IMarker;
 import org.eclipse.core.resources.IResource;
 
 /**
- * Specifies a search result view entry.
- * This entry provides information about the markers
- * it groups by a client defined key. Each entry in the search
+ * Specifies a search result view entry. This entry provides information about
+ * the markers it groups by a client defined key. Each entry in the search
  * result view corresponds to a different key.
  * <p>
  * The UI allows stepping through this entry's markers grouped by the key.
@@ -27,13 +26,24 @@ import org.eclipse.core.resources.IResource;
  * <p>
  * This interface is not intended to be implemented by clients.
  * </p>
- * @deprecated Part of the old ('classic') search result view. Since 3.0 clients can create their own search result view pages (see {@link ISearchResultPage}), leaving it up to the search
- * how to model search results. {@link org.eclipse.search.ui.text.AbstractTextSearchResult} and {@link org.eclipse.search.ui.text.Match} can be used to port old searches to the new API design.
+ * 
+ * @deprecated Part of the old ('classic') search result view. Since 3.0 clients
+ *             can create their own search result view pages (see
+ *             {@link ISearchResultPage}), leaving it up to the search how to
+ *             model search results.
+ *             {@link org.eclipse.search.ui.text.AbstractTextSearchResult} and
+ *             {@link org.eclipse.search.ui.text.Match} can be used to port old
+ *             searches to the new API design. This class will be removed after
+ *             2023-09 release. See
+ *             https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303 for more
+ *             information.
  *
+ * @noinstantiate This class is not intended to be instantiated by clients.
+ * @noreference
  * @noimplement This interface is not intended to be implemented by clients.
  * @noextend This interface is not intended to be extended by clients.
  */
-@Deprecated
+@Deprecated(forRemoval = true)
 public interface ISearchResultViewEntry {
 
 	/**
diff --git a/org.eclipse.search/search/org/eclipse/search/ui/SearchUI.java b/org.eclipse.search/search/org/eclipse/search/ui/SearchUI.java
index 960f96bf840..31bbdd307b9 100644
--- a/org.eclipse.search/search/org/eclipse/search/ui/SearchUI.java
+++ b/org.eclipse.search/search/org/eclipse/search/ui/SearchUI.java
@@ -28,22 +28,30 @@ import org.eclipse.search.internal.ui.SearchPreferencePage;
 import org.eclipse.search.internal.ui.util.ExceptionHandler;
 
 /**
- * The central class for access to the Search Plug-in's User Interface.
- * This class cannot be instantiated; all functionality is provided by
- * static methods.
+ * The central class for access to the Search Plug-in's User Interface. This
+ * class cannot be instantiated; all functionality is provided by static
+ * methods.
  *
  * Features provided:
  * <ul>
  * <li>convenient access to the search result view of the active workbench
- *   window.</li>
+ * window.</li>
  * </ul>
  *
  * @see ISearchResultView
- * @deprecated Part of the old ('classic') search. Since 3.0 clients can create their own search result view pages and use {@link org.eclipse.search.ui.NewSearchUI} instead.
+ * @deprecated Part of the old ('classic') search. Since 3.0 clients can create
+ *             their own search result view pages and use
+ *             {@link org.eclipse.search.ui.NewSearchUI} instead. This class
+ *             will be removed after 2023-09 release. See
+ *             https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303 for more
+ *             information.
  *
  * @noinstantiate This class is not intended to be instantiated by clients.
+ * @noreference
+ * @noextend
+ * @noimplement
  */
-@Deprecated
+@Deprecated(forRemoval = true)
 public final class SearchUI {
 
 	/**