From 18b86f8d26454c50f3b9b433583d86529dce56bc Mon Sep 17 00:00:00 2001 From: Harald Kuhr Date: Sun, 1 Nov 2009 17:03:06 +0100 Subject: [PATCH] Added documentation and fixed typos. --- .../imageio/ImageReaderBase.java | 18 ++++++------- .../imageio/ImageWriterBase.java | 25 +++++++++++-------- 2 files changed, 22 insertions(+), 21 deletions(-) diff --git a/twelvemonkeys-imageio/core/src/main/java/com/twelvemonkeys/imageio/ImageReaderBase.java b/twelvemonkeys-imageio/core/src/main/java/com/twelvemonkeys/imageio/ImageReaderBase.java index 6115e818..ee4d76c9 100644 --- a/twelvemonkeys-imageio/core/src/main/java/com/twelvemonkeys/imageio/ImageReaderBase.java +++ b/twelvemonkeys-imageio/core/src/main/java/com/twelvemonkeys/imageio/ImageReaderBase.java @@ -72,11 +72,10 @@ public abstract class ImageReaderBase extends ImageReader { * the extension object is unsuitable, an * {@code IllegalArgumentException} should be thrown. * - * @param pOriginatingProvider the {@code ImageReaderSpi} that is - * invoking this constructor, or {@code null}. + * @param pProvider the {@code ImageReaderSpi} that is invoking this constructor, or {@code null}. */ - protected ImageReaderBase(final ImageReaderSpi pOriginatingProvider) { - super(pOriginatingProvider); + protected ImageReaderBase(final ImageReaderSpi pProvider) { + super(pProvider); } /** @@ -98,7 +97,7 @@ public abstract class ImageReaderBase extends ImageReader { * @see ImageInputStream */ @Override - public void setInput(Object pInput, boolean pSeekForwardOnly, boolean pIgnoreMetadata) { + public void setInput(final Object pInput, final boolean pSeekForwardOnly, final boolean pIgnoreMetadata) { resetMembers(); super.setInput(pInput, pSeekForwardOnly, pIgnoreMetadata); if (pInput instanceof ImageInputStream) { @@ -168,8 +167,7 @@ public abstract class ImageReaderBase extends ImageReader { * @param pIndex the image index * * @throws java.io.IOException if an error occurs during reading - * @throws IndexOutOfBoundsException if not - * minIndex <= pIndex < numImages + * @throws IndexOutOfBoundsException if not {@code minIndex <= pIndex < numImages} */ protected void checkBounds(int pIndex) throws IOException { assertInput(); @@ -217,10 +215,8 @@ public abstract class ImageReaderBase extends ImageReader { * @throws IllegalArgumentException if {@code pTypes} * is {@code null} or empty, or if an object not of type * {@code ImageTypeSpecifier} is retrieved from it. - * Or, if the resulting image would - * have a width or height less than 1, - * or if the product of - * {@code pWidth} and {@code pHeight} is greater than + * Or, if the resulting image would have a width or height less than 1, + * or if the product of {@code pWidth} and {@code pHeight} is greater than * {@code Integer.MAX_VALUE}. */ public static BufferedImage getDestination(final ImageReadParam pParam, final Iterator pTypes, diff --git a/twelvemonkeys-imageio/core/src/main/java/com/twelvemonkeys/imageio/ImageWriterBase.java b/twelvemonkeys-imageio/core/src/main/java/com/twelvemonkeys/imageio/ImageWriterBase.java index b54bf5ed..8c60c2d2 100755 --- a/twelvemonkeys-imageio/core/src/main/java/com/twelvemonkeys/imageio/ImageWriterBase.java +++ b/twelvemonkeys-imageio/core/src/main/java/com/twelvemonkeys/imageio/ImageWriterBase.java @@ -47,6 +47,11 @@ import java.io.IOException; * @version $Id: ImageWriterBase.java,v 1.0 Sep 24, 2007 12:22:28 AM haraldk Exp$ */ public abstract class ImageWriterBase extends ImageWriter { + + /** + * For convenience. Only set if the output is an {@code ImageInputStream}. + * @see #setOutput(Object) + */ protected ImageOutputStream mImageOutput; /** @@ -60,8 +65,7 @@ public abstract class ImageWriterBase extends ImageWriter { * the extension object is unsuitable, an * {@code IllegalArgumentException} should be thrown. * - * @param pProvider the {@code ImageWriterSpi} that - * is constructing this object, or {@code null}. + * @param pProvider the {@code ImageWriterSpi} that is constructing this object, or {@code null}. */ protected ImageWriterBase(final ImageWriterSpi pProvider) { super(pProvider); @@ -72,8 +76,9 @@ public abstract class ImageWriterBase extends ImageWriter { } @Override - public void setOutput(Object pOutput) { + public void setOutput(final Object pOutput) { super.setOutput(pOutput); + if (pOutput instanceof ImageOutputStream) { mImageOutput = (ImageOutputStream) pOutput; } @@ -93,10 +98,10 @@ public abstract class ImageWriterBase extends ImageWriter { /** * Returns {@code null} * - * @param pParam igonred. + * @param pParam ignored. * @return {@code null}. */ - public IIOMetadata getDefaultStreamMetadata(ImageWriteParam pParam) { + public IIOMetadata getDefaultStreamMetadata(final ImageWriteParam pParam) { return null; } @@ -104,14 +109,14 @@ public abstract class ImageWriterBase extends ImageWriter { * Returns {@code null} * * @param pInData ignored. - * @param pParam igonred. + * @param pParam ignored. * @return {@code null}. */ - public IIOMetadata convertStreamMetadata(IIOMetadata pInData, ImageWriteParam pParam) { + public IIOMetadata convertStreamMetadata(final IIOMetadata pInData, final ImageWriteParam pParam) { return null; } - protected static Rectangle getSourceRegion(ImageWriteParam pParam, int pWidth, int pHeight) { + protected static Rectangle getSourceRegion(final ImageWriteParam pParam, final int pWidth, final int pHeight) { return IIOUtil.getSourceRegion(pParam, pWidth, pHeight); } @@ -130,7 +135,7 @@ public abstract class ImageWriterBase extends ImageWriter { * region), or the original image, if no source region was set, or * {@code pParam} was {@code null} */ - protected static BufferedImage fakeAOI(BufferedImage pImage, ImageWriteParam pParam) { + protected static BufferedImage fakeAOI(final BufferedImage pImage, final ImageWriteParam pParam) { return IIOUtil.fakeAOI(pImage, getSourceRegion(pParam, pImage.getWidth(), pImage.getHeight())); } @@ -153,7 +158,7 @@ public abstract class ImageWriterBase extends ImageWriter { * original image, if no subsampling was specified, or * {@code pParam} was {@code null} */ - protected static Image fakeSubsampling(Image pImage, ImageWriteParam pParam) { + protected static Image fakeSubsampling(final Image pImage, final ImageWriteParam pParam) { return IIOUtil.fakeSubsampling(pImage, pParam); } } \ No newline at end of file