Package org.apache.commons.compress.utils

Class SkipShieldingInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.apache.commons.compress.utils.SkipShieldingInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class SkipShieldingInputStream
extends FilterInputStream

A wrapper that overwrites skip(long) and delegates to FilterInputStream.read() instead.

Some implementations of InputStream implement InputStream.skip(long) in a way that throws an exception if the stream is not seekable - System.in is known to behave that way. For such a stream it is impossible to invoke skip at all and you have to read from the stream (and discard the data read) instead. Skipping is potentially much faster than reading so we do want to invoke skip when possible. We provide this class so you can wrap your own InputStream in it if you encounter problems with skip throwing an exception.

Since:

1.17

Constructor Summary

Constructors

Constructor	Description
SkipShieldingInputStream(InputStream in)

Method Summary

Modifier and Type	Method	Description
long	skip(long n)

Methods inherited from class java.io.FilterInputStream

available, close, mark, markSupported, read, read, read, reset

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Detail

SkipShieldingInputStream

public SkipShieldingInputStream(InputStream in)

Method Detail

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class FilterInputStream

Throws:

IOException