KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > console > IPatternMatchListenerDelegate


1 /*******************************************************************************
2  * Copyright (c) 2000, 2005 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.ui.console;
12
13 /**
14  * A pattern match listener delegate is notified of regular expression matches
15  * in a text console. A delegate is contributed via the
16  * <code>consolePatternMatcherListeners</code> extension point.
17  * <p>
18  * Clients contributing a console pattern match listener extension are intended
19  * to implement this interface.
20  * </p>
21  * @see org.eclipse.ui.console.IPatternMatchListener
22  * @see org.eclipse.ui.console.TextConsole
23  * @since 3.1
24  */
25 public interface IPatternMatchListenerDelegate {
26     /**
27      * Notification that pattern matching will begin in the specified console.
28      * A pattern matcher is connected to only one console at a time.
29      *
30      * @param console the console in which pattern matching will be performed
31      */
32     public void connect(TextConsole console);
33     
34     /**
35      * Notification that pattern matching has been completed in the console
36      * this delegate was last connected to.
37      */
38     public void disconnect();
39     
40     /**
41      * Notification that a match has been found.
42      *
43      * @param event event describing where the match was found
44      */
45     public void matchFound(PatternMatchEvent event);
46 }
47
Popular Tags