Class LengthAwareInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

software.amazon.awssdk.utils.io.LengthAwareInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

ChunkInputStream

@SdkProtectedApi
public class LengthAwareInputStream
extends FilterInputStream

An InputStream that is aware of its length. This class enforces that we sent exactly the number of bytes equal to the input length. If the wrapped stream has more bytes than the expected length, it will be truncated to length. If the stream has less bytes (i.e. reaches EOF) before the expected length is reached, it will throw IOException.

Constructor Summary

Constructors

Constructor	Description
LengthAwareInputStream(InputStream in, long length)

Method Summary

Modifier and Type	Method	Description
final int	available()
final void	mark(int readlimit)
final int	read()
final int	read(byte[] b, int off, int len)
final long	remaining()
final void	reset()
final long	skip(long requestedBytesToSkip)

Methods inherited from class java.io.FilterInputStream

close, markSupported, read

Methods inherited from class java.lang.Object

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

Constructor Details

LengthAwareInputStream

public LengthAwareInputStream(InputStream in,
 long length)

Method Details

read

public final int read()
               throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

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

Overrides:

read in class FilterInputStream

Throws:

IOException

skip

public final long skip(long requestedBytesToSkip)
                throws IOException

Overrides:

skip in class FilterInputStream

Throws:

IOException

available

public final int available()
                    throws IOException

Overrides:

available in class FilterInputStream

Throws:

IOException

mark

public final void mark(int readlimit)

Overrides:

mark in class FilterInputStream

reset

public final void reset()
                 throws IOException

Overrides:

reset in class FilterInputStream

Throws:

IOException

remaining

public final long remaining()