Class ChecksumCalculatingInputStream
- java.lang.Object
-
- java.io.InputStream
-
- org.apache.commons.compress.utils.ChecksumCalculatingInputStream
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
public class ChecksumCalculatingInputStream extends InputStream
A stream that calculates the checksum of the data read.- Since:
- 1.14
-
-
Constructor Summary
Constructors Constructor Description ChecksumCalculatingInputStream(Checksum checksum, InputStream inputStream)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description long
getValue()
Returns the calculated checksum.int
read()
Reads a single byte from the streamint
read(byte[] b)
Reads a byte array from the streamint
read(byte[] b, int off, int len)
Reads from the stream into a byte array.long
skip(long n)
-
Methods inherited from class java.io.InputStream
available, close, mark, markSupported, nullInputStream, readAllBytes, readNBytes, readNBytes, reset, transferTo
-
-
-
-
Constructor Detail
-
ChecksumCalculatingInputStream
public ChecksumCalculatingInputStream(Checksum checksum, InputStream inputStream)
-
-
Method Detail
-
read
public int read() throws IOException
Reads a single byte from the stream- Specified by:
read
in classInputStream
- Throws:
IOException
- if the underlying stream throws or the stream is exhausted and the Checksum doesn't match the expected value
-
read
public int read(byte[] b) throws IOException
Reads a byte array from the stream- Overrides:
read
in classInputStream
- Throws:
IOException
- if the underlying stream throws or the stream is exhausted and the Checksum doesn't match the expected value
-
read
public int read(byte[] b, int off, int len) throws IOException
Reads from the stream into a byte array.- Overrides:
read
in classInputStream
- Throws:
IOException
- if the underlying stream throws or the stream is exhausted and the Checksum doesn't match the expected value
-
skip
public long skip(long n) throws IOException
- Overrides:
skip
in classInputStream
- Throws:
IOException
-
getValue
public long getValue()
Returns the calculated checksum.- Returns:
- the calculated checksum.
-
-