BytesLocation: use ByteBank for backing bytes

ctrueden · ctrueden · commit b459699b6a50 · 2017-07-10T17:03:46.000-05:00
This is more flexible than ByteBuffer, since ByteBank is resizable.
diff --git a/src/main/java/org/scijava/io/location/BytesLocation.java b/src/main/java/org/scijava/io/location/BytesLocation.java
@@ -31,33 +31,71 @@
 
 package org.scijava.io.location;
 
-import java.nio.ByteBuffer;
+import org.scijava.io.ByteArrayByteBank;
+import org.scijava.io.ByteBank;
+import org.scijava.util.ByteArray;
 
 /**
- * {@link Location} backed by a {@link ByteBuffer}.
+ * {@link Location} backed by a {@link ByteBank}.
  *
  * @author Curtis Rueden
+ * @author Gabriel Einsdorf
  */
 public class BytesLocation extends AbstractLocation {
 
-	private final ByteBuffer bytes;
+	private final ByteBank bytes;
 
-	public BytesLocation(final ByteBuffer bytes) {
+	/**
+	 * Creates a {@link BytesLocation} backed by the specified
+	 * {@link ByteBank}.
+	 *
+	 * @param bytes the {@link ByteBank} that will back this {@link Location}
+	 */
+	public BytesLocation(final ByteBank bytes) {
 		this.bytes = bytes;
 	}
 
+	/**
+	 * Creates a {@link BytesLocation} backed by a {@link ByteArrayByteBank}
+	 * with the specified initial capacity.
+	 */
+	public BytesLocation(final int initialCapacity) {
+		this.bytes = new ByteArrayByteBank(initialCapacity);
+	}
+
+	/**
+	 * Creates a {@link BytesLocation} backed by a {@link ByteArrayByteBank}
+	 * that wraps the specified {@link ByteArray}.
+	 */
+	public BytesLocation(final ByteArray bytes) {
+		this.bytes = new ByteArrayByteBank(bytes);
+	}
+
+	/**
+	 * Creates a {@link BytesLocation} backed by a {@link ByteArrayByteBank}
+	 * which wraps the specified array.
+	 *
+	 * @param bytes the array to wrap
+	 */
 	public BytesLocation(final byte[] bytes) {
-		this(ByteBuffer.wrap(bytes));
+		this.bytes = new ByteArrayByteBank(bytes);
 	}
 
-	public BytesLocation(final byte[] bytes, final int offset, final int length) {
-		this(ByteBuffer.wrap(bytes, offset, length));
+	/**
+	 * Creates a {@link BytesLocation} backed by a {@link ByteArrayByteBank} with
+	 * the specified initial capacity.
+	 */
+	public BytesLocation(final byte[] bytes, final int offset,
+		final int length)
+	{
+		this.bytes = new ByteArrayByteBank(length);
+		this.bytes.setBytes(0l, bytes, offset, length);
 	}
 
 	// -- BytesLocation methods --
 
-	/** Gets the associated {@link ByteBuffer}. */
-	public ByteBuffer getByteBuffer() {
+	/** Gets the backing {@link ByteBank}. */
+	public ByteBank getByteBank() {
 		return bytes;
 	}
 
diff --git a/src/test/java/org/scijava/io/location/BytesLocationTest.java b/src/test/java/org/scijava/io/location/BytesLocationTest.java
@@ -31,11 +31,10 @@
 
 package org.scijava.io.location;
 
+import static org.junit.Assert.assertArrayEquals;
 import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertSame;
 
 import org.junit.Test;
-import org.scijava.io.location.BytesLocation;
 
 /**
  * Tests {@link BytesLocation}.
@@ -47,22 +46,29 @@ public class BytesLocationTest {
 	/** Tests {@link BytesLocation#BytesLocation(byte[])}. */
 	@Test
 	public void testBytes() {
-		final byte[] digits = {3, 1, 4, 1, 5, 9, 2, 6, 5, 3, 5, 8, 9, 7, 9};
+		final byte[] digits = { 3, 1, 4, 1, 5, 9, 2, 6, 5, 3, 5, 8, 9, 7, 9 };
 		final BytesLocation loc = new BytesLocation(digits);
-		assertSame(digits, loc.getByteBuffer().array());
-		assertEquals(0, loc.getByteBuffer().position());
-		assertEquals(digits.length, loc.getByteBuffer().remaining());
+
+		final byte[] testDigits = new byte[digits.length];
+		loc.getByteBank().getBytes(0, testDigits);
+		assertEquals(digits.length, loc.getByteBank().getMaxPos());
+		assertArrayEquals(digits, testDigits);
 	}
 
 	/** Tests {@link BytesLocation#BytesLocation(byte[], int, int)}. */
 	@Test
 	public void testBytesOffsetLength() {
-		final byte[] digits = {3, 1, 4, 1, 5, 9, 2, 6, 5, 3, 5, 8, 9, 7, 9};
+		final byte[] digits = { 3, 1, 4, 1, 5, 9, 2, 6, 5, 3, 5, 8, 9, 7, 9 };
 		final int offset = 3, length = 5;
 		final BytesLocation loc = new BytesLocation(digits, offset, length);
-		assertSame(digits, loc.getByteBuffer().array());
-		assertEquals(offset, loc.getByteBuffer().position());
-		assertEquals(length, loc.getByteBuffer().remaining());
+
+		final byte[] testDigits = new byte[digits.length];
+		loc.getByteBank().getBytes(0, testDigits);
+		assertEquals(length, loc.getByteBank().getMaxPos());
+
+		final byte[] expectedDigits = new byte[digits.length];
+		System.arraycopy(digits, offset, expectedDigits, 0, length);
+		assertArrayEquals(expectedDigits, testDigits);
 	}
 
 }
