org.eclipse.cdt.core.search
Interface ICSearchResultCollector

All Known Implementing Classes:

BasicSearchResultCollector

public interface ICSearchResultCollector

Field Summary

static int	EXACT_MATCH The search result corresponds exactly to the search pattern.
static int	POTENTIAL_MATCH The search result is potentially a match for the search pattern, but a problem prevented the search engine from being more accurate (typically because of the classpath was not correctly set).

Method Summary

void	aboutToStart() Called before the actual search starts.
boolean	acceptMatch(IMatch match)
IMatch	createMatch(Object fileResource, int start, int end, org.eclipse.cdt.core.parser.ISourceElementCallbackDelegate node, IPath referringElement)
void	done() Called when the search has ended.
IProgressMonitor	getProgressMonitor() Returns the progress monitor used to report progress.

Field Detail

EXACT_MATCH

public static final int EXACT_MATCH

The search result corresponds exactly to the search pattern.

See Also:

Constant Field Values

POTENTIAL_MATCH

public static final int POTENTIAL_MATCH

The search result is potentially a match for the search pattern, but a problem prevented the search engine from being more accurate (typically because of the classpath was not correctly set).

See Also:

Constant Field Values

Method Detail

aboutToStart

public void aboutToStart()

Called before the actual search starts.

done

public void done()

Called when the search has ended.

createMatch

public IMatch createMatch(Object fileResource,
                          int start,
                          int end,
                          org.eclipse.cdt.core.parser.ISourceElementCallbackDelegate node,
                          IPath referringElement)
                   throws CoreException

Throws:

CoreException

acceptMatch

public boolean acceptMatch(IMatch match)
                    throws CoreException

Throws:

CoreException

getProgressMonitor

public IProgressMonitor getProgressMonitor()

Returns the progress monitor used to report progress.

Returns:

a progress monitor or null if no progress monitor is provided