Package com.google.common.hash
Class HashingOutputStream
- java.lang.Object
-
- java.io.OutputStream
-
- java.io.FilterOutputStream
-
- com.google.common.hash.HashingOutputStream
-
- All Implemented Interfaces:
java.io.Closeable
,java.io.Flushable
,java.lang.AutoCloseable
@Beta public final class HashingOutputStream extends java.io.FilterOutputStream
AnOutputStream
that maintains a hash of the data written to it.- Since:
- 16.0
- Author:
- Nick Piepmeier
-
-
Constructor Summary
Constructors Constructor Description HashingOutputStream(HashFunction hashFunction, java.io.OutputStream out)
Creates an output stream that hashes using the givenHashFunction
, and forwards all data written to it to the underlyingOutputStream
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
HashCode
hash()
Returns theHashCode
based on the data written to this stream.void
write(byte[] bytes, int off, int len)
void
write(int b)
-
-
-
Constructor Detail
-
HashingOutputStream
public HashingOutputStream(HashFunction hashFunction, java.io.OutputStream out)
Creates an output stream that hashes using the givenHashFunction
, and forwards all data written to it to the underlyingOutputStream
.The
OutputStream
should not be written to before or after the hand-off.
-
-
Method Detail
-
write
public void write(int b) throws java.io.IOException
- Overrides:
write
in classjava.io.FilterOutputStream
- Throws:
java.io.IOException
-
write
public void write(byte[] bytes, int off, int len) throws java.io.IOException
- Overrides:
write
in classjava.io.FilterOutputStream
- Throws:
java.io.IOException
-
hash
public HashCode hash()
Returns theHashCode
based on the data written to this stream. The result is unspecified if this method is called more than once on the same instance.
-
close
public void close() throws java.io.IOException
- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Overrides:
close
in classjava.io.FilterOutputStream
- Throws:
java.io.IOException
-
-