Package org.eclipse.jgit.util
Class TemporaryBuffer
java.lang.Object
java.io.OutputStream
org.eclipse.jgit.util.TemporaryBuffer
- All Implemented Interfaces:
Closeable,Flushable,AutoCloseable
- Direct Known Subclasses:
SmartOutputStream,TemporaryBuffer.Heap,TemporaryBuffer.LocalFile,TransportHttp.Service.HttpOutputStream
A fully buffered output stream.
Subclasses determine the behavior when the in-memory buffer capacity has been exceeded and additional bytes are still being received for output.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static classprivate classstatic classA temporary buffer that will never exceed its in-memory limit.static classA fully buffered output stream using local disk storage for large data. -
Field Summary
FieldsModifier and TypeFieldDescription(package private) ArrayList<TemporaryBuffer.Block>Chain of data, if we are still completely in-core; otherwise null.protected static final intDefault limit for in-core storage.private intMaximum number of bytes we will permit storing in memory.private intInitial size of block list.private OutputStreamIfinCoreLimithas been reached, remainder goes here. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedTemporaryBuffer(int limit) Create a new empty temporary buffer.protectedTemporaryBuffer(int estimatedSize, int limit) Create a new empty temporary buffer. -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()voidcopy(InputStream in) Copy all bytes remaining on the input stream into this buffer.voiddestroy()Clear this buffer so it has no data, and cannot be used again.protected voiddoFlush()Dumps the entire buffer into the overflow stream, and flushes it.private longprivate TemporaryBuffer.Blocklast()longlength()Obtain the length (in bytes) of the buffer.Open an input stream to read from the buffered data.Same asopenInputStream()but handling destruction of any associated resources automatically when closing the returned stream.protected abstract OutputStreamoverflow()Open the overflow output stream, so the remaining output can be stored.private booleanvoidreset()Reset this buffer for reuse, purging all buffered content.private voidbyte[]Convert this buffer's contents into a contiguous byte array.byte[]toByteArray(int limit) Convert this buffer's contents into a contiguous byte array.toString(int limit) Convert firstlimitnumber of bytes of the buffer content to String.voidwrite(byte[] b, int off, int len) voidwrite(int b) voidwriteTo(OutputStream os, ProgressMonitor pm) Send this buffer to an output stream.Methods inherited from class java.io.OutputStream
flush, nullOutputStream, write
-
Field Details
-
DEFAULT_IN_CORE_LIMIT
protected static final int DEFAULT_IN_CORE_LIMITDefault limit for in-core storage.- See Also:
-
blocks
ArrayList<TemporaryBuffer.Block> blocksChain of data, if we are still completely in-core; otherwise null. -
inCoreLimit
private int inCoreLimitMaximum 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
private int initialBlocksInitial size of block list. -
overflow
IfinCoreLimithas been reached, remainder goes here.
-
-
Constructor Details
-
TemporaryBuffer
protected TemporaryBuffer(int limit) Create a new empty temporary buffer.- Parameters:
limit- maximum number of bytes to store in memory before entering the overflow output path; also used as the estimated size.
-
TemporaryBuffer
protected TemporaryBuffer(int estimatedSize, int limit) Create a new empty temporary buffer.- Parameters:
estimatedSize- estimated size of storage used, to size the initial list of block pointers.limit- maximum number of bytes to store in memory before entering the overflow output path.- Since:
- 4.0
-
-
Method Details
-
write
- Specified by:
writein classOutputStream- Throws:
IOException
-
write
- Overrides:
writein classOutputStream- Throws:
IOException
-
doFlush
Dumps the entire buffer into the overflow stream, and flushes it.- Throws:
IOException- the overflow stream cannot be started, or the buffer contents cannot be written to it, or it failed to flush.
-
copy
Copy all bytes remaining on the input stream into this buffer.- Parameters:
in- the stream to read from, until EOF is reached.- Throws:
IOException- an error occurred reading from the input stream, or while writing to a local temporary file.
-
length
public long length()Obtain the length (in bytes) of the buffer.The length is only accurate after
close()has been invoked.- Returns:
- total length of the buffer, in bytes.
-
inCoreLength
private long inCoreLength() -
toByteArray
Convert this buffer's contents into a contiguous byte array.The buffer is only complete after
close()has been invoked.- Returns:
- the complete byte array; length matches
length(). - Throws:
IOException- an error occurred reading from a local temporary file
-
toString
Convert firstlimitnumber of bytes of the buffer content to String.- Parameters:
limit- the maximum number of bytes to be converted to String- Returns:
- first
limitnumber of bytes of the buffer content converted to String. - Since:
- 5.12
-
toByteArray
Convert this buffer's contents into a contiguous byte array. If this size of the buffer exceeds the limit only return the firstlimitbytesThe buffer is only complete after
close()has been invoked.- Parameters:
limit- the maximum number of bytes to be returned- Returns:
- the byte array limited to
limitbytes. - Throws:
IOException- an error occurred reading from a local temporary file- Since:
- 4.2
-
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- stream to send this buffer's complete content to.pm- if not null progress updates are sent here. Caller should initialize the task and the number of work units to.length()/1024- Throws:
IOException- an error occurred reading from a temporary file on the local system, or writing to the output stream.
-
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:
- a stream to read from the buffer. The caller must close the stream when it is no longer useful.
- Throws:
IOException- an error occurred opening the temporary file.
-
openInputStreamWithAutoDestroy
Same asopenInputStream()but handling destruction of any associated resources automatically when closing the returned stream.- Returns:
- an InputStream which will automatically destroy any associated
temporary file on
close() - Throws:
IOException- in case of an error.- Since:
- 4.11
-
reset
public void reset()Reset this buffer for reuse, purging all buffered content. -
overflow
Open the overflow output stream, so the remaining output can be stored.- Returns:
- the output stream to receive the buffered content, followed by the remaining output.
- Throws:
IOException- the buffer cannot create the overflow stream.
-
last
-
reachedInCoreLimit
- Throws:
IOException
-
switchToOverflow
- Throws:
IOException
-
close
- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classOutputStream- Throws:
IOException
-
destroy
public void destroy()Clear this buffer so it has no data, and cannot be used again.
-