org.eclipse.jgit.storage.pack

Class DeltaStream

java.lang.Object

java.io.InputStream

org.eclipse.jgit.storage.pack.DeltaStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public abstract class DeltaStream
extends java.io.InputStream

Inflates a delta in an incremental way.

Implementations must provide a means to access a stream for the base object. This stream may be accessed multiple times, in order to randomly position it to match the copy instructions. A DeltaStream performs an efficient skip by only moving through the delta stream, making restarts of stacked deltas reasonably efficient.

Constructor Summary

Constructors

Constructor and Description
DeltaStream(java.io.InputStream deltaStream) Construct a delta application stream, reading instructions.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
protected abstract long	getBaseSize()
long	getSize()
protected abstract java.io.InputStream	openBase() Open the base stream.
int	read()
int	read(byte[] buf, int off, int len)
long	skip(long len)

Methods inherited from class java.io.InputStream

available, mark, markSupported, read, reset

Methods inherited from class java.lang.Object

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

Constructor Detail

DeltaStream

public DeltaStream(java.io.InputStream deltaStream)
            throws java.io.IOException

Construct a delta application stream, reading instructions.

Parameters:

deltaStream - the stream to read delta instructions from.

Throws:

java.io.IOException - the delta instruction stream cannot be read, or is inconsistent with the the base object information.

Method Detail

openBase

protected abstract java.io.InputStream openBase()
                                         throws java.io.IOException

Open the base stream.

The DeltaStream may close and reopen the base stream multiple times if copy instructions use offsets out of order. This can occur if a large block in the file was moved from near the top, to near the bottom. In such cases the reopened stream is skipped to the target offset, so skip(long) should be as efficient as possible.

Returns:

stream to read from the base object. This stream should not be buffered (or should be only minimally buffered), and does not need to support mark/reset.

Throws:

java.io.IOException - the base object cannot be opened for reading.

getBaseSize

protected abstract long getBaseSize()
                             throws java.io.IOException

Returns:

length of the base object, in bytes.

Throws:

java.io.IOException - the length of the base cannot be determined.

getSize

public long getSize()

Returns:

total size of this stream, in bytes.

read

public int read()
         throws java.io.IOException

Specified by:

read in class java.io.InputStream

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

Throws:

java.io.IOException

skip

public long skip(long len)
          throws java.io.IOException

Overrides:

skip in class java.io.InputStream

Throws:

java.io.IOException

read

public int read(byte[] buf,
       int off,
       int len)
         throws java.io.IOException

Overrides:

read in class java.io.InputStream

Throws:

java.io.IOException