LZ4CompressingInputStream (atlasdb-commons 0.1096.0 API)

java.lang.Object
- java.io.InputStream
- - com.palantir.common.compression.BufferedDelegateInputStream
  - - com.palantir.common.compression.LZ4CompressingInputStream

All Implemented Interfaces:

Closeable, AutoCloseable
```
public final class LZ4CompressingInputStream
extends BufferedDelegateInputStream
```
InputStream that wraps a delegate InputStream, compressing its contents as they are read. Compression is managed via a compressing OutputStream. Reads pull data as necessary from the delegate InputStream, write the uncompressed data through the OutputStream, then serve the read from the resulting compressed buffer.

- Field Summary
  - Fields inherited from class com.palantir.common.compression.BufferedDelegateInputStream
    buffer, BUFFER_START, delegate, READ_FAILED
- Constructor Summary
  
  Constructors
  Constructor Description
  
  LZ4CompressingInputStream(InputStream delegate)
  
  LZ4CompressingInputStream(InputStream delegate, int blockSize)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  void close()
  
  protected int refill()
  Refills the internal buffer from the delegate InputStream.
  - Methods inherited from class com.palantir.common.compression.BufferedDelegateInputStream
    available, read, read
  - Methods inherited from class java.io.InputStream
    mark, markSupported, nullInputStream, read, readAllBytes, readNBytes, readNBytes, reset, skip, transferTo
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LZ4CompressingInputStream
```
public LZ4CompressingInputStream(InputStream delegate)
```
  - LZ4CompressingInputStream
```
public LZ4CompressingInputStream(InputStream delegate,
                                 int blockSize)
```
- Method Detail
  - refill
```
protected int refill()
              throws IOException
```
    Description copied from class: BufferedDelegateInputStream
    
    Refills the internal buffer from the delegate InputStream.
    
    Specified by:
    
    refill in class BufferedDelegateInputStream
    
    Returns:
    
    The number of bytes written to the buffer while refilling it.
    
    Throws:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable
    
    Overrides:
    
    close in class BufferedDelegateInputStream
    
    Throws:
    
    IOException