Deprecate for BufferedImageInputStream, now using buffered streams directly in all readers.

2026-03-20 00:00:03 -04:00 · 2021-01-11 22:07:31 +01:00
parent 8a1a90dafd
commit ebaa69713f
18 changed files with 944 additions and 105 deletions
--- a/imageio/imageio-core/src/test/java/com/twelvemonkeys/imageio/stream/BufferedFileImageInputStreamSpiTest.java
+++ b/imageio/imageio-core/src/test/java/com/twelvemonkeys/imageio/stream/BufferedFileImageInputStreamSpiTest.java
@@ -0,0 +1,17 @@
+package com.twelvemonkeys.imageio.stream;
+
+import javax.imageio.spi.ImageInputStreamSpi;
+import java.io.File;
+import java.io.IOException;
+
+public class BufferedFileImageInputStreamSpiTest extends ImageInputStreamSpiTest<File> {
+    @Override
+    protected ImageInputStreamSpi createProvider() {
+        return new BufferedFileImageInputStreamSpi();
+    }
+
+    @Override
+    protected File createInput() throws IOException {
+        return File.createTempFile("test-", ".tst");
+    }
+}
--- a/imageio/imageio-core/src/test/java/com/twelvemonkeys/imageio/stream/BufferedFileImageInputStreamTest.java
+++ b/imageio/imageio-core/src/test/java/com/twelvemonkeys/imageio/stream/BufferedFileImageInputStreamTest.java
@@ -0,0 +1,386 @@
+/*
+ * Copyright (c) 2020, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.imageio.stream;
+
+import org.junit.Test;
+import org.junit.function.ThrowingRunnable;
+
+import javax.imageio.stream.ImageInputStream;
+import java.io.EOFException;
+import java.io.File;
+import java.io.IOException;
+import java.io.RandomAccessFile;
+import java.nio.ByteBuffer;
+import java.nio.ByteOrder;
+import java.nio.file.Files;
+import java.util.Random;
+
+import static com.twelvemonkeys.imageio.stream.BufferedImageInputStreamTest.rangeEquals;
+import static org.junit.Assert.*;
+import static org.mockito.Mockito.*;
+
+/**
+ * BufferedFileImageInputStreamTestCase
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @author last modified by $Author: haraldk$
+ * @version $Id: BufferedFileImageInputStreamTestCase.java,v 1.0 Apr 21, 2009 10:58:48 AM haraldk Exp$
+ */
+public class BufferedFileImageInputStreamTest {
+    private final Random random = new Random(170984354357234566L);
+
+    private File randomDataToFile(byte[] data) throws IOException {
+        random.nextBytes(data);
+
+        File file = File.createTempFile("read", ".tmp");
+        Files.write(file.toPath(), data);
+        return file;
+    }
+
+    @Test
+    public void testCreate() throws IOException {
+        BufferedFileImageInputStream stream = new BufferedFileImageInputStream(File.createTempFile("empty", ".tmp"));
+        assertEquals("Data length should be same as stream length", 0, stream.length());
+    }
+
+    @Test
+    public void testCreateNullFile() throws IOException {
+        try {
+            new BufferedFileImageInputStream((File) null);
+            fail("Expected IllegalArgumentException");
+        }
+        catch (IllegalArgumentException expected) {
+            assertNotNull("Null exception message", expected.getMessage());
+            String message = expected.getMessage().toLowerCase();
+            assertTrue("Exception message does not contain parameter name", message.contains("file"));
+            assertTrue("Exception message does not contain null", message.contains("null"));
+        }
+    }
+
+    @Test
+    public void testCreateNullRAF() {
+        try {
+            new BufferedFileImageInputStream((RandomAccessFile) null);
+            fail("Expected IllegalArgumentException");
+        }
+        catch (IllegalArgumentException expected) {
+            assertNotNull("Null exception message", expected.getMessage());
+            String message = expected.getMessage().toLowerCase();
+            assertTrue("Exception message does not contain parameter name", message.contains("raf"));
+            assertTrue("Exception message does not contain null", message.contains("null"));
+        }
+    }
+
+    @Test
+    public void testRead() throws IOException {
+        byte[] data = new byte[1024 * 1024];
+        File file = randomDataToFile(data);
+
+        BufferedFileImageInputStream stream = new BufferedFileImageInputStream(file);
+
+        assertEquals("File length should be same as stream length", file.length(), stream.length());
+
+        for (byte value : data) {
+            assertEquals("Wrong data read", value & 0xff, stream.read());
+        }
+    }
+
+    @Test
+    public void testReadArray() throws IOException {
+        byte[] data = new byte[1024 * 1024];
+        File file = randomDataToFile(data);
+
+        BufferedFileImageInputStream stream = new BufferedFileImageInputStream(file);
+
+        assertEquals("File length should be same as stream length", file.length(), stream.length());
+
+        byte[] result = new byte[1024];
+
+        for (int i = 0; i < data.length / result.length; i++) {
+            stream.readFully(result);
+            assertTrue("Wrong data read: " + i, rangeEquals(data, i * result.length, result, 0, result.length));
+        }
+    }
+
+    @Test
+    public void testReadSkip() throws IOException {
+        byte[] data = new byte[1024 * 14];
+        File file = randomDataToFile(data);
+
+        BufferedFileImageInputStream stream = new BufferedFileImageInputStream(file);
+
+        assertEquals("File length should be same as stream length", file.length(), stream.length());
+
+        byte[] result = new byte[7];
+
+        for (int i = 0; i < data.length / result.length; i += 2) {
+            stream.readFully(result);
+            stream.skipBytes(result.length);
+            assertTrue("Wrong data read: " + i, rangeEquals(data, i * result.length, result, 0, result.length));
+        }
+    }
+
+    @Test
+    public void testReadSeek() throws IOException {
+        byte[] data = new byte[1024 * 18];
+        File file = randomDataToFile(data);
+
+        BufferedFileImageInputStream stream = new BufferedFileImageInputStream(file);
+
+        assertEquals("File length should be same as stream length", file.length(), stream.length());
+
+        byte[] result = new byte[9];
+
+        for (int i = 0; i < data.length / result.length; i++) {
+            // Read backwards
+            long newPos = stream.length() - result.length - i * result.length;
+            stream.seek(newPos);
+            assertEquals("Wrong stream position", newPos, stream.getStreamPosition());
+            stream.readFully(result);
+            assertTrue("Wrong data read: " + i, rangeEquals(data, (int) newPos, result, 0, result.length));
+        }
+    }
+
+    @Test
+    public void testReadBitRandom() throws IOException {
+        byte[] bytes = new byte[8];
+        File file = randomDataToFile(bytes);
+        long value = ByteBuffer.wrap(bytes).getLong();
+
+        // Create stream
+        ImageInputStream stream = new BufferedFileImageInputStream(file);
+
+        for (int i = 1; i <= 64; i++) {
+            assertEquals(String.format("bit %d differ", i), (value << (i - 1L)) >>> 63L, stream.readBit());
+        }
+    }
+
+    @Test
+    public void testReadBitsRandom() throws IOException {
+        byte[] bytes = new byte[8];
+        File file = randomDataToFile(bytes);
+        long value = ByteBuffer.wrap(bytes).getLong();
+
+        // Create stream
+        ImageInputStream stream = new BufferedFileImageInputStream(file);
+
+        for (int i = 1; i <= 64; i++) {
+            stream.seek(0);
+            assertEquals(String.format("bit %d differ", i), value >>> (64L - i), stream.readBits(i));
+            assertEquals(i % 8, stream.getBitOffset());
+        }
+    }
+
+    @Test
+    public void testReadBitsRandomOffset() throws IOException {
+        byte[] bytes = new byte[8];
+        File file = randomDataToFile(bytes);
+        long value = ByteBuffer.wrap(bytes).getLong();
+
+        // Create stream
+        ImageInputStream stream = new BufferedFileImageInputStream(file);
+
+        for (int i = 1; i <= 60; i++) {
+            stream.seek(0);
+            stream.setBitOffset(i % 8);
+            assertEquals(String.format("bit %d differ", i), (value << (i % 8)) >>> (64L - i), stream.readBits(i));
+            assertEquals(i * 2 % 8, stream.getBitOffset());
+        }
+    }
+
+    @Test
+    public void testReadShort() throws IOException {
+        byte[] bytes = new byte[8743]; // Slightly more than one buffer size
+        File file = randomDataToFile(bytes);
+        ByteBuffer buffer = ByteBuffer.wrap(bytes).order(ByteOrder.BIG_ENDIAN);
+        final ImageInputStream stream = new BufferedFileImageInputStream(file);
+        stream.setByteOrder(ByteOrder.BIG_ENDIAN);
+
+        for (int i = 0; i < bytes.length / 2; i++) {
+            assertEquals(buffer.getShort(), stream.readShort());
+        }
+
+        assertThrows(EOFException.class, new ThrowingRunnable() {
+            @Override
+            public void run() throws Throwable {
+                stream.readShort();
+            }
+        });
+
+        stream.seek(0);
+        stream.setByteOrder(ByteOrder.LITTLE_ENDIAN);
+        buffer.position(0);
+        buffer.order(ByteOrder.LITTLE_ENDIAN);
+
+        for (int i = 0; i < bytes.length / 2; i++) {
+            assertEquals(buffer.getShort(), stream.readShort());
+        }
+
+        assertThrows(EOFException.class, new ThrowingRunnable() {
+            @Override
+            public void run() throws Throwable {
+                stream.readShort();
+            }
+        });
+    }
+
+    @Test
+    public void testReadInt() throws IOException {
+        byte[] bytes = new byte[8743]; // Slightly more than one buffer size
+        File file = randomDataToFile(bytes);
+        ByteBuffer buffer = ByteBuffer.wrap(bytes).order(ByteOrder.BIG_ENDIAN);
+        final ImageInputStream stream = new BufferedFileImageInputStream(file);
+        stream.setByteOrder(ByteOrder.BIG_ENDIAN);
+
+        for (int i = 0; i < bytes.length / 4; i++) {
+            assertEquals(buffer.getInt(), stream.readInt());
+        }
+
+        assertThrows(EOFException.class, new ThrowingRunnable() {
+            @Override
+            public void run() throws Throwable {
+                stream.readInt();
+            }
+        });
+
+        stream.seek(0);
+        stream.setByteOrder(ByteOrder.LITTLE_ENDIAN);
+        buffer.position(0);
+        buffer.order(ByteOrder.LITTLE_ENDIAN);
+
+        for (int i = 0; i < bytes.length / 4; i++) {
+            assertEquals(buffer.getInt(), stream.readInt());
+        }
+
+        assertThrows(EOFException.class, new ThrowingRunnable() {
+            @Override
+            public void run() throws Throwable {
+                stream.readInt();
+            }
+        });
+    }
+
+    @Test
+    public void testReadLong() throws IOException {
+        byte[] bytes = new byte[8743]; // Slightly more than one buffer size
+        File file = randomDataToFile(bytes);
+        ByteBuffer buffer = ByteBuffer.wrap(bytes).order(ByteOrder.BIG_ENDIAN);
+        final ImageInputStream stream = new BufferedFileImageInputStream(file);
+        stream.setByteOrder(ByteOrder.BIG_ENDIAN);
+
+        for (int i = 0; i < bytes.length / 8; i++) {
+            assertEquals(buffer.getLong(), stream.readLong());
+        }
+
+        assertThrows(EOFException.class, new ThrowingRunnable() {
+            @Override
+            public void run() throws Throwable {
+                stream.readLong();
+            }
+        });
+
+        stream.seek(0);
+        stream.setByteOrder(ByteOrder.LITTLE_ENDIAN);
+        buffer.position(0);
+        buffer.order(ByteOrder.LITTLE_ENDIAN);
+
+        for (int i = 0; i < bytes.length / 8; i++) {
+            assertEquals(buffer.getLong(), stream.readLong());
+        }
+
+        assertThrows(EOFException.class, new ThrowingRunnable() {
+            @Override
+            public void run() throws Throwable {
+                stream.readLong();
+            }
+        });
+    }
+
+    @Test
+    public void testSeekPastEOF() throws IOException {
+        byte[] bytes = new byte[9];
+        File file = randomDataToFile(bytes);
+
+        final ImageInputStream stream = new BufferedFileImageInputStream(file);
+        stream.seek(1000);
+
+        assertEquals(-1, stream.read());
+        assertEquals(-1, stream.read(new byte[1], 0, 1));
+
+        assertThrows(EOFException.class, new ThrowingRunnable() {
+            @Override
+            public void run() throws Throwable {
+                stream.readFully(new byte[1]);
+            }
+        });
+        assertThrows(EOFException.class, new ThrowingRunnable() {
+            @Override
+            public void run() throws Throwable {
+                stream.readByte();
+            }
+        });
+        assertThrows(EOFException.class, new ThrowingRunnable() {
+            @Override
+            public void run() throws Throwable {
+                stream.readShort();
+            }
+        });
+        assertThrows(EOFException.class, new ThrowingRunnable() {
+            @Override
+            public void run() throws Throwable {
+                stream.readInt();
+            }
+        });
+        assertThrows(EOFException.class, new ThrowingRunnable() {
+            @Override
+            public void run() throws Throwable {
+                stream.readLong();
+            }
+        });
+
+        stream.seek(0);
+        for (byte value : bytes) {
+            assertEquals(value, stream.readByte());
+        }
+
+        assertEquals(-1, stream.read());
+    }
+
+    @Test
+    public void testClose() throws IOException {
+        // Create wrapper stream
+        RandomAccessFile mock = mock(RandomAccessFile.class);
+        ImageInputStream stream = new BufferedFileImageInputStream(mock);
+
+        stream.close();
+        verify(mock, only()).close();
+    }
+}
--- a/imageio/imageio-core/src/test/java/com/twelvemonkeys/imageio/stream/BufferedRAFImageInputStreamSpiTest.java
+++ b/imageio/imageio-core/src/test/java/com/twelvemonkeys/imageio/stream/BufferedRAFImageInputStreamSpiTest.java
@@ -0,0 +1,18 @@
+package com.twelvemonkeys.imageio.stream;
+
+import javax.imageio.spi.ImageInputStreamSpi;
+import java.io.File;
+import java.io.IOException;
+import java.io.RandomAccessFile;
+
+public class BufferedRAFImageInputStreamSpiTest extends ImageInputStreamSpiTest<RandomAccessFile> {
+    @Override
+    protected ImageInputStreamSpi createProvider() {
+        return new BufferedRAFImageInputStreamSpi();
+    }
+
+    @Override
+    protected RandomAccessFile createInput() throws IOException {
+        return new RandomAccessFile(File.createTempFile("test-", ".tst"), "r");
+    }
+}
--- a/imageio/imageio-core/src/test/java/com/twelvemonkeys/imageio/stream/ByteArrayImageInputStreamTest.java
+++ b/imageio/imageio-core/src/test/java/com/twelvemonkeys/imageio/stream/ByteArrayImageInputStreamTest.java
@@ -39,11 +39,11 @@ import static com.twelvemonkeys.imageio.stream.BufferedImageInputStreamTest.rang
 import static org.junit.Assert.*;

 /**
- * ByteArrayImageInputStreamTestCase
+ * ByteArrayImageInputStreamTest
 *
 * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
 * @author last modified by $Author: haraldk$
- * @version $Id: ByteArrayImageInputStreamTestCase.java,v 1.0 Apr 21, 2009 10:58:48 AM haraldk Exp$
+ * @version $Id: ByteArrayImageInputStreamTest.java,v 1.0 Apr 21, 2009 10:58:48 AM haraldk Exp$
 */
 public class ByteArrayImageInputStreamTest {
    private final Random random = new Random(1709843507234566L);
--- a/imageio/imageio-core/src/test/java/com/twelvemonkeys/imageio/stream/ImageInputStreamSpiTest.java
+++ b/imageio/imageio-core/src/test/java/com/twelvemonkeys/imageio/stream/ImageInputStreamSpiTest.java
@@ -18,7 +18,7 @@ abstract class ImageInputStreamSpiTest<T> {

    protected abstract ImageInputStreamSpi createProvider();

-    protected abstract T createInput();
+    protected abstract T createInput() throws IOException;

    @Test
    public void testInputClass() {