CheckedInputStream

public class CheckedInputStream extends FilterInputStream

An input stream that also maintains a checksum of the data being read. The checksum can then be used to verify the integrity of the input data.

See Also

Inherited Field Summary

Public Constructor Summary

CheckedInputStream(InputStream in, Checksum cksum)
Creates an input stream using the specified Checksum.

Public Method Summary

Checksum
getChecksum()
Returns the Checksum for this input stream.
int
read()
Reads a byte.
int
read(byte[] buf, int off, int len)
Reads into an array of bytes.
long
skip(long n)
Skips specified number of bytes of input.

Inherited Method Summary

Public Constructors

public CheckedInputStream (InputStream in, Checksum cksum)

Creates an input stream using the specified Checksum.

Parameters
in the input stream
cksum the Checksum

Public Methods

public Checksum getChecksum ()

Returns the Checksum for this input stream.

Returns
  • the Checksum value

public int read ()

Reads a byte. Will block if no input is available.

Returns
  • the byte read, or -1 if the end of the stream is reached.
Throws
IOException if an I/O error has occurred

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

Reads into an array of bytes. If len is not zero, the method blocks until some input is available; otherwise, no bytes are read and 0 is returned.

Parameters
buf the buffer into which the data is read
off the start offset in the destination array b
len the maximum number of bytes read
Returns
  • the actual number of bytes read, or -1 if the end of the stream is reached.
Throws
NullPointerException If buf is null.
IndexOutOfBoundsException If off is negative, len is negative, or len is greater than buf.length - off
IOException if an I/O error has occurred

public long skip (long n)

Skips specified number of bytes of input.

Parameters
n the number of bytes to skip
Returns
  • the actual number of bytes skipped
Throws
IOException if an I/O error has occurred