This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-io.git
The following commit(s) were added to refs/heads/master by this push:
new cd2f42d Javadoc.
cd2f42d is described below
commit cd2f42d8f3768c817dd01c74d1bd07da8038b9c0
Author: Gary Gregory <gardgreg...@gmail.com>
AuthorDate: Wed May 19 11:10:03 2021 -0400
Javadoc.
---
.../org/apache/commons/io/input/ObservableInputStream.java | 13 +++++++++----
1 file changed, 9 insertions(+), 4 deletions(-)
diff --git
a/src/main/java/org/apache/commons/io/input/ObservableInputStream.java
b/src/main/java/org/apache/commons/io/input/ObservableInputStream.java
index 21946f3..6995edb 100644
--- a/src/main/java/org/apache/commons/io/input/ObservableInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ObservableInputStream.java
@@ -28,10 +28,15 @@ import org.apache.commons.io.IOUtils;
/**
* The {@link ObservableInputStream} allows, that an InputStream may be
consumed by other receivers, apart from the
- * thread, which is reading it. The other consumers are implemented as
instances of {@link Observer}. A typical
- * application may be the generation of a {@link java.security.MessageDigest}
on the fly. {@code Note}: The
- * {@link ObservableInputStream} is <em>not</em> thread safe, as instances of
InputStream usually aren't. If you must
- * access the stream from multiple threads, then synchronization, locking, or
a similar means must be used.
+ * thread, which is reading it. The other consumers are implemented as
instances of {@link Observer}.
+ * <p>
+ * A typical application may be the generation of a {@link
java.security.MessageDigest} on the fly.
+ * </p>
+ * <p>
+ * <em>Note</em>: The {@link ObservableInputStream} is <em>not</em> thread
safe, as instances of InputStream usually
+ * aren't. If you must access the stream from multiple threads, then
synchronization, locking, or a similar means must
+ * be used.
+ * </p>
*
* @see MessageDigestCalculatingInputStream
*/
