Please review: 4722265 (spec str) StringBuffer.ensureCapacity() should mention that capacity is mutable

[Jim Gish]

Please review this minor usage note change for Bug 4722265:

diff -r 8a454e92aaf1 src/share/classes/java/lang/AbstractStringBuilder.java
--- a/src/share/classes/java/lang/AbstractStringBuilder.java    Mon Sep 
17 12:40:33 2012 +0200
+++ b/src/share/classes/java/lang/AbstractStringBuilder.java    Tue Sep 
18 13:46:34 2012 -0400
@@ -96,6 +96,9 @@
       * </ul>
       * If the {@code minimumCapacity} argument is nonpositive, this
       * method takes no action and simply returns.
+     * Note that a call to ensureCapacity does not guarantee an immutable
+     * setting of the minimum desired capacity.  The capacity may change as
+     * the result of subsequent operations.
       *
       * @param   minimumCapacity   the minimum desired capacity.
       */

Thanks,
     Jim

-- 
Jim Gish | Consulting Member of Technical Staff | +1.781.442.0304
Oracle Java Platform Group | Core Libraries Team
35 Network Drive
Burlington, MA 01803
jim.gish at oracle.com