chore:add javadoc about being called within single thread (#856)

* chore:add javadoc about being called within single thread * rephrased the words * Updated with feedback comment * removed extra whitespace
googleapis · Jan 31, 2020 · ee90c2c · ee90c2c
1 parent 955019c
commit ee90c2c
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/gax/src/main/java/com/google/api/gax/batching/Batcher.java b/gax/src/main/java/com/google/api/gax/batching/Batcher.java
@@ -38,6 +38,9 @@
  * when triggered by an internal threshold. This is intended to be used for high throughput
  * scenarios at the cost of latency.
  *
+ * <p>Batcher instances are not thread safe. To use across different threads, create a new Batcher
+ * instance per thread.
+ *
  * @param <ElementT> The type of each individual element to be batched.
  * @param <ElementResultT> The type of the result for each individual element.
  */