Add factory method template for creating packer/unpacker instances

Author: xerial

msgpack-core/src/main/java/org/msgpack/core/MessageBufferInput.java

@@ -1,9 +1,24 @@
 package org.msgpack.core;
 
+import java.io.IOException;
+
 /**
- *
+ * Provides a sequence of MessageBuffers that contains message packed data.
  */
 public interface MessageBufferInput {
 
+    /**
+     * Get a next buffer to read
+     * @return
+     * @throws IOException
+     */
+    public MessageBuffer next() throws IOException;
+
+    /**
+     * Close this buffer input
+     * @throws IOException
+     */
+    public void close() throws IOException;
+
 
 }

msgpack-core/src/main/java/org/msgpack/core/MessageBufferOutput.java

@@ -1,12 +1,24 @@
 package org.msgpack.core;
 
+import java.io.IOException;
 
 /**
- *
+ * Provides a sequence of MessageBuffers for packing the input data
  */
 public interface MessageBufferOutput {
 
+    /**
+     * Retrieves the next buffer for writing message packed data
+     * @return
+     * @throws IOException
+     */
+    public MessageBuffer next() throws IOException;
 
+    /**
+     * Flush and close this buffer.
+     * @throws IOException
+     */
+    public void close() throws IOException;
 
 
 }

msgpack-core/src/main/java/org/msgpack/core/MessagePack.java

@@ -1,7 +1,12 @@
 package org.msgpack.core;
 
+import java.io.*;
+import java.nio.channels.ReadableByteChannel;
+import java.nio.channels.WritableByteChannel;
+import java.nio.file.Path;
+
 /**
- * Created on 2014/05/05.
+ * Entry point for creating MessagePacker and MessageUnpacker
  */
 public class MessagePack {
 
@@ -22,4 +27,44 @@ public int getLength() {
         }
     }
 
+    /**
+     * Create a new MessagePacker that writes the message packed data to a file
+     * @param outputFile
+     * @return MessagePacker
+     * @throws IOException if the target file cannot be created or opened
+     */
+    public static MessagePacker newPacker(File outputFile) throws IOException {
+        return newPacker(new FileOutputStream(outputFile));
+    }
+
+    public static MessagePacker newPacker(OutputStream out) {
+        // TODO
+        return null;
+    }
+
+    public static MessagePacker newPacker(WritableByteChannel out) {
+        // TODO
+        return null;
+    }
+
+    /**
+     * Create a new MessageUnpacker that decodes the message packed data in a file
+     * @param inputFile
+     * @return MessageUnpacker
+     * @throws IOException if the input file is not found
+     */
+    public static MessageUnpacker newUnpacker(File inputFile) throws IOException {
+        return newUnpacker(new FileInputStream(inputFile));
+    }
+
+    public static MessageUnpacker newUnpacker(InputStream in) {
+        // TODO
+        return null;
+    }
+
+    public static MessageUnpacker newUnpacker(ReadableByteChannel in) {
+        // TODO
+        return null;
+    }
+
 }

msgpack-core/src/test/scala/org/msgpack/core/MessageBufferTest.scala

@@ -4,13 +4,6 @@ import java.nio.ByteBuffer
 import xerial.core.log.LogLevel
 import scala.util.Random
 
-object Test {
-  val b = ByteBuffer.allocate(10)
-  b.getInt(0)
-
-  val m = MessageBuffer.newBuffer(10)
-  m.getInt(0)
-}
 
 /**
  * Created on 2014/05/01.