MessageDigestOutputStream

package saker.build.file.content

public static class HashContentDescriptor.MessageDigestOutputStream extends OutputStream implements ByteSink

saker.build.file.content.HashContentDescriptor.MessageDigestOutputStream

java.io.OutputStream

java.lang.Object

java.io.Closeable

java.lang.AutoCloseable

java.io.Flushable

saker.build.thirdparty.saker.util.io.ByteSink

OutputStream which forwards any bytes written to it to an underlying MessageDigest.

The class also counts the number of bytes written to the stream.

The hash result can be retrieved (only once) from one of the digest methods.

Closing the stream will not affect the underlying MessageDigest.

digestWithCount()

digest()

Fields

protected long	count The number of bytes written to the stream.
protected MessageDigest	digest The underlying MessageDigest for the hashing.

Constructors

public	MessageDigestOutputStream() Creates a new instance that uses the default hash algorithm for the HashContentDescriptor class.
public	MessageDigestOutputStream(MessageDigest digest) Creates a new instance that uses the argument MessageDigest for hashing.

Methods

public void	close() Closes this output stream and releases any system resources associated with this stream.
public byte[]	digest() Creates the hash bytes by digesting the underlying MessageDigest.
public byte[]	digestWithCount() Creates the hash bytes by digesting the underlying MessageDigest, and appending the binary representation of the number of bytes written to this stream.
public void	write(int b) Writes the specified byte to this output stream.
public void	write(ByteArrayRegion buf) Writes the bytes contained in the argument byte array to the byte sink.
public void	write(byte[] b) Writes `b.length` bytes from the specified byte array to this output stream.
public void	write(byte[] b, int off, int len) Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.

Inherited methods
From: OutputStream flush
From: ByteSink readFrom
From: Object clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

protected long count

The number of bytes written to the stream.

protected MessageDigest digest

The underlying MessageDigest for the hashing.

public MessageDigestOutputStream()

Creates a new instance that uses the default hash algorithm for the HashContentDescriptor class.

public MessageDigestOutputStream(MessageDigest digest) throws NullPointerException

Creates a new instance that uses the argument MessageDigest for hashing.

Any bytes written to this output stream will update the given message digest.

digestThe message digest.

NullPointerExceptionIf the argument is null.

public void close() throws IOException

Overridden from: OutputStream

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

The close method of OutputStream does nothing.

IOExceptionif an I/O error occurs.

public byte[] digest()

Creates the hash bytes by digesting the underlying MessageDigest.

This, and other digesting methods can be called only once.

The digested hash.

MessageDigest.digest()

public byte[] digestWithCount()

Creates the hash bytes by digesting the underlying MessageDigest, and appending the binary representation of the number of bytes written to this stream.

This, and other digesting methods can be called only once.

The digested hash.

MessageDigest.digest()

public void write(int b) throws IOException

Overridden from: OutputStream

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Subclasses of OutputStream must provide an implementation for this method.

bthe byte.

IOExceptionif an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

public void write(ByteArrayRegion buf) throws IOException

Overridden from: ByteSink

Writes the bytes contained in the argument byte array to the byte sink.

This method works similarly to OutputStream.write(byte[], int, int).

bufThe bytes to write.

IOExceptionIn case of I/O error.

public void write(byte[] b) throws IOException

Overridden from: OutputStream

Writes b.length bytes from the specified byte array to this output stream. The general contract for write(b) is that it should have exactly the same effect as the call write(b, 0, b.length).

bthe data.

IOExceptionif an I/O error occurs.

OutputStream.write(byte[], int, int)

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

Overridden from: OutputStream

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

The write method of OutputStream calls the write method of one argument on each of the bytes to be written out. Subclasses are encouraged to override this method and provide a more efficient implementation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

bthe data.

offthe start offset in the data.

lenthe number of bytes to write.

IOExceptionif an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.