Package org.eclipse.jgit.internal.storage.pack

Class PackOutputStream

java.lang.Object

java.io.OutputStream

org.eclipse.jgit.internal.storage.pack.PackOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public final class PackOutputStream
extends java.io.OutputStream

Custom output stream to support PackWriter.

Field Summary

Fields

Modifier and Type	Field	Description
private static int	BYTES_TO_WRITE_BEFORE_CANCEL_CHECK
private long	checkCancelAt
private byte[]	copyBuffer
private long	count
private byte[]	headerBuffer
private java.security.MessageDigest	md
private boolean	ofsDelta
private java.io.OutputStream	out
private PackWriter	packWriter
private ProgressMonitor	writeMonitor

Constructor Summary

Constructors

Constructor	Description
PackOutputStream(ProgressMonitor writeMonitor, java.io.OutputStream out, PackWriter pw)	Initialize a pack output stream.

Method Summary

Modifier and Type	Method	Description
(package private) void	endObject()
void	flush()
byte[]	getCopyBuffer()	Get a temporary buffer writers can use to copy data with.
(package private) byte[]	getDigest()
long	length()	Get total number of bytes written since stream start.
private static int	objectHeader(long len, int type, byte[] buf)
private static int	ofsDelta(long diff, byte[] buf, int p)
private static int	ofsDeltaVarIntLength(long v)
void	write(byte[] b, int off, int len)
void	write(int b)
(package private) void	writeFileHeader(int version, long objectCount)
void	writeHeader(ObjectToPack otp, long rawLength)	Commits the object header onto the stream.
void	writeObject(ObjectToPack otp)	Write one object.

Methods inherited from class java.io.OutputStream

close, write

Methods inherited from class java.lang.Object

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

Field Detail

BYTES_TO_WRITE_BEFORE_CANCEL_CHECK

private static final int BYTES_TO_WRITE_BEFORE_CANCEL_CHECK

See Also:

Constant Field Values

writeMonitor

private final ProgressMonitor writeMonitor

out

private final java.io.OutputStream out

packWriter

private final PackWriter packWriter

md

private final java.security.MessageDigest md

count

private long count

headerBuffer

private final byte[] headerBuffer

copyBuffer

private final byte[] copyBuffer

checkCancelAt

private long checkCancelAt

ofsDelta

private boolean ofsDelta

Constructor Detail

PackOutputStream

public PackOutputStream(ProgressMonitor writeMonitor,
                        java.io.OutputStream out,
                        PackWriter pw)

Initialize a pack output stream.

This constructor is exposed to support debugging the JGit library only. Application or storage level code should not create a PackOutputStream, instead use PackWriter, and let the writer create the stream.

Parameters:

writeMonitor - monitor to update on object output progress.

out - target stream to receive all object contents.

pw - packer that is going to perform the output.

Method Detail

write

public final void write(int b)
                 throws java.io.IOException

Specified by:

write in class java.io.OutputStream

Throws:

java.io.IOException

write

public final void write(byte[] b,
                        int off,
                        int len)
                 throws java.io.IOException

Overrides:

write in class java.io.OutputStream

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Overrides:

flush in class java.io.OutputStream

Throws:

java.io.IOException

writeFileHeader

final void writeFileHeader(int version,
                           long objectCount)
                    throws java.io.IOException

Throws:

java.io.IOException

writeObject

public final void writeObject(ObjectToPack otp)
                       throws java.io.IOException

Write one object. If the object was already written, this method does nothing and returns quickly. This case occurs whenever an object was written out of order in order to ensure the delta base occurred before the object that needs it.

Parameters:

otp - the object to write.

Throws:

java.io.IOException - the object cannot be read from the object reader, or the output stream is no longer accepting output. Caller must examine the type of exception and possibly its message to distinguish between these cases.

writeHeader

public final void writeHeader(ObjectToPack otp,
                              long rawLength)
                       throws java.io.IOException

Commits the object header onto the stream.

Once the header has been written, the object representation must be fully output, or packing must abort abnormally.

Parameters:

otp - the object to pack. Header information is obtained.

rawLength - number of bytes of the inflated content. For an object that is in whole object format, this is the same as the object size. For an object that is in a delta format, this is the size of the inflated delta instruction stream.

Throws:

java.io.IOException - the underlying stream refused to accept the header.

objectHeader

private static final int objectHeader(long len,
                                      int type,
                                      byte[] buf)

ofsDelta

private static final int ofsDelta(long diff,
                                  byte[] buf,
                                  int p)

ofsDeltaVarIntLength

private static final int ofsDeltaVarIntLength(long v)

getCopyBuffer

public final byte[] getCopyBuffer()

Get a temporary buffer writers can use to copy data with.

Returns:

a temporary buffer writers can use to copy data with.

endObject

void endObject()

length

public final long length()

Get total number of bytes written since stream start.

Returns:

total number of bytes written since stream start.

getDigest

final byte[] getDigest()

Returns:

obtain the current SHA-1 digest.