bundles/org.eclipse.core.databinding.observable/src/org/eclipse/core/databinding/observable/value/IValueChangingListener.java

/*******************************************************************************
 * Copyright (c) 2005, 2007 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.core.databinding.observable.value;

import org.eclipse.core.databinding.observable.IObservablesListener;

/**
 * Listener for pre-change events for observable values.
 * 
 * @param <T>
 * 
 * @since 1.0
 * 
 */
public interface IValueChangingListener<T> extends
		IObservablesListener<IValueChangingListener<T>> {

	/**
	 * This method is called when the value is about to change and provides an
	 * opportunity to veto the change. The given event object must only be used
	 * locally in this method because it may be reused for other change
	 * notifications. The diff object referenced by the event is immutable and
	 * may be used non-locally.
	 * 
	 * @param event
	 */
	public void handleValueChanging(ValueChangingEvent<T> event);

}