org.eclipse.compare.structuremergeviewer.ICompareInputChangeListener Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright (c) 2000, 2011 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.compare.structuremergeviewer;

/**
 * Listener that gets informed if one (or more)
 * of the three sides of an {@link ICompareInput} object changes its value.
 * 
 * For example when accepting an incoming addition
 * the (non-{@code null}) left side of an {@link ICompareInput}
 * is copied to the right side (which was {@code null}).
 * This triggers a call to {@link #compareInputChanged} of registered
 * {@code ICompareInputChangeListener}.
 * 

 * Note however, that listener are not informed if the content of one of the sides changes.
 * 

 * Clients may implement this interface. It is also implemented by viewers that take
 * an {@link ICompareInput} as input.
 * 
 */
public interface ICompareInputChangeListener {
	/**
	 * Called whenever the value (not the content) of one or more of the three sides
 	 * of a {@link ICompareInput} has changed.
	 *
	 * @param source the {@link ICompareInput} that has changed
	 */
	void compareInputChanged(ICompareInput source);
}