com.helger.commons.io.stream

Class MessageDigestInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.helger.commons.io.stream.WrappedInputStream

com.helger.commons.io.stream.MessageDigestInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class MessageDigestInputStream
extends WrappedInputStream

A wrapper around an InputStream that performs a hashing while reading.

Author:

Philip Helger

See Also:

IMessageDigestGenerator

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
MessageDigestInputStream(InputStream aSourceIS, EMessageDigestAlgorithm eMDAlgorithm)
MessageDigestInputStream(InputStream aSourceIS, IMessageDigestGenerator aMDGen)

Method Summary

Modifier and Type	Method and Description
byte[]	getAllDigestBytes() Get the message digest of this stream.
int	read()
int	read(byte[] b, int nOffset, int nLength)
String	toString()

Methods inherited from class com.helger.commons.io.stream.WrappedInputStream

getWrappedInputStream

Methods inherited from class java.io.FilterInputStream

available, close, mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MessageDigestInputStream

public MessageDigestInputStream(@Nonnull
                                InputStream aSourceIS,
                                @Nonnull
                                EMessageDigestAlgorithm eMDAlgorithm)

MessageDigestInputStream

public MessageDigestInputStream(@Nonnull
                                InputStream aSourceIS,
                                @Nonnull
                                IMessageDigestGenerator aMDGen)

Method Detail

read

public int read()
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

public int read(byte[] b,
                int nOffset,
                int nLength)
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

getAllDigestBytes

@Nonnull
 @ReturnsMutableCopy
public byte[] getAllDigestBytes()

Get the message digest of this stream. Call this only once the reading has been finished. Never call this in the middle of reading a stream, because the digest cannot be updated afterwards.

Returns:

The message digest of this stream. Never null.

toString

public String toString()

Overrides:

toString in class WrappedInputStream