IPathVariableChangeListener.java

/*******************************************************************************
 *  Copyright (c) 2000, 2009 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.resources;

import java.util.EventListener;

/**
 * An interface to be implemented by objects interested in path variable
 * creation, removal and value change events.
 * 
 * <p>Clients may implement this interface.</p>
 * 
 * @since 2.1
 */
public interface IPathVariableChangeListener extends EventListener {
	/**
	 * Notification that a path variable has changed.
	 * <p>
	 * This method is called when a path variable is added, removed or has its value
	 * changed in the observed <code>IPathVariableManager</code> object.
	 * </p>
	 *
	 * @param event the path variable change event object describing which variable
	 *    changed and how
	 * @see IPathVariableManager#addChangeListener(IPathVariableChangeListener)
	 * @see IPathVariableManager#removeChangeListener(IPathVariableChangeListener)
	 * @see IPathVariableChangeEvent
	 */
	public void pathVariableChanged(IPathVariableChangeEvent event);

}