Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)

Added in API level 1

public class

DigestOutputStream

extends FilterOutputStream

java.lang.Object
↳	java.io.OutputStream
	↳	java.io.FilterOutputStream
		↳	java.security.DigestOutputStream

Class Overview

DigestOutputStream is a FilterOutputStream which maintains an associated message digest.

Summary

Fields
protected MessageDigest	digest	The message digest for this stream.

[Expand]

Inherited Fields

From class java.io.FilterOutputStream

Public Constructors
	DigestOutputStream ( OutputStream stream, MessageDigest digest) Constructs a new instance of this `DigestOutputStream` , using the given `stream` and the `digest` .

Public Methods
MessageDigest	getMessageDigest () Returns the message digest for this stream.
void	on (boolean on) Enables or disables the digest function (default is on).
void	setMessageDigest ( MessageDigest digest) Sets the message digest which this stream will use.
String	toString () Returns a string containing a concise, human-readable description of this `DigestOutputStream` including the digest.
void	write (byte[] b, int off, int len) Writes `len` bytes into the stream, starting from the specified offset.
void	write (int b) Writes the specified `int` to the stream.

[Expand]

Inherited Methods

From class java.io.FilterOutputStream

From class java.io.OutputStream

void	close () Closes this stream.
void	flush () Flushes this stream.
void	write (byte[] buffer, int offset, int count) Writes `count` bytes from the byte array `buffer` starting at position `offset` to this stream.
void	write (byte[] buffer) Equivalent to `write(buffer, 0, buffer.length)` .
abstract void	write (int oneByte) Writes a single byte to this stream.

From class java.lang.Object

Object	clone () Creates and returns a copy of this `Object` .
boolean	equals ( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize () Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class <?>	getClass () Returns the unique instance of `Class` that represents this object's class.
int	hashCode () Returns an integer hash code for this object.
final void	notify () Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll () Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString () Returns a string containing a concise, human-readable description of this object.
final void	wait () Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait (long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait (long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface java.io.Closeable

From interface java.io.Flushable

From interface java.lang.AutoCloseable

Fields

protected MessageDigest digest

Added in API level 1

The message digest for this stream.

Public Constructors

public DigestOutputStream ( OutputStream stream, MessageDigest digest)

Added in API level 1

Constructs a new instance of this DigestOutputStream , using the given stream and the digest .

Parameters

stream	the output stream.
digest	the message digest.

Public Methods

public MessageDigest getMessageDigest ()

Added in API level 1

Returns the message digest for this stream.

Returns

the message digest for this stream.

public void on (boolean on)

Added in API level 1

Enables or disables the digest function (default is on).

Parameters

on	`true` if the digest should be computed, `false` otherwise.

public void setMessageDigest ( MessageDigest digest)

Added in API level 1

Sets the message digest which this stream will use.

Parameters

digest	the message digest which this stream will use.

public String toString ()

Added in API level 1

Returns a string containing a concise, human-readable description of this DigestOutputStream including the digest.

Returns

a printable representation for this DigestOutputStream .

public void write (byte[] b, int off, int len)

Added in API level 1

Writes len bytes into the stream, starting from the specified offset. Updates the digest if this function is on(boolean) .

Parameters

b	the buffer to write to.
off	the index of the first byte in `b` to write.
len	the number of bytes in `b` to write.

Throws

IOException	if writing to the stream causes an `IOException` .

public void write (int b)

Added in API level 1

Writes the specified int to the stream. Updates the digest if this function is on(boolean) .

Parameters

b	the byte to be written.

Throws

IOException	if writing to the stream causes a `IOException`

Results

Interfaces

Classes

Enums

Exceptions

DigestOutputStream

Class Overview

Summary

Fields

protected MessageDigest digest

Public Constructors

public DigestOutputStream ( OutputStream stream, MessageDigest digest)

Parameters

Public Methods

public MessageDigest getMessageDigest ()

Returns

public void on (boolean on)

Parameters

See Also

public void setMessageDigest ( MessageDigest digest)

Parameters

public String toString ()

Returns

public void write (byte[] b, int off, int len)

Parameters

Throws

public void write (int b)

Parameters

Throws