ITestFinder.java

/*******************************************************************************
 * Copyright (c) 2000, 2008 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
 *     David Saff (saff@mit.edu) - initial API and implementation
 *             (bug 102632: [JUnit] Support for JUnit 4.)
 *******************************************************************************/

package org.phpsrc.eclipse.pti.tools.phpunit.core.launcher;

import java.util.Set;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.dltk.core.IModelElement;
import org.eclipse.dltk.core.IType;

/**
 * Interface to be implemented by for extension point
 * org.eclipse.jdt.junit.internal_testKinds.
 */
public interface ITestFinder {
	ITestFinder NULL = new ITestFinder() {
		public void findTestsInContainer(IModelElement element, Set result, IProgressMonitor pm) {
			// do nothing
		}

		public boolean isTest(IType type) {
			return false;
		}
	};

	/**
	 * @param element
	 *            element to search for tests
	 * @param result
	 *            a Set to add ITypes
	 * @param pm
	 *            the progress monitor
	 * @throws CoreException
	 *             thrown when tests can not be found
	 */
	public abstract void findTestsInContainer(IModelElement element, Set result, IProgressMonitor pm)
			throws CoreException;

	public abstract boolean isTest(IType type) throws CoreException;
}