/*******************************************************************************
 * Copyright (c) 2012 VMWare, Inc.
 * 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:
 * VMWare, Inc. - initial API and implementation
 *******************************************************************************/
package org.springsource.ide.eclipse.commons.quicksearch.core;


/**
 * Plays a similar role than SearchReqeustor in eclipse Searches. I.e. a search requestor
 * is some entity accepting the results of a search. Typically the requestor displays the
 * result to the user.
 * <p>
 * This API differs a little from the Eclipse SearchRequestor in that searches are 'live'
 * in the sense that they update while the user is typing. As the user is typing the
 * query is changing. This may result in results already results being changed or revoked.
 * 
 * @author Kris De Volder
 */
public class QuickTextSearchRequestor {
	
	/**
	 * Called when a line of text containing the search text is found.
	 */
	public void add(LineItem match) {}

	/**
	 * Called when a previously added line of text needs to be redisplayed (this happens if
	 * the query has changed but still matches the line. The line is still a match, but
	 * the highlighting of the search term is different.
	 */
	public void update(LineItem match) {}

	/**
	 * Called when a line of text previously added is no longer a match for the current query
	 */
	public void revoke(LineItem line) {}
	
	/**
	 * Called when all previous results have become invalidated at once.
	 */
	public void clear() {}
}

@@ -878,41 +878,41 @@
 ive'
+.
 %0A * 
-in
+I.e
  the 
-sense that they
+results are
  updat
-e
+ing
  whi
@@ -936,38 +936,29 @@
 ping
-. As
  the 
-user is typing
+query.%0A * As
  the
-%0A *
  que
@@ -975,19 +975,19 @@
 ging
-. T
+, t
 his may 
 resu
@@ -986,17 +986,13 @@
 may 
-result in
+cause
  res
@@ -1000,23 +1000,31 @@
 lts 
-al
+that we
 re
+ 
 ad
-y results
+ded earlier
  bei
@@ -1037,16 +1037,20 @@
 nged or 
+%0A * 
 revoked.
@@ -1389,17 +1389,22 @@
 e line. 
-T
+I.e. t
 he line 
@@ -1619,16 +1619,66 @@
 nt query
+.%0A%09 * I.e. the line should no longer be displayed.
 %0A%09 */%0A%09p
@@ -1773,27 +1773,159 @@
 ome 
-invalidated at once
+revoked at once.%0A%09 * This happens when a query is changed in such a way that it can't be updated%0A%09 * incrementally but needs to be completely restarted
 .%0A%09 

Comment spelling