From aa68a4018c5e9c452f54e1a3650598e1ef30713e Mon Sep 17 00:00:00 2001 From: Harald Kuhr Date: Sun, 4 Oct 2009 17:33:36 +0200 Subject: [PATCH] Doc update. --- .../imageio/stream/BufferedImageInputStream.java | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/twelvemonkeys-imageio/core/src/main/java/com/twelvemonkeys/imageio/stream/BufferedImageInputStream.java b/twelvemonkeys-imageio/core/src/main/java/com/twelvemonkeys/imageio/stream/BufferedImageInputStream.java index 0b958056..a3ca35b5 100644 --- a/twelvemonkeys-imageio/core/src/main/java/com/twelvemonkeys/imageio/stream/BufferedImageInputStream.java +++ b/twelvemonkeys-imageio/core/src/main/java/com/twelvemonkeys/imageio/stream/BufferedImageInputStream.java @@ -7,14 +7,18 @@ import javax.imageio.stream.ImageInputStreamImpl; import java.io.IOException; /** - * BufferedFileImageInputStream - * Experimental - seems to be effective for FileImageInputStream and FileCacheImageInputStream. + * A buffered {@code ImageInputStream}. + * Experimental - seems to be effective for {@link javax.imageio.stream.FileImageInputStream} + * and {@link javax.imageio.stream.FileCacheImageInputStream} when doing a lot of single-byte reads + * (or short byte-array reads) on OS X at least. + * Code that uses the {@code readFully} methods are not affected by the issue. * * @author Harald Kuhr * @author last modified by $Author: haraldk$ * @version $Id: BufferedFileImageInputStream.java,v 1.0 May 15, 2008 4:36:49 PM haraldk Exp$ */ // TODO: Create a provider for this (wrapping the FileIIS and FileCacheIIS classes), and disable the Sun built-in spis? +// TODO: Test on other platforms, might be just an OS X issue public final class BufferedImageInputStream extends ImageInputStreamImpl implements ImageInputStream { static final int DEFAULT_BUFFER_SIZE = 8192;