case-study/jdt-after/ui/org/eclipse/jdt/ui/search/ISearchRequestor.java

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2008 IBM Corporation and others.
   3  * All rights reserved. This program and the accompanying materials
   4  * are made available under the terms of the Eclipse Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/epl-v10.html
   7  *
   8  * Contributors:
   9  *     IBM Corporation - initial API and implementation
  10  *******************************************************************************/
  11 package org.eclipse.jdt.ui.search;
  12
  13 import org.eclipse.search.ui.text.Match;
  14
  15 /**
  16  * A callback interface to report matches against. This class serves as a bottleneck and minimal interface
  17  * to report matches to the Java search infrastructure. Query participants will be passed an
  18  * instance of this interface when their <code>search(...)</code> method is called.
  19  * <p>
  20  * This interface is not intended to be implemented by clients.
  21  * </p>
  22  *
  23  * @since 3.0
  24  *
  25  * @noimplement This interface is not intended to be implemented by clients.
  26  * @noextend This interface is not intended to be extended by clients.
  27  */
  28 public interface ISearchRequestor {
  29         /**
  30          * Adds a match to the search that issued this particular {@link ISearchRequestor}.
  31          * @param match The match to be reported.
  32          */
  33         void reportMatch(Match match);
  34 }