Backups/TwelveMonkeys
2
0
Fork 0
mirror of https://github.com/haraldk/TwelveMonkeys.git synced 2025-08-05 04:25:29 -04:00
Code Issues Projects Releases Wiki Activity

Added documentation and fixed typos.

Browse Source
This commit is contained in:
Harald Kuhr 2009-11-01 16:56:53 +01:00
parent f49a487c88
commit 82fdde897d
3 changed files with 21 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
twelvemonkeys-imageio/core/src/main/java/com/twelvemonkeys/imageio/ImageReaderBase.java
View File

@ -48,13 +48,14 @@ import java.util.Arrays;
import java.util.Iterator; import java.util.Iterator;
/** /**
* ImageReaderBase * Abstract base class for image readers.
* *
* @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a> * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
* @author last modified by $Author: haraldk$ * @author last modified by $Author: haraldk$
* @version $Id: ImageReaderBase.java,v 1.0 Sep 20, 2007 5:28:37 PM haraldk Exp$ * @version $Id: ImageReaderBase.java,v 1.0 Sep 20, 2007 5:28:37 PM haraldk Exp$
*/ */
public abstract class ImageReaderBase extends ImageReader { public abstract class ImageReaderBase extends ImageReader {
/** /**
* For convenience. Only set if the input is an {@code ImageInputStream}. * For convenience. Only set if the input is an {@code ImageInputStream}.
* @see #setInput(Object, boolean, boolean) * @see #setInput(Object, boolean, boolean)
@ -129,21 +130,21 @@ public abstract class ImageReaderBase extends ImageReader {
protected abstract void resetMembers(); protected abstract void resetMembers();
/** /**
* Defaul implementation that always return {@code null}. * Default implementation that always returns {@code null}.
* *
* @param pImageIndex ignored, unless overriden * @param pImageIndex ignored, unless overridden
* @return {@code null}, unless overriden * @return {@code null}, unless overridden
* @throws IOException never, unless overriden. * @throws IOException never, unless overridden.
*/ */
public IIOMetadata getImageMetadata(int pImageIndex) throws IOException { public IIOMetadata getImageMetadata(int pImageIndex) throws IOException {
return null; return null;
} }
/** /**
* Defaul implementation that always return {@code null}. * Default implementation that always returns {@code null}.
* *
* @return {@code null}, unless overriden * @return {@code null}, unless overridden
* @throws IOException never, unless overriden. * @throws IOException never, unless overridden.
*/ */
public IIOMetadata getStreamMetadata() throws IOException { public IIOMetadata getStreamMetadata() throws IOException {
return null; return null;
@ -152,9 +153,9 @@ public abstract class ImageReaderBase extends ImageReader {
/** /**
* Default implementation that always returns {@code 1}. * Default implementation that always returns {@code 1}.
* *
* @param pAllowSearch ignored, unless overriden * @param pAllowSearch ignored, unless overridden
* @return {@code 1}, unless overriden * @return {@code 1}, unless overridden
* @throws IOException never, unless overriden * @throws IOException never, unless overridden
*/ */
public int getNumImages(boolean pAllowSearch) throws IOException { public int getNumImages(boolean pAllowSearch) throws IOException {
assertInput(); assertInput();

11
twelvemonkeys-imageio/core/src/main/java/com/twelvemonkeys/imageio/ImageWriterBase.java
View File

@ -31,6 +31,7 @@ package com.twelvemonkeys.imageio;
import com.twelvemonkeys.imageio.util.IIOUtil; import com.twelvemonkeys.imageio.util.IIOUtil;
import javax.imageio.ImageWriteParam; import javax.imageio.ImageWriteParam;
import javax.imageio.ImageWriter;
import javax.imageio.metadata.IIOMetadata; import javax.imageio.metadata.IIOMetadata;
import javax.imageio.spi.ImageWriterSpi; import javax.imageio.spi.ImageWriterSpi;
import javax.imageio.stream.ImageOutputStream; import javax.imageio.stream.ImageOutputStream;
@ -39,13 +40,13 @@ import java.awt.image.BufferedImage;
import java.io.IOException; import java.io.IOException;
/** /**
* ImageWriterBase * Abstract base class for image writers.
* *
* @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a> * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
* @author last modified by $Author: haraldk$ * @author last modified by $Author: haraldk$
* @version $Id: ImageWriterBase.java,v 1.0 Sep 24, 2007 12:22:28 AM haraldk Exp$ * @version $Id: ImageWriterBase.java,v 1.0 Sep 24, 2007 12:22:28 AM haraldk Exp$
*/ */
public abstract class ImageWriterBase extends javax.imageio.ImageWriter { public abstract class ImageWriterBase extends ImageWriter {
protected ImageOutputStream mImageOutput; protected ImageOutputStream mImageOutput;
/** /**
@ -95,7 +96,7 @@ public abstract class ImageWriterBase extends javax.imageio.ImageWriter {
* @param pParam igonred. * @param pParam igonred.
* @return {@code null}. * @return {@code null}.
*/ */
public IIOMetadata getDefaultStreamMetadata(javax.imageio.ImageWriteParam pParam) { public IIOMetadata getDefaultStreamMetadata(ImageWriteParam pParam) {
return null; return null;
} }
@ -116,7 +117,7 @@ public abstract class ImageWriterBase extends javax.imageio.ImageWriter {
/** /**
* Utility method for getting the area of interest (AOI) of an image. * Utility method for getting the area of interest (AOI) of an image.
* The AOI is defined by the {@link IIOParam#setSourceRegion(java.awt.Rectangle)} * The AOI is defined by the {@link javax.imageio.IIOParam#setSourceRegion(java.awt.Rectangle)}
* method. * method.
* <p/> * <p/>
* Note: If it is possible for the reader to read the AOI directly, such a * Note: If it is possible for the reader to read the AOI directly, such a
@ -136,7 +137,7 @@ public abstract class ImageWriterBase extends javax.imageio.ImageWriter {
/** /**
* Utility method for getting the subsampled image. * Utility method for getting the subsampled image.
* The subsampling is defined by the * The subsampling is defined by the
* {@link IIOParam#setSourceSubsampling(int, int, int, int)} * {@link javax.imageio.IIOParam#setSourceSubsampling(int, int, int, int)}
* method. * method.
* <p/> * <p/>
* NOTE: This method does not take the subsampling offsets into * NOTE: This method does not take the subsampling offsets into

3
twelvemonkeys-imageio/core/src/main/java/com/twelvemonkeys/imageio/spi/ProviderInfo.java
View File

@ -13,6 +13,9 @@ import com.twelvemonkeys.lang.Validate;
* @see <a href="http://java.sun.com/j2se/1.5.0/docs/guide/jar/jar.html#JAR%20Manifest">JAR Manifest</a> * @see <a href="http://java.sun.com/j2se/1.5.0/docs/guide/jar/jar.html#JAR%20Manifest">JAR Manifest</a>
*/ */
public class ProviderInfo { public class ProviderInfo {
// TODO: Consider reading the META-INF/MANIFEST.MF from the class path using java.util.jar.Manifest.
// Use the manifest that is located in the same class path folder as the package.
private final String mVendorName; private final String mVendorName;
private final String mVersion; private final String mVersion;