Package org.eclipse.search.ui

Interface IGroupByKeyComputer

@Deprecated(forRemoval=true) public interface IGroupByKeyComputer
Deprecated, for removal: This API element is subject to removal in a future version.
Part of the old ('classic') search result view. Since 3.0 clients can create their own search result view pages (see 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.
Computes the key by which the markers in the search result view are grouped.

Clients may implement this interface.

Restriction:
Restriction:
Restriction:
Restriction:
This class is not intended to be instantiated by clients.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    computeGroupByKey(IMarker marker)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Computes and returns key by which the given marker is grouped.

  • Method Details

    • computeGroupByKey

      Object computeGroupByKey(IMarker marker)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Computes and returns key by which the given marker is grouped.
      Parameters:
      marker - the marker for which the key must be computed
      Returns:
      an object that will be used as the key for that marker, null if the marker seems to be invalid