org.apache.commons.io.input

Class ChecksumInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.apache.commons.io.input.ProxyInputStream

org.apache.commons.io.input.CountingInputStream

org.apache.commons.io.input.ChecksumInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public final class ChecksumInputStream
extends CountingInputStream

Automatically verifies a Checksum value once the stream is exhausted or the count threshold is reached.

If the Checksum does not meet the expected value when exhausted, then the input stream throws an IOException.

If you do not need the verification or threshold feature, then use a plain CheckedInputStream.

To build an instance, use ChecksumInputStream.Builder.

Since:

2.16.0

See Also:

ChecksumInputStream.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChecksumInputStream.Builder Builds a new ChecksumInputStream.

Method Summary

Modifier and Type	Method and Description
static ChecksumInputStream.Builder	builder() Constructs a new ChecksumInputStream.Builder.
long	getRemaining() Gets the byte count remaining to read.

Methods inherited from class org.apache.commons.io.input.CountingInputStream

getByteCount, getCount, resetByteCount, resetCount, skip

Methods inherited from class org.apache.commons.io.input.ProxyInputStream

available, close, mark, markSupported, read, read, read, reset, setReference, unwrap

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static ChecksumInputStream.Builder builder()

Constructs a new ChecksumInputStream.Builder.

Returns:

a new ChecksumInputStream.Builder.

getRemaining

public long getRemaining()

Gets the byte count remaining to read.

Returns:

bytes remaining to read, a negative number means the threshold is unbound.