FileDocCategorySizeDatePackage
DigestOutputStream.javaAPI DocJava SE 5 API4913Fri Aug 26 14:57:14 BST 2005java.security

DigestOutputStream

public class DigestOutputStream extends FilterOutputStream
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 ouput stream's {@link #write(int) write} methods.

It is possible to turn this stream on or off (see {@link #on(boolean) on}). When it is on, a call to one of the write 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.

see
MessageDigest
see
DigestInputStream
version
1.31 03/12/19
author
Benjamin Renaud

Fields Summary
private boolean
on
protected MessageDigest
digest
The message digest associated with this stream.
Constructors Summary
public DigestOutputStream(OutputStream stream, MessageDigest digest)
Creates a digest output stream, using the specified output stream and message digest.

param
stream the output stream.
param
digest the message digest to associate with this stream.


                                     
         
	super(stream);
	setMessageDigest(digest);
    
Methods Summary
public java.security.MessageDigestgetMessageDigest()
Returns the message digest associated with this stream.

return
the message digest associated with this stream.
see
#setMessageDigest(java.security.MessageDigest)

	return digest;
    
public voidon(boolean on)
Turns the digest function on or off. The default is on. When it is on, a call to one of the write methods results in an update on the message digest. But when it is off, the message digest is not updated.

param
on true to turn the digest function on, false to turn it off.

	this.on = on;
    
public voidsetMessageDigest(java.security.MessageDigest digest)
Associates the specified message digest with this stream.

param
digest the message digest to be associated with this stream.
see
#getMessageDigest()

	this.digest = digest;
    
public java.lang.StringtoString()
Prints a string representation of this digest output stream and its associated message digest object.

	 return "[Digest Output Stream] " + digest.toString();
     
public voidwrite(int b)
Updates the message digest (if the digest function is on) using the specified byte, and in any case writes the byte to the output stream. That is, if the digest function is on (see {@link #on(boolean) on}), this method calls update on the message digest associated with this stream, passing it the byte b. This method then writes the byte to the output stream, blocking until the byte is actually written.

param
b the byte to be used for updating and writing to the output stream.
exception
IOException if an I/O error occurs.
see
MessageDigest#update(byte)

	if (on) {
	    digest.update((byte)b);
	}
	out.write(b);
    
public voidwrite(byte[] b, int off, int len)
Updates the message digest (if the digest function is on) using the specified subarray, and in any case writes the subarray to the output stream. That is, if the digest function is on (see {@link #on(boolean) on}), this method calls update on the message digest associated with this stream, passing it the subarray specifications. This method then writes the subarray bytes to the output stream, blocking until the bytes are actually written.

param
b the array containing the subarray to be used for updating and writing to the output stream.
param
off the offset into b of the first byte to be updated and written.
param
len the number of bytes of data to be updated and written from b, starting at offset off.
exception
IOException if an I/O error occurs.
see
MessageDigest#update(byte[], int, int)

	if (on) {
	    digest.update(b, off, len);
	}
	out.write(b, off, len);