org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IFileBufferListener.java

/**********************************************************************
Copyright (c) 2000, 2003 IBM Corp. and others.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Common Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/cpl-v10.html

Contributors:
	IBM Corporation - Initial implementation
**********************************************************************/
package org.eclipse.core.filebuffers;

import org.eclipse.core.resources.IFile;

/**
 * Interface for listeners of file buffer changes.
 * 
 * @since 3.0
 */
public interface IFileBufferListener {

	/**
	 * Informs the listener about an upcoming replace of the contents of the given buffer.
	 * 
	 * @param buffer the effected file buffer
	 */
	void bufferContentAboutToBeReplaced(IFileBuffer buffer);
	
	/**
	 * Informs the listener that the buffer of the given buffer has been replaced.
	 * 
	 * @param buffer the effected file buffer
	 */
	void bufferContentReplaced(IFileBuffer buffer);

	/**
	 * Informs the listener about the start of a state changing operation on
	 * the given buffer.
	 * 
	 * @param buffer the effected file buffer
	 */
	void stateChanging(IFileBuffer buffer);
	
	/**
	 * Informs the listener that the dirty state of the given buffer changed
	 * to the specified value
	 * 
	 * @param buffer the effected file buffer
	 * @param isDirty <code>true</code> if the buffer is dirty, <code>false</code> otherwise
	 */
	void dirtyStateChanged(IFileBuffer buffer, boolean isDirty);
	
	/**
	 * Informs the listener that the state validation changed to the specified value.
	 * 
	 * @param buffer the effected file buffer
	 * @param isStateValidated <code>true</code> if the buffer state is validated, <code>false</code> otherwise
	 */
	void stateValidationChanged(IFileBuffer buffer, boolean isStateValidated);
	
	/**
	 * Informs the listener that the file underlying the given file buffer has been moved to the
	 * given location.
	 * 
	 * @param buffer the effected file buffer
	 * @param target the new location
	 */
	void underlyingFileMoved(IFileBuffer buffer, IFile target);
	
	/**
	 * Informs the listener that the file underlying the given file buffer has been deleted.
	 * 
	 * @param buffer the effected file buffer
	 */
	void underlyingFileDeleted(IFileBuffer buffer);
	
	/**
	 * Informs the listener that a state changing operation on the given
	 * file buffer failed.
	 * 
	 * @param buffer the effected file buffer
	 */
	void stateChangeFailed(IFileBuffer buffer);
}