org.eclipse.team.ui.mapping
Interface IModelCompareInput

All Superinterfaces:

ICompareInput

public interface IModelCompareInput

extends ICompareInput

This interface defines extensions to the ICompareInput interface that are used for compae inputs that are returned from the ISynchronizationCompareAdapter.asCompareInput(org.eclipse.team.core.mapping.ISynchronizationContext, Object) method.

Clients may implement this interface.

EXPERIMENTAL. This class or interface has been added as part of a work in progress. There is a guarantee neither that this API will work nor that it will remain the same. Please do not use this API without consulting with the Platform/Team team.

Since:

3.2

See Also:

ISynchronizationCompareAdapter.asCompareInput(org.eclipse.team.core.mapping.ISynchronizationContext, Object)

Method Summary

ISaveableCompareModel	getCompareModel() Return the saveable compare model for this compare input or null if the input is saved directly to disk when the compare editor input is changed or the compare editor is closed.
void	prepareInput(CompareConfiguration configuration, IProgressMonitor monitor) Prepare the compare input associated with a model element for display using the compare configuration.

Methods inherited from interface org.eclipse.compare.structuremergeviewer.ICompareInput

addCompareInputChangeListener, copy, getAncestor, getImage, getKind, getLeft, getName, getRight, removeCompareInputChangeListener

Method Detail

getCompareModel

public ISaveableCompareModel getCompareModel()

Return the saveable compare model for this compare input or null if the input is saved directly to disk when the compare editor input is changed or the compare editor is closed.

Returns:

the saveable compare model for this compare input

prepareInput

public void prepareInput(CompareConfiguration configuration,
                         IProgressMonitor monitor)
                  throws CoreException

Prepare the compare input associated with a model element for display using the compare configuration.

Parameters:

configuration - the compare configuration for the editor that will display the input

monitor - a progress monitor

Throws:

CoreException