2424
2525/**
2626 * This class is an example for using an {@link ObservableInputStream}. It
27- * creates its own {@link Observer}, which calculates a checksum using a
28- * MessageDigest, for example an MD5 sum.
29- * {@em Note} : Neither {@link ObservableInputStream}, nor {@link MessageDigest},
27+ * creates its own {@link org.apache.commons.io.input.ObservableInputStream. Observer},
28+ * which calculates a checksum using a MessageDigest, for example an MD5 sum.
29+ * <em> Note</em> : Neither {@link ObservableInputStream}, nor {@link MessageDigest},
3030 * are thread safe. So is {@link MessageDigestCalculatingInputStream}.
3131 */
3232public class MessageDigestCalculatingInputStream extends ObservableInputStream {
33+
3334 public static class MessageDigestMaintainingObserver extends Observer {
3435 private final MessageDigest md ;
3536
@@ -58,12 +59,14 @@ public MessageDigestCalculatingInputStream(InputStream pStream, MessageDigest pD
5859 messageDigest = pDigest ;
5960 add (new MessageDigestMaintainingObserver (pDigest ));
6061 }
62+
6163 /** Creates a new instance, which calculates a signature on the given stream,
6264 * using a {@link MessageDigest} with the given algorithm.
6365 */
6466 public MessageDigestCalculatingInputStream (InputStream pStream , String pAlgorithm ) throws NoSuchAlgorithmException {
6567 this (pStream , MessageDigest .getInstance (pAlgorithm ));
6668 }
69+
6770 /** Creates a new instance, which calculates a signature on the given stream,
6871 * using a {@link MessageDigest} with the "MD5" algorithm.
6972 */
@@ -73,7 +76,7 @@ public MessageDigestCalculatingInputStream(InputStream pStream) throws NoSuchAlg
7376
7477 /** Returns the {@link MessageDigest}, which is being used for generating the
7578 * checksum.
76- * {@em Note} : The checksum will only reflect the data, which has been read so far.
79+ * <em> Note</em> : The checksum will only reflect the data, which has been read so far.
7780 * This is probably not, what you expect. Make sure, that the complete data has been
7881 * read, if that is what you want. The easiest way to do so is by invoking
7982 * {@link #consume()}.
0 commit comments