ipreverifier.java

eclipseme的最新版本的source,欢迎j2me程序员使用

/**
 * Copyright (c) 2003 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.core.model;

import java.io.File;
import java.io.IOException;

import org.eclipse.core.resources.IFolder;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.QualifiedName;

import eclipseme.core.internal.EclipseMECorePlugin;
import eclipseme.core.persistence.IPersistable;
import eclipseme.preverifier.results.PreverificationError;


/**
 * Required interface for preverification support.  Each
 * IPlatformDefinition is required to provide a preverifier
 * instance for use during builds.
 * <p>
 * <b>Note:</b> This class/interface is part of an interim API that is still under development and expected to
 * change before reaching stability. It is being made available at this early stage to solicit feedback
 * from pioneering adopters on the understanding that any code that uses this API will almost 
 * certainly be broken as the API evolves.
 * </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.9 $
 * <br>
 * $Date: 2006/11/12 01:11:01 $
 * <br>
 * @author Craig Setera
 */
public interface IPreverifier extends IPersistable {
	// Declare whether classes should be preverified by the preverifier
	public static final String BUILD_ARG_PREVERIFY_CLASSES = "preverifyClasses";
	
	// Declare whether libraries should be preverified by the preverifier
	public static final String BUILD_ARG_PREVERIFY_LIBS = "preverifyLibraries";
	
	// Declare what project the output of the preverifier should be placed
	public static final String BUILD_ARG_PREVERIFY_TARGET = "preverifyTargetProject";

	// A temporary project property that is passed through to the preverifier
	// to determine to what project the preverification output will be written
	public static final QualifiedName PREVERIFY_TARGET_PROJECT = new QualifiedName(
		EclipseMECorePlugin.getDefault().getBundle().getSymbolicName(), 
		BUILD_ARG_PREVERIFY_TARGET);
	
	/**
	 * Launch the preverification process on the specified
	 * resources.
	 * 
	 * @param midletProject The project in which the resources to
	 * be preverified reside.
	 * @param toVerify The resources to be preverified.
	 * @param outputFolder The folder into which the output is to
	 * be placed.
	 * @param monitor Progress monitor
	 * @return An array of preverification error instances.
	 * @throws CoreException 
	 * @throws IOException
	 */
	public PreverificationError[] preverify(
		IMidletSuiteProject midletProject, 
		IResource[] toVerify,
		IFolder outputFolder,
		IProgressMonitor monitor) 
			throws CoreException, IOException;

	/**
	 * Launch the preverification process on the specified
	 * jar file.
	 * 
	 * @param midletProject The project in which the resources to
	 * be preverified reside.
	 * @param jarFile The jar file to be preverified.
	 * @param outputFolder The folder into which the output is to
	 * be placed.
	 * @param monitor Progress monitor
	 * @return An array of preverification error instances.
	 * @throws CoreException 
	 * @throws IOException
	 */
	public PreverificationError[] preverifyJarFile(
		IMidletSuiteProject midletProject, 
		File jarFile,
		IFolder outputFolder,
		IProgressMonitor monitor) 
			throws CoreException, IOException;
}