Class CheckedInputStream

All Implemented Interfaces:
Closeable, AutoCloseable 

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:
Checksum

Fields

Fields inherited from class java.io.FilterInputStream

in

Constructors

Constructor and Description
CheckedInputStream(InputStream in, Checksum cksum)

Creates an input stream using the specified Checksum.

Methods

Modifier and Type Method and Description
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.

Methods inherited from class java.io.FilterInputStream

available, close, mark, markSupported, read, reset

Methods inherited from class java.lang.Object

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

Constructors

CheckedInputStream

public CheckedInputStream(InputStream in,
                          Checksum cksum)

Creates an input stream using the specified Checksum.

Parameters:
in - the input stream
cksum - the Checksum

Methods

read

public int read()
         throws IOException

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

Overrides:
read in class FilterInputStream
Returns:
the byte read, or -1 if the end of the stream is reached.
Throws:
IOException - if an I/O error has occurred
See Also:
FilterInputStream.in

read

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

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.

Overrides:
read in class FilterInputStream
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
See Also:
FilterInputStream.in

skip

public long skip(long n)
          throws IOException

Skips specified number of bytes of input.

Overrides:
skip in class FilterInputStream
Parameters:
n - the number of bytes to skip
Returns:
the actual number of bytes skipped
Throws:
IOException - if an I/O error has occurred

getChecksum

public Checksum getChecksum()

Returns the Checksum for this input stream.

Returns:
the Checksum value

© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/javase/8/docs/api/java/util/zip/CheckedInputStream.html