Class DigestOutputStream
java.lang.Object
java.io.OutputStream
java.io.FilterOutputStream
java.security.DigestOutputStream
- All Implemented Interfaces:
- Closeable,- Flushable,- AutoCloseable
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 output stream's
 write methods.
 
It is possible to turn this stream on or off (see
 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.
- Since:
- 1.2
- See Also:
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected MessageDigestThe message digest associated with this stream.Fields declared in class java.io.FilterOutputStreamout
- 
Constructor SummaryConstructorsConstructorDescriptionDigestOutputStream(OutputStream stream, MessageDigest digest) Creates a digest output stream, using the specified output stream and message digest.
- 
Method SummaryModifier and TypeMethodDescriptionReturns the message digest associated with this stream.voidon(boolean on) Turns the digest function on or off.voidsetMessageDigest(MessageDigest digest) Associates the specified message digest with this stream.toString()Prints a string representation of this digest output stream and its associated message digest object.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.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.Methods declared in class java.io.FilterOutputStreamclose, flush, writeMethods declared in class java.io.OutputStreamnullOutputStream
- 
Field Details- 
digestThe message digest associated with this stream.
 
- 
- 
Constructor Details- 
DigestOutputStreamCreates a digest output stream, using the specified output stream and message digest.- Parameters:
- stream- the output stream.
- digest- the message digest to associate with this stream.
 
 
- 
- 
Method Details- 
getMessageDigestReturns the message digest associated with this stream.- Returns:
- the message digest associated with this stream.
- See Also:
 
- 
setMessageDigestAssociates the specified message digest with this stream.- Parameters:
- digest- the message digest to be associated with this stream.
- See Also:
 
- 
writeUpdates 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 (seeon), this method callsupdateon the message digest associated with this stream, passing it the byteb. This method then writes the byte to the output stream, blocking until the byte is actually written.- Overrides:
- writein class- FilterOutputStream
- Parameters:
- b- the byte to be used for updating and writing to the output stream.
- Throws:
- IOException- if an I/O error occurs.
- See Also:
 
- 
writeUpdates 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 (seeon), this method callsupdateon 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.- Overrides:
- writein class- FilterOutputStream
- Parameters:
- b- the array containing the subarray to be used for updating and writing to the output stream.
- off- the offset into- bof the first byte to be updated and written.
- len- the number of bytes of data to be updated and written from- b, starting at offset- off.
- Throws:
- IOException- if an I/O error occurs.
- See Also:
 
- 
onpublic void on(boolean on) Turns the digest function on or off. The default is on. When it is on, a call to one of thewritemethods results in an update on the message digest. But when it is off, the message digest is not updated.- Parameters:
- on-- trueto turn the digest function on,- falseto turn it off.
 
- 
toString
 
-