public class DigestOutputStream extends FilterOutputStream
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.
MessageDigest,
DigestInputStream| Modifier and Type | Field and Description |
|---|---|
protected MessageDigest |
digest
The message digest associated with this stream.
|
out| Constructor and Description |
|---|
DigestOutputStream(OutputStream stream,
MessageDigest digest)
Creates a digest output stream, using the specified output stream
and message digest.
|
| Modifier and Type | Method and Description |
|---|---|
MessageDigest |
getMessageDigest()
Returns the message digest associated with this stream.
|
void |
on(boolean on)
Turns the digest function on or off.
|
void |
setMessageDigest(MessageDigest digest)
Associates the specified message digest with this stream.
|
String |
toString()
Prints a string representation of this digest output stream and
its associated message digest object.
|
void |
write(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.
|
void |
write(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.
|
close, flush, writeprotected MessageDigest digest
public DigestOutputStream(OutputStream stream, MessageDigest digest)
stream - the output stream.digest - the message digest to associate with this stream.public MessageDigest getMessageDigest()
setMessageDigest(java.security.MessageDigest)public void setMessageDigest(MessageDigest digest)
digest - the message digest to be associated with this stream.getMessageDigest()public void write(int b)
throws IOException
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.write in class FilterOutputStreamb - the byte to be used for updating and writing to the
output stream.IOException - if an I/O error occurs.MessageDigest.update(byte)public void write(byte[] b,
int off,
int len)
throws IOException
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.write in class FilterOutputStreamb - the array containing the subarray to be used for updating
and writing to the output stream.off - the offset into b of 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.IOException - if an I/O error occurs.MessageDigest.update(byte[], int, int)public void on(boolean on)
write methods results in an
update on the message digest. But when it is off, the message
digest is not updated.on - true to turn the digest function on, false to turn it
off. Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2023, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.