msgpack#114: Enhance the constructor comments so that the user can create appropriate MessageBufferInput.

xerial · xerial · commit f8f96155422e · 2014-07-14T23:39:58.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
@@ -71,11 +71,23 @@ public class MessagePacker implements Closeable {
      */
     private CharsetEncoder encoder;
 
+
+    /**
+     * Create an MessagePacker that outputs the packed data to the specified stream
+     * @param out
+     */
     public MessagePacker(OutputStream out) {
+        // This factory method does not have significant performance overhead.
         this(new OutputStreamBufferOutput(out));
     }
 
-
+    /**
+     * Create an MessagePacker that outputs the packed data to the given {@link org.msgpack.core.buffer.MessageBufferOutput}
+     *
+     * @param out MessageBufferOutput. Use {@link org.msgpack.core.buffer.OutputStreamBufferOutput}, {@link org.msgpack.core.buffer.ChannelBufferOutput} or
+     *            your own implementation of {@link org.msgpack.core.buffer.MessageBufferOutput} interface.
+     *
+     */
     public MessagePacker(MessageBufferOutput out) {
         this(out, MessagePack.DEFAULT_CONFIG);
     }
diff --git a/msgpack-core/src/main/java/org/msgpack/core/MessageUnpacker.java b/msgpack-core/src/main/java/org/msgpack/core/MessageUnpacker.java
@@ -134,8 +134,20 @@ public MessageUnpacker(byte[] arr) {
         this(new ArrayBufferInput(arr));
     }
 
+    /**
+     * Create an MessageUnpacker that reads data from the given byte array [offset, offset+length)
+     * @param arr
+     * @param offset
+     * @param length
+     */
+    public MessageUnpacker(byte[] arr, int offset, int length) {
+        this(new ArrayBufferInput(arr, offset, length));
+    }
+
     /**
      * Create an MessageUnpacker that reads data from the given InputStream.
+     * For reading data efficiently from byte[], use {@link #MessageUnpacker(byte[])} or {@link #MessageUnpacker(byte[], int, int)} instead of this constructor.
+     *
      * @param in
      */
     public MessageUnpacker(InputStream in) {
diff --git a/msgpack-core/src/main/java/org/msgpack/core/buffer/InputStreamBufferInput.java b/msgpack-core/src/main/java/org/msgpack/core/buffer/InputStreamBufferInput.java
@@ -13,50 +13,15 @@
  */
 public class InputStreamBufferInput implements MessageBufferInput {
 
-    private static Field bufField;
-    private static Field bufPosField;
-    private static Field bufCountField;
-
-    private static Field getField(String name) {
-        Field f = null;
-        try {
-            f = ByteArrayInputStream.class.getDeclaredField(name);
-            f.setAccessible(true);
-        }
-        catch(Exception e) {
-            e.printStackTrace();
-        }
-        return f;
-    }
-
-    static {
-        bufField = getField("buf");
-        bufPosField = getField("pos");
-        bufCountField = getField("count");
-    }
-
     private final InputStream in;
     private final int bufferSize;
     private boolean reachedEOF = false;
 
     public static MessageBufferInput newBufferInput(InputStream in) {
         checkNotNull(in, "InputStream is null");
-        if(in.getClass() == ByteArrayInputStream.class) {
-            ByteArrayInputStream b = (ByteArrayInputStream) in;
-            try {
-                // Extract a raw byte array from the ByteArrayInputStream
-                byte[] buf = (byte[]) bufField.get(b);
-                int pos = (Integer) bufPosField.get(b);
-                int length = (Integer) bufCountField.get(b);
-                return new ArrayBufferInput(buf, pos, length);
-            }
-            catch(Exception e) {
-                // Failed to retrieve the raw byte array
-            }
-        } else if (in instanceof FileInputStream) {
+        if (in instanceof FileInputStream) {
             return new ChannelBufferInput(((FileInputStream) in).getChannel());
         }
-
         return new InputStreamBufferInput(in);
     }
 
diff --git a/msgpack-core/src/test/scala/org/msgpack/core/MessageUnpackerTest.scala b/msgpack-core/src/test/scala/org/msgpack/core/MessageUnpackerTest.scala
@@ -439,8 +439,7 @@ class MessageUnpackerTest extends MessagePackSpec {
         }
 
         block("v7") {
-          //val unpacker = new MessageUnpacker(b)
-          val unpacker = new MessageUnpacker(new ByteArrayInputStream(b))
+          val unpacker = new MessageUnpacker(b)
           var i = 0
           while(i < R) {
             val len = unpacker.unpackBinaryHeader()
@@ -452,7 +451,7 @@ class MessageUnpackerTest extends MessagePackSpec {
         }
 
         block("v7-ref") {
-          val unpacker = new MessageUnpacker(new ByteArrayInputStream(b))
+          val unpacker = new MessageUnpacker(b)
           var i = 0
           while(i < R) {
             val len = unpacker.unpackBinaryHeader()
