/**
 * Copyright (c) 2003-2005 Craig Setera
 * All Rights Reserved.
 * Licensed under the Eclipse Public License - v 1.0
 * For more information see http://www.eclipse.org/legal/epl-v10.html
 */
package eclipseme.preverifier;

import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;

import eclipseme.preverifier.results.PreverificationResults;

/**
 * An interface that clients may provide when preverifying
 * archive files to receive callbacks concerning preverification
 * processing.
 * <p />
 * Copyright (c) 2003-2005 Craig Setera<br>
 * All Rights Reserved.<br>
 * Licensed under the Eclipse Public License - v 1.0<p/>
 * <br>
 * $Revision: 1.1 $
 * <br>
 * $Date: 2005/09/25 23:53:31 $
 * <br>
 * @author Craig Setera
 */
public interface IArchivePreverificationListener {
	/**
	 * Preverification is beginning on the specified archive
	 * file.
	 * 
	 * @param archive
	 */
	void fileBegin(ZipFile archive);
	
	/**
	 * Preverification is beginning on the specified entry in
	 * the specified archive file.  The listener must return
	 * a boolean indicating whether to continue with the preverification
	 * processing.
	 * 
	 * @param archive
	 * @param classEntry
	 * @return
	 */
	boolean classBegin(ZipFile archive, ZipEntry classEntry);
	
	/**
	 * Preverification is ending on the specified entry in
	 * the specified archive file.  The listener must return
	 * a boolean indicating whether to continue with the preverification
	 * processing.
	 * 
	 * @param archive
	 * @param classEntry
	 * @return
	 */
	boolean classEnd(ZipFile archive, ZipEntry classEntry, PreverificationResults results);
	
	/**
	 * Preverification is ending on the specified archive
	 * file.
	 * 
	 * @param archive
	 */
	void fileEnd(ZipFile archive);
}