Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
Copyright (c) 2000, 2012 IBM Corporation and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html Contributors: IBM Corporation - initial API and implementation /
package org.eclipse.jdt.core.search;
import  org.eclipse.core.runtime.CoreException;

Collects the results from a search engine query. Clients implement a subclass to pass to SearchEngine.search and implement the acceptSearchMatch(SearchMatch) method, and possibly override other life cycle methods.

The search engine calls beginReporting() when a search starts, then calls acceptSearchMatch(...) for each search result, and finally calls endReporting(). The order of the search results is unspecified and may vary from request to request; when displaying results, clients should not rely on the order but should instead arrange the results in an order that would be more meaningful to the user.

Since:
3.0
See also:
SearchEngine
public abstract class SearchRequestor {

Accepts the given search match.

Parameters:
match the found match
Throws:
CoreException
	public abstract void acceptSearchMatch(SearchMatch matchthrows CoreException;

Notification sent before starting the search action. Typically, this would tell a search requestor to clear previously recorded search results.

The default implementation of this method does nothing. Subclasses may override.

	public void beginReporting() {
		// do nothing
	}

Notification sent after having completed the search action. Typically, this would tell a search requestor collector that no more results will be forthcoming in this search.

The default implementation of this method does nothing. Subclasses may override.

	public void endReporting() {
		// do nothing
	}

Intermediate notification sent when the given participant starts to contribute.

The default implementation of this method does nothing. Subclasses may override.

Parameters:
participant the participant that is starting to contribute
	public void enterParticipant(SearchParticipant participant) {
		// do nothing
	}

Intermediate notification sent when the given participant is finished contributing.

The default implementation of this method does nothing. Subclasses may override.

Parameters:
participant the participant that finished contributing
	public void exitParticipant(SearchParticipant participant) {
		// do nothing
	}
New to GrepCode? Check out our FAQ X