KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jface > text > reconciler > IReconcilingStrategyExtension


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.jface.text.reconciler;
12
13 import org.eclipse.core.runtime.IProgressMonitor;
14
15
16 /**
17  * Extends {@link org.eclipse.jface.text.reconciler.IReconcilingStrategy}
18  * with the following functions:
19  * <ul>
20  * <li>usage of a progress monitor</li>
21  * <li>initial reconciling step: if a reconciler runs as periodic activity in the background, this
22  * methods offers the reconciler a chance for initializing its strategies and achieving a
23  * reconciled state before the periodic activity starts.</li>
24  * </ul>
25  *
26  * @since 2.0
27  */
28 public interface IReconcilingStrategyExtension {
29
30     /**
31      * Tells this reconciling strategy with which progress monitor
32      * it will work. This method will be called before any other
33      * method and can be called multiple times.
34      *
35      * @param monitor the progress monitor with which this strategy will work
36      */
37     void setProgressMonitor(IProgressMonitor monitor);
38
39     /**
40      * Called only once in the life time of this reconciling strategy.
41      */
42     void initialReconcile();
43 }
44
Popular Tags