okio

Class HashingSource

java.lang.Object

okio.ForwardingSource

okio.HashingSource

All Implemented Interfaces:

Closeable, AutoCloseable, Source

public final class HashingSource
extends ForwardingSource

A source that computes a hash of the full stream of bytes it has supplied. To use, create an instance with your preferred hash algorithm. Exhaust the source by reading all of its bytes and then call hash() to compute the final hash value.

In this example we use HashingSource with a BufferedSource to make reading from the source easier.

   

   HashingSource hashingSource = HashingSource.sha256(rawSource);
   BufferedSource bufferedSource = Okio.buffer(hashingSource);

   ... // Read all of bufferedSource.

   ByteString hash = hashingSource.hash();
 

Method Summary

Modifier and Type	Method and Description
ByteString	hash() Returns the hash of the bytes supplied thus far and resets the internal state of this source.
static HashingSource	md5(Source source) Returns a sink that uses the obsolete MD5 hash algorithm.
long	read(Buffer sink, long byteCount) Removes at least 1, and up to byteCount bytes from this and appends them to sink.
static HashingSource	sha1(Source source) Returns a sink that uses the obsolete SHA-1 hash algorithm.
static HashingSource	sha256(Source source) Returns a sink that uses the SHA-256 hash algorithm.

Methods inherited from class okio.ForwardingSource

close, delegate, timeout, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

md5

public static HashingSource md5(Source source)

Returns a sink that uses the obsolete MD5 hash algorithm.

sha1

public static HashingSource sha1(Source source)

Returns a sink that uses the obsolete SHA-1 hash algorithm.

sha256

public static HashingSource sha256(Source source)

Returns a sink that uses the SHA-256 hash algorithm.

read

public long read(Buffer sink,
                 long byteCount)
          throws IOException

Description copied from interface: Source

Removes at least 1, and up to byteCount bytes from this and appends them to sink. Returns the number of bytes read, or -1 if this source is exhausted.

Specified by:

read in interface Source

Overrides:

read in class ForwardingSource

Throws:

IOException

hash

public ByteString hash()

Returns the hash of the bytes supplied thus far and resets the internal state of this source.

Warning: This method is not idempotent. Each time this method is called its internal state is cleared. This starts a new hash with zero bytes supplied.