javax.imageio Documentation Differences

This file contains all the changes in documentation in the package javax.imageio as colored differences. Deletions are shown like this, and additions are shown like this.

If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.

Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a <code> tag will cause all subsequent paragraphs to be displayed differently.

Allows any resources held by this object to be released. The result of calling any other method (other than finalize) subsequent to a call to this method is undefined.

It is important for applications to call this method when they know they will no longer be using this ImageReader. Otherwise the reader may continue to hold on to resources indefinitely.

The default implementation of this method in the superclass does nothing. Subclass implementations should ensure that all resources especially native resources are released.

Sets the compression quality to a value between 0 and 1. Only a single compression quality setting is supported by default; writers can provide extended versions of ImageWriteParam that offer more control. For lossy compression schemes the compression quality should control the tradeoff between file size and image quality (for example by choosing quantization tables when writing JPEG images). For lossless schemes the compression quality may be used to control the tradeoff between file size and time taken to perform the compression (for example by optimizing row filters and setting the ZLIB compression level when writing PNG images).

A compression quality setting of 0.0 is most generically interpreted as "high compression is important " while a setting of 1.0 is most generically interpreted as "high image quality is important."

If there are multiple compression types but none has been set an IllegalStateException is thrown.

The default implementation checks that compression is supported and that the compression mode is MODE_EXPLICIT. If so if getCompressionTypes() returns null or compressionType is non-null it sets the compressionQuality instance variable. @param quality a float between 0and 1 indicating the desired quality level. @exception UnsupportedOperationException if the writer does not support compression. @exception IllegalStateException if the compression mode is not MODE_EXPLICIT. @exception IllegalStateException if the set of legal compression types is non-null and the current compression type is null. @exception IllegalArgumentException if quality is not between 0and 1 inclusive. @see #getCompressionQuality

Allows any resources held by this object to be released. The result of calling any other method (other than finalize) subsequent to a call to this method is undefined.

It is important for applications to call this method when they know they will no longer be using this ImageWriter. Otherwise the writer may continue to hold on to resources indefinitely.

The default implementation of this method in the superclass does nothing. Subclass implementations should ensure that all resources especially native resources are released.