xref: /external/jacoco/org.jacoco.core/src/org/jacoco/core/internal/analysis/filter/IFilter.java

/*******************************************************************************
 * Copyright (c) 2009, 2017 Mountainminds GmbH & Co. KG and Contributors
 * 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:
 *    Evgeny Mandrikov - initial API and implementation
 *
 *******************************************************************************/
package org.jacoco.core.internal.analysis.filter;

import org.objectweb.asm.tree.MethodNode;

/**
 * Interface for filter implementations. Instances of filters are reused and so
 * must be stateless.
 */
public interface IFilter {

	/**
	 * This method is called for every method. The filter implementation is
	 * expected to inspect the provided method and report its result to the
	 * given {@link IFilterOutput} instance.
	 *
	 * @param className
	 *            class name
	 * @param superClassName
	 *            superclass name
	 * @param methodNode
	 *            method to inspect
	 * @param output
	 *            callback to report filtering results to
	 */
	void filter(String className, String superClassName, MethodNode methodNode,
			IFilterOutput output);

}