org.aspectj/bridge/src/org/aspectj/bridge/IProgressListener.java

/* *******************************************************************
 * Copyright (c) 2003 Palo Alto Research Center, Incorporated (PARC).
 * 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: 
 *     Xerox/PARC     initial implementation 
 * ******************************************************************/


package org.aspectj.bridge;

/**
  * Used to give progress information typically to IDEs
  */
public interface IProgressListener {
	/**
	 * @param text the current phase of processing
	 */
	public void setText(String text);
	
	/**
	 * @param percentDone how much work is completed so far
	 */
	public void setProgress(double percentDone);
	
    /**
     * @param cancelRequested true if the caller wants the current compilation to stop asap
     */
	public void setCancelledRequested(boolean cancelRequested);
	
	/**
	 * @return true if the consumer of the progress info would like the compileation to stop
	 */
	public boolean isCancelledRequested();
	
}