diff options
| -rw-r--r-- | org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectInserter.java | 32 |
1 files changed, 28 insertions, 4 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectInserter.java b/org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectInserter.java index 0355e56f5f..69b1e237e4 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectInserter.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectInserter.java @@ -102,11 +102,35 @@ public abstract class ObjectInserter { digest = Constants.newMessageDigest(); } - /** @return a temporary byte array for use by the caller. */ + /** + * Obtain a temporary buffer for use by the ObjectInserter or its subclass. + * <p> + * This buffer is supplied by the ObjectInserter base class to itself and + * its subclasses for the purposes of pulling data from a supplied + * InputStream, passing it through a Deflater, or formatting the canonical + * format of a small object like a small tree or commit. + * <p> + * <strong>This buffer IS NOT for translation such as auto-CRLF or content + * filtering and must not be used for such purposes.</strong> + * <p> + * The returned buffer is small, around a few KiBs, and the size may change + * between versions of JGit. Callers using this buffer must always check the + * length of the returned array to ascertain how much space was provided. + * <p> + * There is a single buffer for each ObjectInserter, repeated calls to this + * method will (usually) always return the same buffer. If the caller needs + * more than one buffer, or needs a buffer of a larger size, it must manage + * that buffer on its own. + * <p> + * The buffer is usually on first demand for a buffer. + * + * @return a temporary byte array for use by the caller. + */ protected byte[] buffer() { - if (tempBuffer == null) - tempBuffer = new byte[8192]; - return tempBuffer; + byte[] b = tempBuffer; + if (b == null) + tempBuffer = b = new byte[8192]; + return b; } /** @return digest to help compute an ObjectId */ |