Rename to PackStringWithGetBytes and add comments

xerial · xerial · commit 031ead346902 · 2016-01-04T16:23:20.000+09:00
diff --git a/msgpack-core/src/main/java/org/msgpack/core/MessagePacker.java b/msgpack-core/src/main/java/org/msgpack/core/MessagePacker.java
@@ -428,10 +428,12 @@ public MessagePacker packDouble(double v)
         return this;
     }
 
-    private void packStringByGetBytes(String s)
+    private void packStringWithGetBytes(String s)
             throws IOException
     {
+        // JVM performs various optimizations (memory allocation, reusing encoder etc.) when String.getBytes is used
         byte[] bytes = s.getBytes(MessagePack.UTF8);
+        // Write the length and payload of small string to the buffer so that it avoids an extra flush of buffer
         packRawStringHeader(bytes.length);
         addPayload(bytes);
     }
@@ -481,8 +483,8 @@ public MessagePacker packString(String s)
             return this;
         }
         else if (s.length() < smallStringOptimizationThreshold) {
-            // Write the length and payload of small string to the buffer so that it avoids an extra flush of buffer
-            packStringByGetBytes(s);
+            // Using String.getBytes is generally faster for small strings
+            packStringWithGetBytes(s);
             return this;
         }
         else if (s.length() < (1 << 8)) {
@@ -549,7 +551,7 @@ else if (s.length() < (1 << 16)) {
         // 384KB, which is OK size to keep in memory.
 
         // fallback
-        packStringByGetBytes(s);
+        packStringWithGetBytes(s);
         return this;
     }
 

Original file line number	Diff line number	Diff line change
`@@ -428,10 +428,12 @@ public MessagePacker packDouble(double v)`
`428`	`428`	`return this;`
`429`	`429`	`}`
`430`	`430`
`431`		`- private void packStringByGetBytes(String s)`
	`431`	`+ private void packStringWithGetBytes(String s)`
`432`	`432`	`throws IOException`
`433`	`433`	`{`
	`434`	`+ // JVM performs various optimizations (memory allocation, reusing encoder etc.) when String.getBytes is used`
`434`	`435`	`byte[] bytes = s.getBytes(MessagePack.UTF8);`
	`436`	`+ // Write the length and payload of small string to the buffer so that it avoids an extra flush of buffer`
`435`	`437`	`packRawStringHeader(bytes.length);`
`436`	`438`	`addPayload(bytes);`
`437`	`439`	`}`
`@@ -481,8 +483,8 @@ public MessagePacker packString(String s)`
`481`	`483`	`return this;`
`482`	`484`	`}`
`483`	`485`	`else if (s.length() < smallStringOptimizationThreshold) {`
`484`		`- // Write the length and payload of small string to the buffer so that it avoids an extra flush of buffer`
`485`		`- packStringByGetBytes(s);`
	`486`	`+ // Using String.getBytes is generally faster for small strings`
	`487`	`+ packStringWithGetBytes(s);`
`486`	`488`	`return this;`
`487`	`489`	`}`
`488`	`490`	`else if (s.length() < (1 << 8)) {`
`@@ -549,7 +551,7 @@ else if (s.length() < (1 << 16)) {`
`549`	`551`	`// 384KB, which is OK size to keep in memory.`
`550`	`552`
`551`	`553`	`// fallback`
`552`		`- packStringByGetBytes(s);`
	`554`	`+ packStringWithGetBytes(s);`
`553`	`555`	`return this;`
`554`	`556`	`}`
`555`	`557`