Modifier and Type	Class and Description
pack-priv static class	TemporaryBuffer.Block
private class	TemporaryBuffer.BlockInputStream
public static class	TemporaryBuffer.Heap A temporary buffer that will never exceed its in-memory limit.
public static class	TemporaryBuffer.LocalFile A fully buffered output stream using local disk storage for large data.

Modifier and Type	Field and Description
pack-priv ArrayList<TemporaryBuffer.Block>	blocks Chain of data, if we are still completely in-core; otherwise null.
protected static final int	DEFAULT_IN_CORE_LIMIT Default limit for in-core storage.
private int	inCoreLimit Maximum number of bytes we will permit storing in memory.
private int	initialBlocks Initial size of block list.
private OutputStream	overflow If `inCoreLimit` has been reached, remainder goes here.

Access	Constructor and Description
protected	TemporaryBuffer(int maximum number of bytes to store in memory before entering the overflow output path; also used as the estimated size. limit) Create a new empty temporary buffer.
protected	TemporaryBuffer(int estimated size of storage used, to size the initial list of block pointers. estimatedSize, int maximum number of bytes to store in memory before entering the overflow output path. limit) Create a new empty temporary buffer.

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Closes this output stream and releases any system resources associated with this stream.
public void	copy(InputStream the stream to read from, until EOF is reached. in) Copy all bytes remaining on the input stream into this buffer.
public void	destroy() Clear this buffer so it has no data, and cannot be used again.
protected void	doFlush() Dumps the entire buffer into the overflow stream, and flushes it.
private long	inCoreLength()
private TemporaryBuffer.Block	last()
public long	Returns: total length of the buffer, in bytes. length() Obtain the length (in bytes) of the buffer.
public InputStream	Returns: a stream to read from the buffer. The caller must close the stream when it is no longer useful. openInputStream() Open an input stream to read from the buffered data.
public InputStream	Returns: an InputStream which will automatically destroy any associated temporary file on `close()` openInputStreamWithAutoDestroy() Same as `openInputStream()` but handling destruction of any associated resources automatically when closing the returned stream.
protected abstract OutputStream	Returns: the output stream to receive the buffered content, followed by the remaining output. overflow() Open the overflow output stream, so the remaining output can be stored.
private boolean	reachedInCoreLimit()
public void	reset() Reset this buffer for reuse, purging all buffered content.
private void	switchToOverflow()
public byte[]	Returns: the complete byte array; length matches `length()`. toByteArray() Convert this buffer's contents into a contiguous byte array.
public byte[]	Returns: the byte array limited to `limit` bytes. toByteArray(int the maximum number of bytes to be returned limit) Convert this buffer's contents into a contiguous byte array.
public String	Returns: first `limit` number of bytes of the buffer content converted to String. toString(int the maximum number of bytes to be converted to String limit) Convert first `limit` number of bytes of the buffer content to String.
public void	write(int the `byte`. b) Implements abstract java.io.OutputStream.write. Writes the specified byte to this output stream.
public void	write(byte[] the data. b, int the start offset in the data. off, int the number of bytes to write. len) Overrides java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.
public void	writeTo(OutputStream stream to send this buffer's complete content to. os, ProgressMonitor if not null progress updates are sent here. Caller should initialize the task and the number of work units to `length()/1024`. pm) Send this buffer to an output stream.

Inherited from java.io.OutputStream:: flush nullOutputStream write

blocks	back to summary
pack-priv ArrayList<TemporaryBuffer.Block> blocks Chain of data, if we are still completely in-core; otherwise null.

DEFAULT_IN_CORE_LIMIT	back to summary
protected static final int DEFAULT_IN_CORE_LIMIT Default limit for in-core storage.

inCoreLimit	back to summary
private int inCoreLimit Maximum number of bytes we will permit storing in memory. When this limit is reached the data will be shifted to a file on disk, preventing the JVM heap from growing out of control.

initialBlocks	back to summary
private int initialBlocks Initial size of block list.

overflow	back to summary
private OutputStream overflow If `inCoreLimit` has been reached, remainder goes here.

TemporaryBuffer	back to summary
protected TemporaryBuffer(int limit) Create a new empty temporary buffer. Parameters limit:int maximum number of bytes to store in memory before entering the overflow output path; also used as the estimated size.

TemporaryBuffer	back to summary
protected TemporaryBuffer(int estimatedSize, int limit) Create a new empty temporary buffer. Parameters estimatedSize:int estimated size of storage used, to size the initial list of block pointers. limit:int maximum number of bytes to store in memory before entering the overflow output path. Since 4.0

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Doc from java.io.OutputStream.close. Closes this output stream and releases any system resources associated with this stream. The general contract of `close` is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

copy	back to summary
public void copy(InputStream in) throws IOException Copy all bytes remaining on the input stream into this buffer. Parameters in:InputStream the stream to read from, until EOF is reached. Exceptions IOException: an error occurred reading from the input stream, or while writing to a local temporary file.

copy

back to summary

public void copy(InputStream in) throws IOException

Copy all bytes remaining on the input stream into this buffer.

Parameters

in:InputStream: the stream to read from, until EOF is reached.

Exceptions

IOException:: an error occurred reading from the input stream, or while writing to a local temporary file.

destroy	back to summary
public void destroy() Clear this buffer so it has no data, and cannot be used again.

doFlush	back to summary
protected void doFlush() throws IOException Dumps the entire buffer into the overflow stream, and flushes it. Exceptions IOException: the overflow stream cannot be started, or the buffer contents cannot be written to it, or it failed to flush.

doFlush

back to summary

protected void doFlush() throws IOException

Dumps the entire buffer into the overflow stream, and flushes it.

Exceptions

IOException:: the overflow stream cannot be started, or the buffer contents cannot be written to it, or it failed to flush.

inCoreLength	back to summary
private long inCoreLength()

last	back to summary
private TemporaryBuffer.Block last()

length back to summary

length	back to summary
public long length() Obtain the length (in bytes) of the buffer. The length is only accurate after `close()` has been invoked. Returns:long total length of the buffer, in bytes.

public long length()

Obtain the length (in bytes) of the buffer.

The length is only accurate after close() has been invoked.

Returns:long: total length of the buffer, in bytes.

openInputStream back to summary

openInputStream	back to summary
public InputStream openInputStream() throws IOException Open an input stream to read from the buffered data. This method may only be invoked after `close()` has completed normally, to ensure all data is completely transferred. Returns:InputStream a stream to read from the buffer. The caller must close the stream when it is no longer useful. Exceptions IOException: an error occurred opening the temporary file.

public InputStream openInputStream() throws IOException

Open an input stream to read from the buffered data.

This method may only be invoked after close() has completed normally, to ensure all data is completely transferred.

Returns:InputStream

a stream to read from the buffer. The caller must close the stream when it is no longer useful.

Exceptions

IOException:: an error occurred opening the temporary file.

openInputStreamWithAutoDestroy back to summary

openInputStreamWithAutoDestroy	back to summary
public InputStream openInputStreamWithAutoDestroy() throws IOException Same as `openInputStream()` but handling destruction of any associated resources automatically when closing the returned stream. Returns:InputStream an InputStream which will automatically destroy any associated temporary file on `close()` Exceptions IOException: in case of an error. Since 4.11

public InputStream openInputStreamWithAutoDestroy() throws IOException

Same as openInputStream() but handling destruction of any associated resources automatically when closing the returned stream.

Returns:InputStream

an InputStream which will automatically destroy any associated temporary file on close()

Exceptions

IOException:: in case of an error.

Since

4.11

overflow	back to summary
protected abstract OutputStream overflow() throws IOException Open the overflow output stream, so the remaining output can be stored. Returns:OutputStream the output stream to receive the buffered content, followed by the remaining output. Exceptions IOException: the buffer cannot create the overflow stream.

overflow

back to summary

protected abstract OutputStream overflow() throws IOException

Open the overflow output stream, so the remaining output can be stored.

Returns:OutputStream

the output stream to receive the buffered content, followed by the remaining output.

Exceptions

IOException:: the buffer cannot create the overflow stream.

reachedInCoreLimit	back to summary
private boolean reachedInCoreLimit() throws IOException

reset	back to summary
public void reset() Reset this buffer for reuse, purging all buffered content.

switchToOverflow	back to summary
private void switchToOverflow() throws IOException

toByteArray back to summary

toByteArray	back to summary
public byte[] toByteArray() throws IOException Convert this buffer's contents into a contiguous byte array. The buffer is only complete after `close()` has been invoked. Returns:byte[] the complete byte array; length matches `length()`. Exceptions IOException: an error occurred reading from a local temporary file

public byte[] toByteArray() throws IOException

Convert this buffer's contents into a contiguous byte array.

The buffer is only complete after close() has been invoked.

Returns:byte[]

the complete byte array; length matches length().

Exceptions

IOException:: an error occurred reading from a local temporary file

toByteArray back to summary

toByteArray	back to summary
public byte[] toByteArray(int limit) throws IOException Convert this buffer's contents into a contiguous byte array. If this size of the buffer exceeds the limit only return the first `limit` bytes The buffer is only complete after `close()` has been invoked. Parameters limit:int the maximum number of bytes to be returned Returns:byte[] the byte array limited to `limit` bytes. Exceptions IOException: an error occurred reading from a local temporary file Since 4.2

public byte[] toByteArray(int limit) throws IOException

Convert this buffer's contents into a contiguous byte array. If this size of the buffer exceeds the limit only return the first limit bytes

The buffer is only complete after close() has been invoked.

Parameters

limit:int: the maximum number of bytes to be returned

Returns:byte[]

the byte array limited to limit bytes.

Exceptions

IOException:: an error occurred reading from a local temporary file

Since

4.2

toString back to summary

toString	back to summary
public String toString(int limit) Convert first `limit` number of bytes of the buffer content to String. Parameters limit:int the maximum number of bytes to be converted to String Returns:String first `limit` number of bytes of the buffer content converted to String. Since 5.12

public String toString(int limit)

Convert first limit number of bytes of the buffer content to String.

Parameters

limit:int: the maximum number of bytes to be converted to String

Returns:String

first limit number of bytes of the buffer content converted to String.

Since

5.12

write back to summary

write	back to summary
public void write(int b) throws IOException Implements abstract java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes the specified byte to this output stream. The general contract for `write` is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument `b`. The 24 high-order bits of `b` are ignored. Parameters b:int the `byte`. Annotations @Override Exceptions IOException: if an I/O error occurs. In particular, an `IOException` may be thrown if the output stream has been closed.

public void write(int b) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters

b:int: the byte.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

write back to summary

write	back to summary
public void write(byte[] b, int off, int len) throws IOException Overrides java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream. The general contract for `write(b, off, len)` is that some of the bytes in the array `b` are written to the output stream in order; element `b[off]` is the first byte written and `b[off+len-1]` is the last byte written by this operation. If `b` is `null`, a `NullPointerException` is thrown. If `off` is negative, or `len` is negative, or `off+len` is greater than the length of the array `b`, then an `IndexOutOfBoundsException` is thrown. Parameters b:byte[] the data. off:int the start offset in the data. len:int the number of bytes to write. Annotations @Override Exceptions IOException: if an I/O error occurs. In particular, an `IOException` is thrown if the output stream is closed.

public void write(byte[] b, int off, int len) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters

b:byte[]: the data.
off:int: the start offset in the data.
len:int: the number of bytes to write.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.

writeTo back to summary

writeTo	back to summary
public void writeTo(OutputStream os, ProgressMonitor pm) throws IOException Send this buffer to an output stream. This method may only be invoked after `close()` has completed normally, to ensure all data is completely transferred. Parameters os:OutputStream stream to send this buffer's complete content to. pm:ProgressMonitor if not null progress updates are sent here. Caller should initialize the task and the number of work units to `length()/1024`. Exceptions IOException: an error occurred reading from a temporary file on the local system, or writing to the output stream.

public void writeTo(OutputStream os, ProgressMonitor pm) throws IOException

Send this buffer to an output stream.

This method may only be invoked after close() has completed normally, to ensure all data is completely transferred.

Parameters

os:OutputStream: stream to send this buffer's complete content to.
pm:ProgressMonitor: if not null progress updates are sent here. Caller should initialize the task and the number of work units to length()/1024.

Exceptions

IOException:: an error occurred reading from a temporary file on the local system, or writing to the output stream.

org.eclipse.jgit.util back to summary

pack-priv Class TemporaryBuffer.Block

Class Inheritance

extends Object

java.lang.Object
org.eclipse.jgit.util.TemporaryBuffer.Block

Field Summary

Modifier and Type	Field and Description
pack-priv final byte[]	buffer
pack-priv int	count
pack-priv static final int	SZ

Constructor Summary

Access	Constructor and Description
pack-priv	Block()
pack-priv	Block(int sz)

Method Summary

Modifier and Type	Method and Description
pack-priv boolean	isFull()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

buffer	back to summary
pack-priv final byte[] buffer

count	back to summary
pack-priv int count

SZ	back to summary
pack-priv static final int SZ

Constructor Detail

Block	back to summary
pack-priv Block()

Block	back to summary
pack-priv Block(int sz)

Method Detail

isFull	back to summary
pack-priv boolean isFull()

org.eclipse.jgit.util back to summary

private Class TemporaryBuffer.BlockInputStream

Class Inheritance

extends InputStream

java.lang.Object
java.io.InputStream
org.eclipse.jgit.util.TemporaryBuffer.BlockInputStream

Field Summary

Modifier and Type	Field and Description
private TemporaryBuffer.Block	block
private int	blockIndex
private int	blockPos
private byte[]	singleByteBuffer

Constructor Summary

Access	Constructor and Description
pack-priv	BlockInputStream()

Method Summary

Modifier and Type	Method and Description
private boolean	nextBlock()
public int	read() Implements abstract java.io.InputStream.read. Reads the next byte of data from the input stream.
public int	read(byte[] the buffer into which the data is read. b, int the start offset in array `b` at which the data is written. off, int the maximum number of bytes to read. len) Overrides java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes.
public long	skip(long the number of bytes to be skipped. cnt) Overrides java.io.InputStream.skip. Skips over and discards `n` bytes of data from this input stream.

Inherited from java.io.InputStream:: available close mark markSupported nullInputStream read readAllBytes readNBytes readNBytes reset skipNBytes transferTo

Field Detail

block	back to summary
private TemporaryBuffer.Block block

blockIndex	back to summary
private int blockIndex

blockPos	back to summary
private int blockPos

singleByteBuffer	back to summary
private byte[] singleByteBuffer

Constructor Detail

BlockInputStream	back to summary
pack-priv BlockInputStream()

Method Detail

nextBlock	back to summary
private boolean nextBlock()

read back to summary

read	back to summary
public int read() throws IOException Implements abstract java.io.InputStream.read. Doc from java.io.InputStream.read. Reads the next byte of data from the input stream. The value byte is returned as an `int` in the range `0` to `255`. If no byte is available because the end of the stream has been reached, the value `-1` is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. Returns:int the next byte of data, or `-1` if the end of the stream is reached. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int read() throws IOException

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Returns:int

the next byte of data, or -1 if the end of the stream is reached.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(byte[] b, int off, int len) throws IOException Overrides java.io.InputStream.read. Doc from java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes. An attempt is made to read as many as `len` bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown. If `len` is zero, then no bytes are read and `0` is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value `-1` is returned; otherwise, at least one byte is read and stored into `b`. The first byte read is stored into element `b[off]`, the next one into `b[off+1]`, and so on. The number of bytes read is, at most, equal to `len`. Let k be the number of bytes actually read; these bytes will be stored in elements `b[off]` through `b[off+`k`-1]`, leaving elements `b[off+`k`]` through `b[off+len-1]` unaffected. In every case, elements `b[0]` through `b[off-1]` and elements `b[off+len]` through `b[b.length-1]` are unaffected. Parameters b:byte[] the buffer into which the data is read. off:int the start offset in array `b` at which the data is written. len:int the maximum number of bytes to read. Returns:int the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the stream has been reached. Annotations @Override Exceptions IOException: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

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

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.

In every case, elements b[0] through b[off-1] and elements b[off+len] through b[b.length-1] are unaffected.

Parameters

b:byte[]: the buffer into which the data is read.
off:int: the start offset in array b at which the data is written.
len:int: the maximum number of bytes to read.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Annotations

@Override

Exceptions

IOException:: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

skip back to summary

public long skip(long cnt) throws IOException

Overrides java.io.InputStream.skip.

Doc from java.io.InputStream.skip.

Skips over and discards n bytes of data from this input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. This may result from any of a number of conditions; reaching end of file before n bytes have been skipped is only one possibility. The actual number of bytes skipped is returned. If n is negative, the skip method for class InputStream always returns 0, and no bytes are skipped. Subclasses may handle the negative value differently.

Parameters

cnt:long: the number of bytes to be skipped.

Returns:long

the actual number of bytes skipped which might be zero.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

org.eclipse.jgit.util back to summary

public Class TemporaryBuffer.Heap

Class Inheritance

extends TemporaryBuffer

java.lang.Object
java.io.OutputStream
org.eclipse.jgit.util.TemporaryBuffer
org.eclipse.jgit.util.TemporaryBuffer.Heap

A temporary buffer that will never exceed its in-memory limit.

If the in-memory limit is reached an IOException is thrown, rather than attempting to spool to local disk.

Field Summary

Inherited from org.eclipse.jgit.util.TemporaryBuffer:: blocks DEFAULT_IN_CORE_LIMIT

Constructor Summary

Access	Constructor and Description
public	Heap(int maximum number of bytes that can be stored in this buffer; also used as the estimated size. Storing beyond this many will cause an IOException to be thrown during write. limit) Create a new heap buffer with a maximum storage limit.
public	Heap(int estimated size of storage used, to size the initial list of block pointers. estimatedSize, int maximum number of bytes that can be stored in this buffer. Storing beyond this many will cause an IOException to be thrown during write. limit) Create a new heap buffer with a maximum storage limit.

Method Summary

Modifier and Type	Method and Description
protected OutputStream	overflow() Implements abstract org.eclipse.jgit.util.TemporaryBuffer.overflow. Open the overflow output stream, so the remaining output can be stored.

Inherited from org.eclipse.jgit.util.TemporaryBuffer:: close copy destroy doFlush length openInputStream openInputStreamWithAutoDestroy reset toByteArray toByteArray toString write write writeTo

Constructor Detail

Heap

back to summary

public Heap(int limit)

Create a new heap buffer with a maximum storage limit.

Parameters

limit:int: maximum number of bytes that can be stored in this buffer; also used as the estimated size. Storing beyond this many will cause an IOException to be thrown during write.

Heap

back to summary

public Heap(int estimatedSize, int limit)

Create a new heap buffer with a maximum storage limit.

Parameters

estimatedSize:int: estimated size of storage used, to size the initial list of block pointers.
limit:int: maximum number of bytes that can be stored in this buffer. Storing beyond this many will cause an IOException to be thrown during write.

Since

4.0

Method Detail

overflow

back to summary

protected OutputStream overflow() throws IOException

Implements abstract org.eclipse.jgit.util.TemporaryBuffer.overflow.

Doc from org.eclipse.jgit.util.TemporaryBuffer.overflow.

Open the overflow output stream, so the remaining output can be stored.

Returns:OutputStream

the output stream to receive the buffered content, followed by the remaining output.

Annotations

@Override

Exceptions

IOException:: the buffer cannot create the overflow stream.

org.eclipse.jgit.util back to summary

public Class TemporaryBuffer.LocalFile

Class Inheritance

extends TemporaryBuffer

java.lang.Object
java.io.OutputStream
org.eclipse.jgit.util.TemporaryBuffer
org.eclipse.jgit.util.TemporaryBuffer.LocalFile

A fully buffered output stream using local disk storage for large data.

Initially this output stream buffers to memory and is therefore similar to ByteArrayOutputStream, but it shifts to using an on disk temporary file if the output gets too large.

The content of this buffered stream may be sent to another OutputStream only after this stream has been properly closed by close().

Field Summary

Modifier and Type	Field and Description
private final File	directory Directory to store the temporary file under.
private File	onDiskFile Location of our temporary file if we are on disk; otherwise null.

Inherited from org.eclipse.jgit.util.TemporaryBuffer:: blocks DEFAULT_IN_CORE_LIMIT

Constructor Summary

Access	Constructor and Description
public	LocalFile(File if the buffer has to spill over into a temporary file, the directory where the file should be saved. If null the system default temporary directory (for example /tmp) will be used instead. directory) Create a new temporary buffer, limiting memory usage.
public	LocalFile(File if the buffer has to spill over into a temporary file, the directory where the file should be saved. If null the system default temporary directory (for example /tmp) will be used instead. directory, int maximum number of bytes to store in memory. Storage beyond this limit will use the local file. inCoreLimit) Create a new temporary buffer, limiting memory usage.

Method Summary

Modifier and Type	Method and Description
public void	destroy() Overrides org.eclipse.jgit.util.TemporaryBuffer.destroy. Clear this buffer so it has no data, and cannot be used again.
public long	length() Overrides org.eclipse.jgit.util.TemporaryBuffer.length. Obtain the length (in bytes) of the buffer.
public InputStream	openInputStream() Overrides org.eclipse.jgit.util.TemporaryBuffer.openInputStream. Open an input stream to read from the buffered data.
public InputStream	openInputStreamWithAutoDestroy() Overrides org.eclipse.jgit.util.TemporaryBuffer.openInputStreamWithAutoDestroy. Same as `openInputStream()` but handling destruction of any associated resources automatically when closing the returned stream.
protected OutputStream	overflow() Implements abstract org.eclipse.jgit.util.TemporaryBuffer.overflow. Open the overflow output stream, so the remaining output can be stored.
public byte[]	toByteArray() Overrides org.eclipse.jgit.util.TemporaryBuffer.toByteArray. Convert this buffer's contents into a contiguous byte array.
public byte[]	toByteArray(int the maximum number of bytes to be returned limit) Overrides org.eclipse.jgit.util.TemporaryBuffer.toByteArray. Convert this buffer's contents into a contiguous byte array.
public void	writeTo(OutputStream stream to send this buffer's complete content to. os, ProgressMonitor if not null progress updates are sent here. Caller should initialize the task and the number of work units to `length()/1024`. pm) Overrides org.eclipse.jgit.util.TemporaryBuffer.writeTo. Send this buffer to an output stream.

Inherited from org.eclipse.jgit.util.TemporaryBuffer:: close copy doFlush reset toString write write

Field Detail

directory	back to summary
private final File directory Directory to store the temporary file under.

onDiskFile back to summary

private File onDiskFile

Location of our temporary file if we are on disk; otherwise null.

If we exceeded the inCoreLimit we nulled out blocks and created this file instead. All output goes here through overflow.

Constructor Detail

LocalFile

back to summary

public LocalFile(File directory)

Create a new temporary buffer, limiting memory usage.

Parameters

directory:File: if the buffer has to spill over into a temporary file, the directory where the file should be saved. If null the system default temporary directory (for example /tmp) will be used instead.

LocalFile

back to summary

public LocalFile(File directory, int inCoreLimit)

Create a new temporary buffer, limiting memory usage.

Parameters

directory:File: if the buffer has to spill over into a temporary file, the directory where the file should be saved. If null the system default temporary directory (for example /tmp) will be used instead.
inCoreLimit:int: maximum number of bytes to store in memory. Storage beyond this limit will use the local file.

Method Detail

destroy

back to summary

public void destroy()

Overrides org.eclipse.jgit.util.TemporaryBuffer.destroy.

Doc from org.eclipse.jgit.util.TemporaryBuffer.destroy.

Clear this buffer so it has no data, and cannot be used again.

Annotations

@Override

length back to summary

public long length()

Overrides org.eclipse.jgit.util.TemporaryBuffer.length.

Doc from org.eclipse.jgit.util.TemporaryBuffer.length.

Obtain the length (in bytes) of the buffer.

The length is only accurate after close() has been invoked.

Returns:long

total length of the buffer, in bytes.

Annotations

@Override

openInputStream back to summary

public InputStream openInputStream() throws IOException

Overrides org.eclipse.jgit.util.TemporaryBuffer.openInputStream.

Doc from org.eclipse.jgit.util.TemporaryBuffer.openInputStream.

Open an input stream to read from the buffered data.

This method may only be invoked after close() has completed normally, to ensure all data is completely transferred.

Returns:InputStream

a stream to read from the buffer. The caller must close the stream when it is no longer useful.

Annotations

@Override

Exceptions

IOException:: an error occurred opening the temporary file.

openInputStreamWithAutoDestroy back to summary

public InputStream openInputStreamWithAutoDestroy() throws IOException

Overrides org.eclipse.jgit.util.TemporaryBuffer.openInputStreamWithAutoDestroy.

Doc from org.eclipse.jgit.util.TemporaryBuffer.openInputStreamWithAutoDestroy.

Same as openInputStream() but handling destruction of any associated resources automatically when closing the returned stream.

Returns:InputStream

an InputStream which will automatically destroy any associated temporary file on close()

Annotations

@Override

Exceptions

IOException:: in case of an error.

overflow

back to summary

protected OutputStream overflow() throws IOException

Implements abstract org.eclipse.jgit.util.TemporaryBuffer.overflow.

Doc from org.eclipse.jgit.util.TemporaryBuffer.overflow.

Open the overflow output stream, so the remaining output can be stored.

Returns:OutputStream

the output stream to receive the buffered content, followed by the remaining output.

Annotations

@Override

Exceptions

IOException:: the buffer cannot create the overflow stream.

toByteArray back to summary

public byte[] toByteArray() throws IOException

Overrides org.eclipse.jgit.util.TemporaryBuffer.toByteArray.

Doc from org.eclipse.jgit.util.TemporaryBuffer.toByteArray.

Convert this buffer's contents into a contiguous byte array.

The buffer is only complete after close() has been invoked.

Returns:byte[]

the complete byte array; length matches length().

Annotations

@Override

Exceptions

IOException:: an error occurred reading from a local temporary file

toByteArray back to summary

public byte[] toByteArray(int limit) throws IOException

Overrides org.eclipse.jgit.util.TemporaryBuffer.toByteArray.

Doc from org.eclipse.jgit.util.TemporaryBuffer.toByteArray.

Convert this buffer's contents into a contiguous byte array. If this size of the buffer exceeds the limit only return the first limit bytes

The buffer is only complete after close() has been invoked.

Parameters

limit:int: the maximum number of bytes to be returned

Returns:byte[]

the byte array limited to limit bytes.

Annotations

@Override

Exceptions

IOException:: an error occurred reading from a local temporary file

writeTo back to summary

public void writeTo(OutputStream os, ProgressMonitor pm) throws IOException

Overrides org.eclipse.jgit.util.TemporaryBuffer.writeTo.

Doc from org.eclipse.jgit.util.TemporaryBuffer.writeTo.

Send this buffer to an output stream.

This method may only be invoked after close() has completed normally, to ensure all data is completely transferred.

Parameters

os:OutputStream: stream to send this buffer's complete content to.
pm:ProgressMonitor: if not null progress updates are sent here. Caller should initialize the task and the number of work units to length()/1024.

Annotations

@Override

Exceptions

IOException:: an error occurred reading from a temporary file on the local system, or writing to the output stream.

public abstract Class TemporaryBuffer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class TemporaryBuffer.Block

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class TemporaryBuffer.BlockInputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class TemporaryBuffer.Heap

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public Class TemporaryBuffer.LocalFile

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail