Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.

DigestInputStream

public class DigestInputStream
extends FilterInputStream

java.lang.Object
   ↳ java.io.InputStream
     ↳ java.io.FilterInputStream
       ↳ java.security.DigestInputStream


A transparent stream that updates the associated message digest using the bits going through the stream.

To complete the message digest computation, call one of the digest methods on the associated message digest after your calls to one of this digest input stream's read methods.

It is possible to turn this stream on or off (see on). When it is on, a call to one of the read methods results in an update on the message digest. But when it is off, the message digest is not updated. The default is for the stream to be on.

Note that digest objects can compute only one digest (see MessageDigest), so that in order to compute intermediate digests, a caller should retain a handle onto the digest object, and clone it for each digest to be computed, leaving the orginal digest untouched.

Summary

Fields

protected MessageDigest digest

The message digest associated with this stream.

Inherited fields

Public constructors

DigestInputStream(InputStream stream, MessageDigest digest)

Creates a digest input stream, using the specified input stream and message digest.

Public methods

MessageDigest getMessageDigest()

Returns the message digest associated with this stream.

void on(boolean on)

Turns the digest function on or off.

int read()

Reads a byte, and updates the message digest (if the digest function is on).

int read(byte[] b, int off, int len)

Reads into a byte array, and updates the message digest (if the digest function is on).

void setMessageDigest(MessageDigest digest)

Associates the specified message digest with this stream.

String toString()

Prints a string representation of this digest input stream and its associated message digest object.

Inherited methods

Fields

digest

added in API level 1
protected MessageDigest digest

The message digest associated with this stream.

Public constructors

DigestInputStream

added in API level 1
public DigestInputStream (InputStream stream, 
                MessageDigest digest)

Creates a digest input stream, using the specified input stream and message digest.

Parameters
stream InputStream: the input stream.

digest MessageDigest: the message digest to associate with this stream.

Public methods

getMessageDigest

added in API level 1
public MessageDigest getMessageDigest ()

Returns the message digest associated with this stream.

Returns
MessageDigest the message digest associated with this stream.

on

added in API level 1
public void on (boolean on)

Turns the digest function on or off. The default is on. When it is on, a call to one of the read methods results in an update on the message digest. But when it is off, the message digest is not updated.

Parameters
on boolean: true to turn the digest function on, false to turn it off.

read

added in API level 1
public int read ()

Reads a byte, and updates the message digest (if the digest function is on). That is, this method reads a byte from the input stream, blocking until the byte is actually read. If the digest function is on (see on), this method will then call update on the message digest associated with this stream, passing it the byte read.

Returns
int the byte read.

Throws
IOException if an I/O error occurs.

read

added in API level 1
public int read (byte[] b, 
                int off, 
                int len)

Reads into a byte array, and updates the message digest (if the digest function is on). That is, this method reads up to len bytes from the input stream into the array b, starting at offset off. This method blocks until the data is actually read. If the digest function is on (see on), this method will then call update on the message digest associated with this stream, passing it the data.

Parameters
b byte: the array into which the data is read.

off int: the starting offset into b of where the data should be placed.

len int: the maximum number of bytes to be read from the input stream into b, starting at offset off.

Returns
int the actual number of bytes read. This is less than len if the end of the stream is reached prior to reading len bytes. -1 is returned if no bytes were read because the end of the stream had already been reached when the call was made.

Throws
IOException if an I/O error occurs.

setMessageDigest

added in API level 1
public void setMessageDigest (MessageDigest digest)

Associates the specified message digest with this stream.

Parameters
digest MessageDigest: the message digest to be associated with this stream.

See also:

toString

added in API level 1
public String toString ()

Prints a string representation of this digest input stream and its associated message digest object.

Returns
String a string representation of the object.