KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > compare > contentmergeviewer > IFlushable


1 /*******************************************************************************
2  * Copyright (c) 2000, 2007 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.compare.contentmergeviewer;
12
13 import org.eclipse.compare.IEditableContent;
14 import org.eclipse.core.runtime.IProgressMonitor;
15 import org.eclipse.jface.text.IDocument;
16
17 /**
18  * Interface which provides the ability to flush the contents from the viewer
19  * model (for example, an {@link IDocument} for text based content) into the
20  * underlying compare model ( most likely an instance of {@link IEditableContent}).
21  * <p>
22  * This interface may be implemented by clients.
23  * </p>
24  *
25  * @since 3.3
26  */
27 public interface IFlushable {
28     
29     /**
30      * Request that the view contents be flushed to the underlying compare input.
31      * Depending on the type of input, this may result in the contents being written
32      * into the underlying model (e.g. file) as well.
33      * @param monitor a progress monitor or <code>null</code> if progress reporting is not desired
34      */
35     void flush(IProgressMonitor monitor);
36 }
37
Popular Tags