Merge remote-tracking branch 'origin/master'

Author: patrickfav

README.md

@@ -3,7 +3,7 @@
 Bytes is a utility library that makes it easy to **create**, **parse**, **transform**,
 **validate** and **convert** byte arrays in Java. It's main class `Bytes` is
 a collections of bytes and the main API. It supports [endianness](https://en.wikipedia.org/wiki/Endianness)
-as well as **immutable** and **mutable** access, so the caller may decide to favor
+as well as **copy-on-write** and **mutable** access, so the caller may decide to favor
 performance. This can be seen as combination of the features provided by
 [`BigInteger`](https://docs.oracle.com/javase/7/docs/api/java/math/BigInteger.html),
 [`ByteBuffer`](https://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html) but
@@ -80,7 +80,7 @@ byte[] result = b.array(); //get as byte array
 
 ## API Description
 
-Per default the instance is **immutable**, which means any transformation will
+Per default the instance is **semi-immutable**, which means any transformation will
 create a copy of the internal array (it is, however, possible to get and
 modify the internal array). There is a **mutable** version which supports
 in-place modification for better performance and a **read-only** version which

src/main/java/at/favre/lib/bytes/Bytes.java

@@ -1440,7 +1440,7 @@ public Bytes byteOrder(ByteOrder byteOrder) {
 
     /**
      * Returns a new read-only byte instance. Read-only means, that there is no direct access to the underlying byte
-     * array and all transformers will create a copy (ie. immutable)
+     * array and all transformers will create a copy.
      *
      * @return a new instance if not already readonly, or "this" otherwise
      */

src/main/java/at/favre/lib/bytes/MutableBytes.java

@@ -51,8 +51,7 @@ public boolean isMutable() {
      * @throws IndexOutOfBoundsException if newArray.length > internal length
      */
     public MutableBytes overwrite(byte[] newArray) {
-        overwrite(newArray, 0);
-        return this;
+        return overwrite(newArray, 0);
     }
 
     /**
@@ -87,8 +86,7 @@ public MutableBytes setByteAt(int index, byte newByte) {
      * @return this instance
      */
     public MutableBytes wipe() {
-        fill((byte) 0);
-        return this;
+        return fill((byte) 0);
     }
 
     /**
@@ -108,8 +106,7 @@ public MutableBytes fill(byte fillByte) {
      * @return this instance
      */
     public MutableBytes secureWipe() {
-        secureWipe(new SecureRandom());
-        return this;
+        return secureWipe(new SecureRandom());
     }
 
     /**

src/main/java/at/favre/lib/bytes/ReadOnlyBytes.java

@@ -34,7 +34,7 @@
 public final class ReadOnlyBytes extends Bytes {
 
     /**
-     * Creates a new immutable instance
+     * Creates a new read-only instance
      *
      * @param byteArray internal byte array
      * @param byteOrder the internal byte order - this is used to interpret given array, not to change it

src/test/java/at/favre/lib/bytes/ABytesTest.java

@@ -27,7 +27,7 @@
 
 import static org.junit.Assert.*;
 
-abstract class ABytesTest {
+public abstract class ABytesTest {
     byte[] example_bytes_empty;
 
     byte[] example_bytes_one;

src/test/java/at/favre/lib/bytes/MutableBytesTest.java

@@ -106,7 +106,8 @@ public void setByteAtTest() {
 
         for (int i = 0; i < b.length(); i++) {
             byte old = b.byteAt(i);
-            b.setByteAt(i, (byte) 0);
+            MutableBytes bcopy = b.setByteAt(i, (byte) 0);
+            assertSame(b, bcopy);
             if (old != 0) {
                 assertNotEquals(old, b.byteAt(i));
             }