public class

DigestInputStream

extends FilterInputStream

java.lang.Object
↳	java.io.InputStream
	↳	java.io.FilterInputStream
		↳	java.security.DigestInputStream

Summary

Fields
protected MessageDigest	digest

[Expand]

Inherited Fields

From class java.io.FilterInputStream

Public Constructors
	DigestInputStream(InputStream stream, MessageDigest digest)

Public Methods
MessageDigest	getMessageDigest() Returns the MessageDigest which the receiver uses when computing the hash.
void	on(boolean on) Enables or disables the digest function (default is on).
int	read(byte[] b, int off, int len) Reads at most `count` bytes from this FilterInputStream and stores them in byte array `buffer` starting at `offset`.
int	read() Reads the next byte and returns it as an int.
void	setMessageDigest(MessageDigest digest) Sets the MessageDigest which the receiver will use when computing the hash.
String	toString() Returns a string containing a concise, human-readable description of the receiver.

[Expand]

Inherited Methods

From class java.io.FilterInputStream

int	available() Returns a int representing the number of bytes that are available before this FilterInputStream will block.
void	close() Close this FilterInputStream.
synchronized void	mark(int readlimit) Set a Mark position in this FilterInputStream.
boolean	markSupported() Returns a boolean indicating whether or not this FilterInputStream supports mark() and reset().
int	read(byte[] buffer, int offset, int count) Reads at most `count` bytes from this FilterInputStream and stores them in byte array `buffer` starting at `offset`.
int	read(byte[] buffer) Reads bytes from this FilterInputStream and stores them in byte array `buffer`.
int	read() Reads a single byte from this FilterInputStream and returns the result as an int.
synchronized void	reset() Reset this FilterInputStream to the last marked location.
long	skip(long count) Skips `count` number of bytes in this InputStream.

From class java.io.InputStream

int	available() Returns a int representing then number of bytes that are available before this InputStream will block.
void	close() Close the InputStream.
void	mark(int readlimit) Set a Mark position in this InputStream.
boolean	markSupported() Returns a boolean indicating whether or not this InputStream supports mark() and reset().
int	read(byte[] b, int offset, int length) Reads at most `length` bytes from the Stream and stores them in byte array `b` starting at `offset`.
int	read(byte[] b) Reads bytes from the Stream and stores them in byte array `b`.
abstract int	read() Reads a single byte from this InputStream and returns the result as an int.
synchronized void	reset() Reset this InputStream to the last marked location.
long	skip(long n) Skips `n` number of bytes in this InputStream.

From class java.lang.Object

Object	clone() Returns a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o) Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.
void	finalize() Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final Class<? extends Object>	getClass() Returns the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode() Returns an integer hash code for the receiver.
final void	notify() Causes one thread which is `wait` ing on the receiver to be made ready to run.
final void	notifyAll() Causes all threads which are `wait` ing on the receiver to be made ready to run.
String	toString() Returns a string containing a concise, human-readable description of the receiver.
final void	wait(long time, int frac) Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final void	wait(long time) Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final void	wait() Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

From interface java.io.Closeable

Fields

protected MessageDigest digest

Public Constructors

public DigestInputStream (InputStream stream, MessageDigest digest)

Public Methods

public MessageDigest getMessageDigest ()

Returns the MessageDigest which the receiver uses when computing the hash.

Returns

MessageDigest the digest the receiver uses when computing the hash.

public void on (boolean on)

Enables or disables the digest function (default is on).

Parameters

on	boolean true if the digest should be computed, and false otherwise.

public int read (byte[] b, int off, int len)

Reads at most count bytes from this FilterInputStream and stores them in byte array buffer starting at offset. Answer the number of bytes actually read or -1 if no bytes were read and end of stream was encountered. This implementation reads bytes from the target stream.

Parameters

b	the byte array in which to store the read bytes.
off	the offset in `buffer` to store the read bytes.
len	the maximum number of bytes to store in `buffer`.

Returns

the number of bytes actually read or -1 if end of stream.

Throws

IOException

public int read ()

Reads the next byte and returns it as an int. Updates the digest for the byte if this function is enabled.

Returns

int the byte which was read or -1 at end of stream.

Throws

IOException	If reading the source stream causes an IOException.

public void setMessageDigest (MessageDigest digest)

Sets the MessageDigest which the receiver will use when computing the hash.

Parameters

digest	MessageDigest the digest to use when computing the hash.

public String toString ()

Returns a string containing a concise, human-readable description of the receiver.

Returns

String a printable representation for the receiver.

Mar	APR	May
	05
2008	2009	2010

Interfaces

Classes

Enums

Exceptions

DigestInputStream

Summary

Fields

protected MessageDigest digest

Public Constructors

public DigestInputStream (InputStream stream, MessageDigest digest)

Public Methods

public MessageDigest getMessageDigest ()

Returns

public void on (boolean on)

Parameters

See Also

public int read (byte[] b, int off, int len)

Parameters

Returns

Throws

public int read ()

Returns

Throws

public void setMessageDigest (MessageDigest digest)

Parameters

See Also

public String toString ()

Returns