Rename toObjectArray() to toBoxedArray()

Author: patrickfav

CHANGELOG

@@ -3,6 +3,7 @@
 ## v0.5.0
  * better resource handling for compression
  * add nullSafe from() constructor
+ * rename `toObjectArray()` to `toBoxedArray()` (will be removed in 1.0)
 
 ## v0.4.6
 

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

@@ -223,11 +223,11 @@ public static Bytes from(Collection<Byte> bytesCollection) {
     /**
      * Creates a new instance from given object byte array. Will copy and unbox every element.
      *
-     * @param objectArray to create from
+     * @param boxedObjectArray to create from
      * @return new instance
      */
-    public static Bytes from(Byte[] objectArray) {
-        return wrap(Util.toPrimitiveArray(objectArray));
+    public static Bytes from(Byte[] boxedObjectArray) {
+        return wrap(Util.toPrimitiveArray(boxedObjectArray));
     }
 
     /**
@@ -1379,7 +1379,7 @@ public String encode(BinaryToTextEncoding.Encoder encoder) {
         return encoder.encode(internalArray(), byteOrder);
     }
 
-    /* CONSERVATORS WITHOUT REUSING THE INTERNAL ARRAY ****************************************************************/
+    /* CONVERTERS WITHOUT REUSING THE INTERNAL ARRAY ****************************************************************/
 
     /**
      * Returns a copy of the internal byte-array as {@link List} collection type
@@ -1391,14 +1391,22 @@ public List<Byte> toList() {
         return Util.toList(internalArray());
     }
 
+    /**
+     * @deprecated renamed API, use {@link #toBoxedArray()} instead - will be removed in v1.0+
+     */
+    @Deprecated
+    public Byte[] toObjectArray() {
+        return toBoxedArray();
+    }
+
     /**
      * Returns a copy of the internal byte-array as boxed primitive array.
      * This requires a time and space complexity of O(n).
      *
      * @return copy of internal array as object array
      */
-    public Byte[] toObjectArray() {
-        return Util.toObjectArray(internalArray());
+    public Byte[] toBoxedArray() {
+        return Util.toBoxedArray(internalArray());
     }
 
     /**

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

@@ -168,7 +168,7 @@ static List<Byte> toList(byte[] array) {
      * @param array to convert
      * @return new array
      */
-    static Byte[] toObjectArray(byte[] array) {
+    static Byte[] toBoxedArray(byte[] array) {
         Byte[] objectArray = new Byte[array.length];
         for (int i = 0; i < array.length; i++) {
             objectArray[i] = array[i];

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

@@ -30,7 +30,7 @@
 public class BytesToConvertOtherTypesTest extends ABytesTest {
 
     @Test
-    public void toObjectArray() throws Exception {
+    public void toObjectArray() {
         checkArray(example_bytes_empty);
         checkArray(example_bytes_one);
         checkArray(example_bytes_two);
@@ -40,15 +40,15 @@ public void toObjectArray() throws Exception {
     }
 
     private void checkArray(byte[] array) {
-        Byte[] byteArray = Bytes.from(array).toObjectArray();
+        Byte[] byteArray = Bytes.from(array).toBoxedArray();
         assertEquals(array.length, byteArray.length);
         for (int i = 0; i < array.length; i++) {
             assertEquals(byteArray[i], Byte.valueOf(array[i]));
         }
     }
 
     @Test
-    public void toList() throws Exception {
+    public void toList() {
         checkList(example_bytes_empty);
         checkList(example_bytes_one);
         checkList(example_bytes_two);
@@ -66,7 +66,7 @@ private void checkList(byte[] array) {
     }
 
     @Test
-    public void toBitSet() throws Exception {
+    public void toBitSet() {
         assertArrayEquals(example_bytes_empty, Bytes.from(example_bytes_empty).toBitSet().toByteArray());
         assertArrayEquals(example_bytes_one, Bytes.from(example_bytes_one).toBitSet().toByteArray());
         assertArrayEquals(example_bytes_two, Bytes.from(example_bytes_two).toBitSet().toByteArray());
@@ -76,7 +76,7 @@ public void toBitSet() throws Exception {
     }
 
     @Test
-    public void toByte() throws Exception {
+    public void toByte() {
         assertEquals(example_bytes_one[0], Bytes.from(example_bytes_one).toByte());
         assertEquals((byte) 0, Bytes.from(new byte[1]).toByte());
         assertEquals(-1, Bytes.from((byte) 0b1111_1111).toByte());
@@ -89,7 +89,7 @@ public void toByte() throws Exception {
     }
 
     @Test
-    public void toUnsignedByte() throws Exception {
+    public void toUnsignedByte() {
         assertEquals(example_bytes_one[0], Bytes.from(example_bytes_one).toUnsignedByte());
         assertEquals((byte) 0, Bytes.from(new byte[1]).toUnsignedByte());
         assertEquals(255, Bytes.from((byte) 0b1111_1111).toUnsignedByte());
@@ -102,7 +102,7 @@ public void toUnsignedByte() throws Exception {
     }
 
     @Test
-    public void toChar() throws Exception {
+    public void toChar() {
         assertEquals(6767, Bytes.from(example_bytes_two).toChar());
         assertEquals(Bytes.from(example_bytes_two).toShort(), Bytes.from(example_bytes_two).toChar());
         assertEquals((char) 0, Bytes.from(new byte[2]).toChar());
@@ -120,7 +120,7 @@ public void toChar() throws Exception {
     }
 
     @Test
-    public void toShort() throws Exception {
+    public void toShort() {
         assertEquals(6767, Bytes.from(example_bytes_two).toShort());
         assertEquals(Bytes.from(example_bytes_one).toByte(), Bytes.from((byte) 0, example_bytes_one).toShort());
         assertEquals((short) 0, Bytes.from(new byte[2]).toShort());
@@ -138,7 +138,7 @@ public void toShort() throws Exception {
     }
 
     @Test
-    public void toInt() throws Exception {
+    public void toInt() {
         assertEquals(591065872, Bytes.from(example_bytes_four).toInt());
         assertEquals(Bytes.from(new byte[]{0, 0, 0, 0}, example_bytes_four).toLong(), Bytes.from(example_bytes_four).toInt());
 
@@ -161,7 +161,7 @@ public void toInt() throws Exception {
     }
 
     @Test
-    public void toLong() throws Exception {
+    public void toLong() {
         assertEquals(-1237929515650418679L, Bytes.from(example_bytes_eight).toLong());
 
         assertEquals(example_bytes_one[0], Bytes.from(new byte[]{0, 0, 0, 0, 0, 0, 0}, example_bytes_one).toLong());
@@ -181,7 +181,7 @@ public void toLong() throws Exception {
     }
 
     @Test
-    public void toFloat() throws Exception {
+    public void toFloat() {
         assertEquals(1.0134550690550691E-17, Bytes.from(example_bytes_four).toFloat(), 0.001);
 
         assertEquals(5.1E-322, Bytes.from(new byte[]{0, 0, 0}, example_bytes_one).toFloat(), 0.001);
@@ -201,7 +201,7 @@ public void toFloat() throws Exception {
     }
 
     @Test
-    public void toDouble() throws Exception {
+    public void toDouble() {
         assertEquals(-6.659307728279082E225, Bytes.from(example_bytes_eight).toDouble(), 0.001);
 
         assertEquals(5.1E-322, Bytes.from(new byte[]{0, 0, 0, 0, 0, 0, 0}, example_bytes_one).toDouble(), 0.001);