Merge pull request msgpack#321 from msgpack/protected-constructor

xerial · xerial · commit 6ecdca1605af · 2016-01-06T10:04:08.000+09:00
Make constructors protected to ensure the single entry point
diff --git a/msgpack-core/src/main/java/org/msgpack/core/MessageBufferPacker.java b/msgpack-core/src/main/java/org/msgpack/core/MessageBufferPacker.java
@@ -28,12 +28,12 @@
 public class MessageBufferPacker
         extends MessagePacker
 {
-    public MessageBufferPacker(MessagePack.PackerConfig config)
+    protected MessageBufferPacker(MessagePack.PackerConfig config)
     {
         this(new ArrayBufferOutput(), config);
     }
 
-    public MessageBufferPacker(ArrayBufferOutput out, MessagePack.PackerConfig config)
+    protected MessageBufferPacker(ArrayBufferOutput out, MessagePack.PackerConfig config)
     {
         super(out, config);
     }
diff --git a/msgpack-core/src/main/java/org/msgpack/core/MessagePacker.java b/msgpack-core/src/main/java/org/msgpack/core/MessagePacker.java
@@ -105,12 +105,13 @@ public class MessagePacker
     private CharsetEncoder encoder;
 
     /**
-     * Create an MessagePacker that outputs the packed data to the given {@link org.msgpack.core.buffer.MessageBufferOutput}
+     * Create an MessagePacker that outputs the packed data to the given {@link org.msgpack.core.buffer.MessageBufferOutput}.
+     * This method is available for subclasses to override. Use MessagePack.PackerConfig.newPacker method to instanciate this implementation.
      *
      * @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, MessagePack.PackerConfig config)
+    protected MessagePacker(MessageBufferOutput out, MessagePack.PackerConfig config)
     {
         this.out = checkNotNull(out, "MessageBufferOutput is null");
         // We must copy the configuration parameters here since the config object is mutable
diff --git a/msgpack-core/src/main/java/org/msgpack/core/MessageUnpacker.java b/msgpack-core/src/main/java/org/msgpack/core/MessageUnpacker.java
@@ -122,11 +122,12 @@ public class MessageUnpacker
     private CharBuffer decodeBuffer;
 
     /**
-     * Create an MessageUnpacker that reads data from the given MessageBufferInput
+     * Create an MessageUnpacker that reads data from the given MessageBufferInput.
+     * This method is available for subclasses to override. Use MessagePack.UnpackerConfig.newUnpacker method to instanciate this implementation.
      *
      * @param in
      */
-    public MessageUnpacker(MessageBufferInput in, MessagePack.UnpackerConfig config)
+    protected MessageUnpacker(MessageBufferInput in, MessagePack.UnpackerConfig config)
     {
         this.in = checkNotNull(in, "MessageBufferInput is null");
         // We need to copy the configuration parameters since the config object is mutable

Original file line number	Diff line number	Diff line change
`@@ -28,12 +28,12 @@`
`28`	`28`	`public class MessageBufferPacker`
`29`	`29`	`extends MessagePacker`
`30`	`30`	`{`
`31`		`- public MessageBufferPacker(MessagePack.PackerConfig config)`
	`31`	`+ protected MessageBufferPacker(MessagePack.PackerConfig config)`
`32`	`32`	`{`
`33`	`33`	`this(new ArrayBufferOutput(), config);`
`34`	`34`	`}`
`35`	`35`
`36`		`- public MessageBufferPacker(ArrayBufferOutput out, MessagePack.PackerConfig config)`
	`36`	`+ protected MessageBufferPacker(ArrayBufferOutput out, MessagePack.PackerConfig config)`
`37`	`37`	`{`
`38`	`38`	`super(out, config);`
`39`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -122,11 +122,12 @@ public class MessageUnpacker`
`122`	`122`	`private CharBuffer decodeBuffer;`
`123`	`123`
`124`	`124`	`/**`
`125`		`- * Create an MessageUnpacker that reads data from the given MessageBufferInput`
	`125`	`+ * Create an MessageUnpacker that reads data from the given MessageBufferInput.`
	`126`	`+ * This method is available for subclasses to override. Use MessagePack.UnpackerConfig.newUnpacker method to instanciate this implementation.`
`126`	`127`	`*`
`127`	`128`	`* @param in`
`128`	`129`	`*/`
`129`		`- public MessageUnpacker(MessageBufferInput in, MessagePack.UnpackerConfig config)`
	`130`	`+ protected MessageUnpacker(MessageBufferInput in, MessagePack.UnpackerConfig config)`
`130`	`131`	`{`
`131`	`132`	`this.in = checkNotNull(in, "MessageBufferInput is null");`
`132`	`133`	`// We need to copy the configuration parameters since the config object is mutable`