Package org.eclipse.search.ui.text
Class MatchFilter
- java.lang.Object
-
- org.eclipse.search.ui.text.MatchFilter
-
public abstract class MatchFilter extends Object
A match filter is used to evaluate the filter state of a match (Match.isFiltered(). Filters are managed by the (AbstractTextSearchResult.- Since:
- 3.3
-
-
Constructor Summary
Constructors Constructor Description MatchFilter()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract booleanfilters(Match match)Returns whether the given match is filtered by this filter.abstract StringgetActionLabel()Returns the label of the filter as shown by the filter action.abstract StringgetDescription()Returns the description of the filter as shown in the match filter selection dialog.abstract StringgetID()Returns an ID of this filter.abstract StringgetName()Returns the name of the filter as shown in the match filter selection dialog.
-
-
-
Method Detail
-
filters
public abstract boolean filters(Match match)
Returns whether the given match is filtered by this filter.- Parameters:
match- the match to look at- Returns:
- returns
trueif the given match should be filtered orfalseif not.
-
getName
public abstract String getName()
Returns the name of the filter as shown in the match filter selection dialog.- Returns:
- the name of the filter as shown in the match filter selection dialog.
-
getDescription
public abstract String getDescription()
Returns the description of the filter as shown in the match filter selection dialog.- Returns:
- the description of the filter as shown in the match filter selection dialog.
-
getActionLabel
public abstract String getActionLabel()
Returns the label of the filter as shown by the filter action.- Returns:
- the label of the filter as shown by the filter action.
-
getID
public abstract String getID()
Returns an ID of this filter.- Returns:
- the id of the filter to be used when persisting this filter.
-
-