[tika] branch main updated: improve documentation for the PipesReporter

[ta...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

tallison pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tika.git


The following commit(s) were added to refs/heads/main by this push:
     new 8e10ce118 improve documentation for the PipesReporter
8e10ce118 is described below

commit 8e10ce1188c44ef494f8f5b9c40eeec421eb7aaa
Author: tballison <ta...@apache.org>
AuthorDate: Wed Sep 28 11:28:16 2022 -0400

    improve documentation for the PipesReporter
---
 .../src/main/java/org/apache/tika/pipes/PipesReporter.java     | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/tika-core/src/main/java/org/apache/tika/pipes/PipesReporter.java b/tika-core/src/main/java/org/apache/tika/pipes/PipesReporter.java
index 645f6d4ec..73b93995a 100644
--- a/tika-core/src/main/java/org/apache/tika/pipes/PipesReporter.java
+++ b/tika-core/src/main/java/org/apache/tika/pipes/PipesReporter.java
@@ -19,6 +19,16 @@ package org.apache.tika.pipes;
 import java.io.Closeable;
 import java.io.IOException;
 
+/**
+ * This is called asynchronously by the AsyncProcessor. This
+ * is not thread safe, and implementers must be careful to implement
+ * {@link #report(FetchEmitTuple, PipesResult, long)} in a thread safe
+ * way.
+ * <p/>
+ * Note, however, that this is not called in the forked processes.
+ * Implementers do not have to worry about synchronizing across processes;
+ * for example, one could use an in-memory h2 database as a target.
+ */
 public abstract class PipesReporter implements Closeable {
 
     public static final PipesReporter NO_OP_REPORTER = new PipesReporter() {