MessageBuffer is now always safe to get internal array, and exposing base and address become unnecessary

frsyuki · komamitsu · commit e6811be1b639 · 2015-12-27T17:48:22.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
@@ -505,7 +505,7 @@ else if (s.length() < (1 << 8)) {
                     }
                     // move 1 byte backward to expand 3-byte header region to 3 bytes
                     buffer.putBytes(position + 3,
-                            buffer.getArray(), buffer.offset() + position + 2, written);
+                            buffer.array(), buffer.arrayOffset() + position + 2, written);
                     // write 3-byte header header
                     buffer.putByte(position++, STR16);
                     buffer.putShort(position, (short) written);
@@ -534,7 +534,7 @@ else if (s.length() < (1 << 16)) {
                     }
                     // move 2 bytes backward to expand 3-byte header region to 5 bytes
                     buffer.putBytes(position + 5,
-                            buffer.getArray(), buffer.offset() + position + 3, written);
+                            buffer.array(), buffer.arrayOffset() + position + 3, written);
                     // write 3-byte header header
                     buffer.putByte(position++, STR32);
                     buffer.putInt(position, written);
diff --git a/msgpack-core/src/main/java/org/msgpack/core/MessageUnpacker.java b/msgpack-core/src/main/java/org/msgpack/core/MessageUnpacker.java
@@ -255,8 +255,8 @@ private MessageBuffer readCastBuffer(int length)
 
             // TODO this doesn't work if MessageBuffer is allocated by newDirectBuffer.
             //      add copy method to MessageBuffer to solve this issue.
-            castBuffer.putBytes(0, buffer.getArray(), buffer.offset() + position, remaining);
-            castBuffer.putBytes(remaining, next.getArray(), next.offset(), length - remaining);
+            castBuffer.putBytes(0, buffer.array(), buffer.arrayOffset() + position, remaining);
+            castBuffer.putBytes(remaining, next.array(), next.arrayOffset(), length - remaining);
 
             totalReadBytes += buffer.size();
 
@@ -1106,9 +1106,8 @@ private void handleCoderError(CoderResult cr)
     private String decodeStringFastPath(int length)
     {
         if (actionOnMalformedString == CodingErrorAction.REPLACE &&
-                actionOnUnmappableString == CodingErrorAction.REPLACE &&
-                buffer.hasArray()) {
-            String s = new String(buffer.getArray(), buffer.offset() + position, length, MessagePack.UTF8);
+                actionOnUnmappableString == CodingErrorAction.REPLACE) {
+            String s = new String(buffer.array(), buffer.arrayOffset() + position, length, MessagePack.UTF8);
             position += length;
             return s;
         }
diff --git a/msgpack-core/src/main/java/org/msgpack/core/Nullable.java b/msgpack-core/src/main/java/org/msgpack/core/Nullable.java
@@ -13,11 +13,11 @@
 //    See the License for the specific language governing permissions and
 //    limitations under the License.
 //
-package org.msgpack.core.annotations;
+package org.msgpack.core;
 
 /**
  * Annotates a field which can be null
  */
-public @interface Nullable
+@interface Nullable
 {
 }
diff --git a/msgpack-core/src/main/java/org/msgpack/core/Preconditions.java b/msgpack-core/src/main/java/org/msgpack/core/Preconditions.java
@@ -31,7 +31,6 @@
  */
 package org.msgpack.core;
 
-import org.msgpack.core.annotations.Nullable;
 import org.msgpack.core.annotations.VisibleForTesting;
 
 /**
diff --git a/msgpack-core/src/main/java/org/msgpack/core/annotations/Insecure.java b/msgpack-core/src/main/java/org/msgpack/core/annotations/Insecure.java
diff --git a/msgpack-core/src/main/java/org/msgpack/core/buffer/MessageBuffer.java b/msgpack-core/src/main/java/org/msgpack/core/buffer/MessageBuffer.java
@@ -15,7 +15,6 @@
 //
 package org.msgpack.core.buffer;
 
-import org.msgpack.core.annotations.Insecure;
 import sun.misc.Unsafe;
 
 import java.lang.reflect.Constructor;
@@ -428,39 +427,14 @@ public byte[] toByteArray()
         return b;
     }
 
-    @Insecure
-    public boolean hasArray()
-    {
-        return base instanceof byte[];
-    }
-
-    @Insecure
-    public byte[] getArray()
+    public byte[] array()
     {
         return (byte[]) base;
     }
 
-    @Insecure
-    public Object getBase()
-    {
-        return base;
-    }
-
-    @Insecure
-    public long getAddress()
+    public int arrayOffset()
     {
-        return address;
-    }
-
-    @Insecure
-    public int offset()
-    {
-        if (hasArray()) {
-            return (int) address - ARRAY_BYTE_BASE_OFFSET;
-        }
-        else {
-            return 0;
-        }
+        return (int) address - ARRAY_BYTE_BASE_OFFSET;
     }
 
     /**
diff --git a/msgpack-core/src/main/java/org/msgpack/core/buffer/MessageBufferU.java b/msgpack-core/src/main/java/org/msgpack/core/buffer/MessageBufferU.java
@@ -33,7 +33,10 @@ public class MessageBufferU
     MessageBufferU(byte[] arr, int offset, int length)
     {
         super(arr, offset, length);
-        this.wrap = ByteBuffer.wrap(arr, offset, length);
+        ByteBuffer bb = ByteBuffer.wrap(arr);
+        bb.position(offset);
+        bb.limit(offset + length);
+        this.wrap = bb.slice();
     }
 
     private MessageBufferU(Object base, long address, int length, ByteBuffer wrap)
diff --git a/msgpack-core/src/main/java/org/msgpack/core/buffer/OutputStreamBufferOutput.java b/msgpack-core/src/main/java/org/msgpack/core/buffer/OutputStreamBufferOutput.java
@@ -68,7 +68,7 @@ public MessageBuffer next(int mimimumSize)
     public void writeBuffer(int length)
             throws IOException
     {
-        write(buffer.getArray(), buffer.offset(), length);
+        write(buffer.array(), buffer.arrayOffset(), length);
     }
 
     @Override

Original file line number	Diff line number	Diff line change
`@@ -13,11 +13,11 @@`
`13`	`13`	`// See the License for the specific language governing permissions and`
`14`	`14`	`// limitations under the License.`
`15`	`15`	`//`
`16`		`-package org.msgpack.core.annotations;`
	`16`	`+package org.msgpack.core;`
`17`	`17`
`18`	`18`	`/**`
`19`	`19`	`* Annotates a field which can be null`
`20`	`20`	`*/`
`21`		`-public @interface Nullable`
	`21`	`+@interface Nullable`
`22`	`22`	`{`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,10 @@ public class MessageBufferU`
`33`	`33`	`MessageBufferU(byte[] arr, int offset, int length)`
`34`	`34`	`{`
`35`	`35`	`super(arr, offset, length);`
`36`		`- this.wrap = ByteBuffer.wrap(arr, offset, length);`
	`36`	`+ ByteBuffer bb = ByteBuffer.wrap(arr);`
	`37`	`+ bb.position(offset);`
	`38`	`+ bb.limit(offset + length);`
	`39`	`+ this.wrap = bb.slice();`
`37`	`40`	`}`
`38`	`41`
`39`	`42`	`private MessageBufferU(Object base, long address, int length, ByteBuffer wrap)`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ public MessageBuffer next(int mimimumSize)`
`68`	`68`	`public void writeBuffer(int length)`
`69`	`69`	`throws IOException`
`70`	`70`	`{`
`71`		`- write(buffer.getArray(), buffer.offset(), length);`
	`71`	`+ write(buffer.array(), buffer.arrayOffset(), length);`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`@Override`