aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc R. Hoffmann <hoffmann@mountainminds.com>2017-03-31 16:32:32 +0200
committerEvgeny Mandrikov <Godin@users.noreply.github.com>2017-03-31 16:32:32 +0200
commit1f34a6a6f07af31c40deb4f4cb7d19ae09c375e0 (patch)
tree7f410ba9b94371a1809e2e7986969ececaf5165f
parenteaef191fe12fc5abc81435016dbbd69cb55d1f68 (diff)
downloadjacoco-1f34a6a6f07af31c40deb4f4cb7d19ae09c375e0.tar.gz
Add Javadoc for IFilter#filter (#509)
-rw-r--r--org.jacoco.core/src/org/jacoco/core/internal/analysis/filter/IFilter.java10
1 files changed, 10 insertions, 0 deletions
diff --git a/org.jacoco.core/src/org/jacoco/core/internal/analysis/filter/IFilter.java b/org.jacoco.core/src/org/jacoco/core/internal/analysis/filter/IFilter.java
index ab2daa8e..c1bab8e6 100644
--- a/org.jacoco.core/src/org/jacoco/core/internal/analysis/filter/IFilter.java
+++ b/org.jacoco.core/src/org/jacoco/core/internal/analysis/filter/IFilter.java
@@ -19,6 +19,16 @@ import org.objectweb.asm.tree.MethodNode;
*/
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 methodNode
+ * method to inspect
+ * @param output
+ * callback to report filtering results to
+ */
void filter(MethodNode methodNode, IFilterOutput output);
}