KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > team > ui > history > IHistoryCompareAdapter


1 /*******************************************************************************
2  * Copyright (c) 2006 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.team.ui.history;
12
13 import org.eclipse.compare.CompareConfiguration;
14 import org.eclipse.compare.structuremergeviewer.ICompareInput;
15 import org.eclipse.core.runtime.IProgressMonitor;
16
17 /**
18  * An adaptation for a history page for displaying comparisons
19  * triggered by history page selections.
20  *
21  * @since 3.2
22  * @see HistoryPageSaveablePart
23  * @see IHistoryPage
24  */

25 public interface IHistoryCompareAdapter {
26     
27     /**
28      * Returns an ICompareInput for the passed in object.
29      * @param object the object
30      * @return returns an ICompareInput
31      */

32     public ICompareInput getCompareInput(Object JavaDoc object);
33     
34     /**
35      * Prepare the compare input for display. Clients can perform
36      * any long running preparations and assign labels to the
37      * compare configuration.
38      * @param input the compare input
39      * @param configuration the compare configuration
40      * @param monitor a progress monitor
41      */

42     public void prepareInput(ICompareInput input, CompareConfiguration configuration, IProgressMonitor monitor);
43     
44 }
45
Popular Tags