org.eclipse.search.ui.text

Class MatchFilter

java.lang.Object

org.eclipse.search.ui.text.MatchFilter

public abstract class MatchFilter
extends java.lang.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 and Description
MatchFilter()

Method Summary

Modifier and Type	Method and Description
abstract boolean	filters(Match match) Returns whether the given match is filtered by this filter.
abstract java.lang.String	getActionLabel() Returns the label of the filter as shown by the filter action.
abstract java.lang.String	getDescription() Returns the description of the filter as shown in the match filter selection dialog.
abstract java.lang.String	getID() Returns an ID of this filter.
abstract java.lang.String	getName() Returns the name of the filter as shown in the match filter selection dialog.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MatchFilter

public MatchFilter()

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 true if the given match should be filtered or false if not.

getName

public abstract java.lang.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 java.lang.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 java.lang.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 java.lang.String getID()

Returns an ID of this filter.

Returns:

the id of the filter to be used when persisting this filter.