Revert the removed configuration comments and use more redable configuration names

xerial · xerial · commit d29276f7b641 · 2016-01-04T15:53:49.000+09:00
diff --git a/msgpack-core/src/main/java/org/msgpack/core/MessagePack.java b/msgpack-core/src/main/java/org/msgpack/core/MessagePack.java
@@ -147,6 +147,10 @@ public static MessageUnpacker newDefaultUnpacker(byte[] contents, int offset, in
      */
     public static class PackerConfig
     {
+        /**
+         * Use String.getBytes() for converting Java Strings that are smaller than this threshold into UTF8.
+         * Note that this parameter is subject to change.
+         */
         public int smallStringOptimizationThreshold = 512;
 
         /**
@@ -155,7 +159,8 @@ public static class PackerConfig
          * @param out
          * @return
          */
-        public MessagePacker newPacker(MessageBufferOutput out) {
+        public MessagePacker newPacker(MessageBufferOutput out)
+        {
             return new MessagePacker(out, this);
         }
 
@@ -165,7 +170,8 @@ public MessagePacker newPacker(MessageBufferOutput out) {
          * @param out
          * @return
          */
-        public MessagePacker newPacker(OutputStream out) {
+        public MessagePacker newPacker(OutputStream out)
+        {
             return newPacker(new OutputStreamBufferOutput(out));
         }
 
@@ -175,7 +181,8 @@ public MessagePacker newPacker(OutputStream out) {
          * @param channel
          * @return
          */
-        public MessagePacker newPacker(WritableByteChannel channel) {
+        public MessagePacker newPacker(WritableByteChannel channel)
+        {
             return newPacker(new ChannelBufferOutput(channel));
         }
 
@@ -184,7 +191,8 @@ public MessagePacker newPacker(WritableByteChannel channel) {
          *
          * @return
          */
-        public MessageBufferPacker newBufferPacker() {
+        public MessageBufferPacker newBufferPacker()
+        {
             return new MessageBufferPacker(this);
         }
     }
@@ -194,11 +202,34 @@ public MessageBufferPacker newBufferPacker() {
      */
     public static class UnpackerConfig
     {
-        public boolean allowStringAsBinary = true;
-        public boolean allowBinaryAsString = true;
+        /**
+         * Allow unpackBinaryHeader to read str format family  (default:true)
+         */
+        public boolean allowReadingStringAsBinary = true;
+
+        /**
+         * Allow unpackRawStringHeader and unpackString to read bin format family (default: true)
+         */
+        public boolean allowReadingBinaryAsString = true;
+
+        /**
+         * Action when encountered a malformed input
+         */
         public CodingErrorAction actionOnMalformedString = CodingErrorAction.REPLACE;
+
+        /**
+         * Action when an unmappable character is found
+         */
         public CodingErrorAction actionOnUnmappableString = CodingErrorAction.REPLACE;
+
+        /**
+         * unpackString size limit. (default: Integer.MAX_VALUE)
+         */
         public int stringSizeLimit = Integer.MAX_VALUE;
+
+        /**
+         *
+         */
         public int stringDecoderBufferSize = 8192;
 
         /**
@@ -207,7 +238,8 @@ public static class UnpackerConfig
          * @param in
          * @return
          */
-        public MessageUnpacker newUnpacker(MessageBufferInput in) {
+        public MessageUnpacker newUnpacker(MessageBufferInput in)
+        {
             return new MessageUnpacker(in, this);
         }
 
@@ -217,7 +249,8 @@ public MessageUnpacker newUnpacker(MessageBufferInput in) {
          * @param in
          * @return
          */
-        public MessageUnpacker newUnpacker(InputStream in) {
+        public MessageUnpacker newUnpacker(InputStream in)
+        {
             return newUnpacker(new InputStreamBufferInput(in));
         }
 
@@ -227,7 +260,8 @@ public MessageUnpacker newUnpacker(InputStream in) {
          * @param channel
          * @return
          */
-        public MessageUnpacker newUnpacker(ReadableByteChannel channel) {
+        public MessageUnpacker newUnpacker(ReadableByteChannel channel)
+        {
             return newUnpacker(new ChannelBufferInput(channel));
         }
 
@@ -237,7 +271,8 @@ public MessageUnpacker newUnpacker(ReadableByteChannel channel) {
          * @param contents
          * @return
          */
-        public MessageUnpacker newUnpacker(byte[] contents) {
+        public MessageUnpacker newUnpacker(byte[] contents)
+        {
             return newUnpacker(new ArrayBufferInput(contents));
         }
 
@@ -247,9 +282,9 @@ public MessageUnpacker newUnpacker(byte[] contents) {
          * @param contents
          * @return
          */
-        public MessageUnpacker newUnpacker(byte[] contents, int offset, int length) {
+        public MessageUnpacker newUnpacker(byte[] contents, int offset, int length)
+        {
             return newUnpacker(new ArrayBufferInput(contents, offset, length));
         }
-
     }
 }
diff --git a/msgpack-core/src/main/java/org/msgpack/core/MessageUnpacker.java b/msgpack-core/src/main/java/org/msgpack/core/MessageUnpacker.java
@@ -73,8 +73,8 @@ public class MessageUnpacker
 
     private static final byte HEAD_BYTE_REQUIRED = (byte) 0xc1;
 
-    private final boolean allowStringAsBinary;
-    private final boolean allowBinaryAsString;
+    private final boolean allowReadingStringAsBinary;
+    private final boolean allowReadingBinaryAsString;
     private final CodingErrorAction actionOnMalformedString;
     private final CodingErrorAction actionOnUnmappableString;
     private final int stringSizeLimit;
@@ -134,10 +134,10 @@ public 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
-        this.allowStringAsBinary = config.allowStringAsBinary;
-        this.allowBinaryAsString = config.allowBinaryAsString;
+        this.allowReadingStringAsBinary = config.allowReadingStringAsBinary;
+        this.allowReadingBinaryAsString = config.allowReadingBinaryAsString;
         this.actionOnMalformedString = config.actionOnMalformedString;
-        this.actionOnUnmappableString =  config.actionOnUnmappableString;
+        this.actionOnUnmappableString = config.actionOnUnmappableString;
         this.stringSizeLimit = config.stringSizeLimit;
         this.stringDecoderBufferSize = config.stringDecoderBufferSize;
     }
@@ -1149,7 +1149,7 @@ public int unpackRawStringHeader()
             return len;
         }
 
-        if (allowBinaryAsString) {
+        if (allowReadingBinaryAsString) {
             len = tryReadBinaryHeader(b);
             if (len >= 0) {
                 return len;
@@ -1170,7 +1170,7 @@ public int unpackBinaryHeader()
             return len;
         }
 
-        if (allowStringAsBinary) {
+        if (allowReadingStringAsBinary) {
             len = tryReadStringHeader(b);
             if (len >= 0) {
                 return len;
