stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8022455: Fix doclint warnings in javax.imageio

Browse Source 
Reviewed-by: darcy
This commit is contained in:
Phil Race 2013-08-06 17:11:29 -07:00
parent d75477b147
commit f211cb81b9
16 changed files with 101 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
jdk/src/share/classes/javax/imageio/ImageIO.java
View File

@ -228,7 +228,7 @@ public final class ImageIO {
* be used when creating <code>ImageInputStream</code>s and
* <code>ImageOutputStream</code>s.
*
* <p> When reading from a standard <code>InputStream</code>>, it
* <p> When reading from a standard <code>InputStream</code>, it
* may be necessary to save previously read information in a cache
* since the underlying stream does not allow data to be re-read.
* Similarly, when writing to a standard

2
jdk/src/share/classes/javax/imageio/ImageReadParam.java
View File

@ -80,7 +80,7 @@ import java.awt.image.BufferedImage;
*
* <p> The resulting region is then subsampled according to the
* factors given in {@link IIOParam#setSourceSubsampling
* <code>IIOParam.setSourceSubsampling</code>}. The first pixel,
* IIOParam.setSourceSubsampling}. The first pixel,
* the number of pixels per row, and the number of rows all depend
* on the subsampling settings.
* Call the minimum X and Y coordinates of the resulting rectangle

40
jdk/src/share/classes/javax/imageio/ImageReader.java
View File

@ -230,8 +230,8 @@ public abstract class ImageReader {
* increased as each image (or thumbnail, or image metadata) is
* read. If <code>seekForwardOnly</code> is true, then a call to
* <code>read(index)</code> will throw an
* <code>IndexOutOfBoundsException</code> if <code>index &lt
* this.minIndex</code>; otherwise, the value of
* <code>IndexOutOfBoundsException</code> if {@code index < this.minIndex};
* otherwise, the value of
* <code>minIndex</code> will be set to <code>index</code>. If
* <code>seekForwardOnly</code> is <code>false</code>, the value of
* <code>minIndex</code> will remain 0 regardless of any read
@ -328,8 +328,8 @@ public abstract class ImageReader {
* increased as each image (or thumbnail, or image metadata) is
* read. If <code>seekForwardOnly</code> is true, then a call to
* <code>read(index)</code> will throw an
* <code>IndexOutOfBoundsException</code> if <code>index &lt
* this.minIndex</code>; otherwise, the value of
* <code>IndexOutOfBoundsException</code> if {@code index < this.minIndex};
* otherwise, the value of
* <code>minIndex</code> will be set to <code>index</code>. If
* <code>seekForwardOnly</code> is <code>false</code>, the value of
* <code>minIndex</code> will remain 0 regardless of any read
@ -600,8 +600,7 @@ public abstract class ImageReader {
* <p> Note that formats that return <code>false</code> from
* this method may nonetheless allow tiling (<i>e.g.</i> Restart
* Markers in JPEG), and random access will likely be reasonably
* efficient on tiles. See {@link #isImageTiled
* <code>isImageTiled</code>}.
* efficient on tiles. See {@link #isImageTiled isImageTiled}.
*
* <p> A reader for which all images are guaranteed to support
* easy random access, or are guaranteed not to support easy
@ -1212,11 +1211,10 @@ public abstract class ImageReader {
/**
* Returns <code>true</code> if this plug-in supports reading
* just a {@link java.awt.image.Raster <code>Raster</code>} of pixel data.
* just a {@link java.awt.image.Raster Raster} of pixel data.
* If this method returns <code>false</code>, calls to
* {@link #readRaster <code>readRaster</code>} or {@link #readTileRaster
* <code>readTileRaster</code>} will throw an
* <code>UnsupportedOperationException</code>.
* {@link #readRaster readRaster} or {@link #readTileRaster readTileRaster}
* will throw an <code>UnsupportedOperationException</code>.
*
* <p> The default implementation returns <code>false</code>.
*
@ -1236,7 +1234,7 @@ public abstract class ImageReader {
* application must determine how to interpret the pixel data by other
* means. Any destination or image-type parameters in the supplied
* <code>ImageReadParam</code> object are ignored, but all other
* parameters are used exactly as in the {@link #read <code>read</code>}
* parameters are used exactly as in the {@link #read read}
* method, except that any destination offset is used as a logical rather
* than a physical offset. The size of the returned <code>Raster</code>
* will always be that of the source region clipped to the actual image.
@ -1249,10 +1247,9 @@ public abstract class ImageReader {
*
* <p> Any registered <code>readUpdateListener</code>s are ignored, as
* there is no <code>BufferedImage</code>, but all other listeners are
* called exactly as they are for the {@link #read <code>read</code>}
* method.
* called exactly as they are for the {@link #read read} method.
*
* <p> If {@link #canReadRaster <code>canReadRaster()</code>} returns
* <p> If {@link #canReadRaster canReadRaster()} returns
* <code>false</code>, this method throws an
* <code>UnsupportedOperationException</code>.
*
@ -1481,13 +1478,13 @@ public abstract class ImageReader {
* The application must determine how to interpret the pixel data by other
* means.
*
* <p> If {@link #canReadRaster <code>canReadRaster()</code>} returns
* <p> If {@link #canReadRaster canReadRaster()} returns
* <code>false</code>, this method throws an
* <code>UnsupportedOperationException</code>.
*
* <p> The default implementation checks if reading
* <code>Raster</code>s is supported, and if so calls {@link
* #readRaster <code>readRaster(imageIndex, null)</code>} if
* #readRaster readRaster(imageIndex, null)} if
* <code>tileX</code> and <code>tileY</code> are 0, or throws an
* <code>IllegalArgumentException</code> otherwise.
*
@ -1548,8 +1545,8 @@ public abstract class ImageReader {
* source render size or any format-specific settings), they will
* be ignored.
*
* <p> The default implementation just calls {@link #read
* <code>read(imageIndex, param)</code>}.
* <p> The default implementation just calls
* {@link #read read(imageIndex, param)}.
*
* @param imageIndex the index of the image to be retrieved.
* @param param an <code>ImageReadParam</code> used to control
@ -2544,9 +2541,8 @@ public abstract class ImageReader {
* the supplied <code>ImageReadParam</code>. The actual
* subsampling factors, destination size, and destination offset
* are <em>not</em> taken into consideration, thus further
* clipping must take place. The {@link #computeRegions
* <code>computeRegions</code>} method performs all necessary
* clipping.
* clipping must take place. The {@link #computeRegions computeRegions}
* method performs all necessary clipping.
*
* @param param the <code>ImageReadParam</code> being used, or
* <code>null</code>.
@ -2601,7 +2597,7 @@ public abstract class ImageReader {
* width or height of 0, an <code>IllegalArgumentException</code>
* is thrown.
*
* <p> The {@link #getSourceRegion <code>getSourceRegion</code>}
* <p> The {@link #getSourceRegion getSourceRegion>}
* method may be used if only source clipping is desired.
*
* @param param an <code>ImageReadParam</code>, or <code>null</code>.

2
jdk/src/share/classes/javax/imageio/ImageTypeSpecifier.java
View File

@ -840,7 +840,7 @@ public class ImageTypeSpecifier {
* not one of 1, 2, 4, 8, or 16.
* @exception IllegalArgumentException if the
* non-<code>null</code> LUT parameters do not have lengths of
* exactly <code>1 << bits</code>.
* exactly {@code 1 << bits}.
* @exception IllegalArgumentException if <code>dataType</code> is
* not one of <code>DataBuffer.TYPE_BYTE</code>,
* <code>DataBuffer.TYPE_SHORT</code>,

9
jdk/src/share/classes/javax/imageio/ImageWriteParam.java
View File

@ -49,7 +49,7 @@ import java.util.Locale;
* and include additional pixels within the intersected bounds
* according to the horizontal and vertical subsampling factors
* specified by {@link IIOParam#setSourceSubsampling
* <code>IIOParam.setSourceSubsampling</code>}.
* IIOParam.setSourceSubsampling}.
*
* <p> Individual features such as tiling, progressive encoding, and
* compression may be set in one of four modes.
@ -462,9 +462,8 @@ public class ImageWriteParam extends IIOParam {
* <code>IllegalStateException</code>.
*
* <li><code>MODE_EXPLICIT</code> - The image will be tiled
* according to parameters given in the {@link #setTiling
* <code>setTiling</code>} method. Any previously set tiling
* parameters are discarded.
* according to parameters given in the {@link #setTiling setTiling}
* method. Any previously set tiling parameters are discarded.
*
* <li><code>MODE_COPY_FROM_METADATA</code> - The image will
* conform to the metadata object passed in to a write.
@ -1421,7 +1420,7 @@ public class ImageWriteParam extends IIOParam {
* with <code>getCompressionQualityDescriptions</code> as part of a user
* interface for setting or displaying the compression quality
* level. See {@link #getCompressionQualityDescriptions
* <code>getCompressionQualityDescriptions</code>} for more information.
* getCompressionQualityDescriptions} for more information.
*
* <p> If no descriptions are available, <code>null</code> is
* returned. If <code>null</code> is returned from

2
jdk/src/share/classes/javax/imageio/ImageWriter.java
View File

@ -692,7 +692,7 @@ public abstract class ImageWriter implements ImageTranscoder {
* output prior to the current seek position may be flushed, and
* need not be readable or writable, unless the plug-in needs to
* be able to patch up the header information when
* <code>endWriteSequence</code> is called (<italic>e.g.</italic> TIFF).
* <code>endWriteSequence</code> is called (<i>e.g.</i> TIFF).
*
* <p> If <code>canWriteSequence</code> returns <code>false</code>,
* this method will throw an

3
jdk/src/share/classes/javax/imageio/metadata/IIOMetadataFormatImpl.java
View File

@ -729,6 +729,7 @@ public abstract class IIOMetadataFormatImpl implements IIOMetadataFormat {
* @param required <code>true</code> if an object value must be present.
* @param defaultValue the default value for the
* <code>Object</code> reference, or <code>null</code>.
* @param <T> the type of the object.
*
* @exception IllegalArgumentException if <code>elementName</code>
* is <code>null</code>, or is not a legal element name for this format.
@ -765,6 +766,7 @@ public abstract class IIOMetadataFormatImpl implements IIOMetadataFormat {
* @param enumeratedValues a <code>List</code> of
* <code>Object</code>s containing the legal values for the
* object reference.
* @param <T> the type of the object.
*
* @exception IllegalArgumentException if <code>elementName</code>
* is <code>null</code>, or is not a legal element name for this format.
@ -836,6 +838,7 @@ public abstract class IIOMetadataFormatImpl implements IIOMetadataFormat {
* is inclusive.
* @param maxInclusive <code>true</code> if <code>maxValue</code>
* is inclusive.
* @param <T> the type of the object.
*
* @exception IllegalArgumentException if <code>elementName</code>
* is <code>null</code>, or is not a legal element name for this

6
jdk/src/share/classes/javax/imageio/plugins/bmp/BMPImageWriteParam.java
View File

@ -56,9 +56,9 @@ import com.sun.imageio.plugins.bmp.BMPConstants;
* <p><table border=1>
* <caption><b>Compression Types</b></caption>
* <tr><th>Type String</th> <th>Description</th> <th>Image Types</th></tr>
* <tr><td>BI_RGB</td> <td>Uncompressed RLE</td> <td><= 8-bits/sample</td></tr>
* <tr><td>BI_RLE8</td> <td>8-bit Run Length Encoding</td> <td><= 8-bits/sample</td></tr>
* <tr><td>BI_RLE4</td> <td>4-bit Run Length Encoding</td> <td><= 4-bits/sample</td></tr>
* <tr><td>BI_RGB</td> <td>Uncompressed RLE</td> <td>{@literal <= } 8-bits/sample</td></tr>
* <tr><td>BI_RLE8</td> <td>8-bit Run Length Encoding</td> <td>{@literal <=} 8-bits/sample</td></tr>
* <tr><td>BI_RLE4</td> <td>4-bit Run Length Encoding</td> <td>{@literal <=} 4-bits/sample</td></tr>
* <tr><td>BI_BITFIELDS</td> <td>Packed data</td> <td> 16 or 32 bits/sample</td></tr>
* </table>
*/

16
jdk/src/share/classes/javax/imageio/plugins/jpeg/JPEGImageReadParam.java
View File

@ -46,16 +46,15 @@ import javax.imageio.ImageReadParam;
* This class allows the tables to be specified directly from client
* code. If no tables are specified either in the stream or in a
* <code>JPEGImageReadParam</code>, then the stream is presumed to use
* the "standard" visually lossless tables. See {@link JPEGQTable
* <code>JPEGQTable</code>} and {@link JPEGHuffmanTable
* <code>JPEGHuffmanTable</code>} for more information on the default
* tables.
* the "standard" visually lossless tables. See {@link JPEGQTable JPEGQTable}
* and {@link JPEGHuffmanTable JPEGHuffmanTable} for more information
* on the default tables.
*
* <p> The default <code>JPEGImageReadParam</code> returned by the
* <code>getDefaultReadParam</code> method of the builtin JPEG reader
* contains no tables. Default tables may be obtained from the table
* classes {@link JPEGQTable <code>JPEGQTable</code>} and {@link
* JPEGHuffmanTable <code>JPEGHuffmanTable</code>}.
* classes {@link JPEGQTable JPEGQTable} and
* {@link JPEGHuffmanTable JPEGHuffmanTable}.
*
* <p> If a stream does contain tables, the tables given in a
* <code>JPEGImageReadParam</code> are ignored. Furthermore, if the
@ -64,13 +63,12 @@ import javax.imageio.ImageReadParam;
* abbreviated images. Once tables have been read from a stream, they
* can be overridden only by tables subsequently read from the same
* stream. In order to specify new tables, the {@link
* javax.imageio.ImageReader#setInput <code>setInput</code>} method of
* javax.imageio.ImageReader#setInput setInput} method of
* the reader must be called to change the stream.
*
* <p> Note that this class does not provide a means for obtaining the
* tables found in a stream. These may be extracted from a stream by
* consulting the <code>IIOMetadata</code> object returned by the
* reader.
* consulting the IIOMetadata object returned by the reader.
*
* <p>
* For more information about the operation of the built-in JPEG plug-ins,

6
jdk/src/share/classes/javax/imageio/plugins/jpeg/JPEGImageWriteParam.java
View File

@ -66,8 +66,8 @@ import com.sun.imageio.plugins.jpeg.JPEG;
* when an abbreviated stream must be written without writing any tables
* to a stream first. In order to use this class, the metadata object
* passed into the writer must contain no tables, and no stream metadata
* must be provided. See {@link JPEGQTable <code>JPEGQTable</code>} and
* {@link JPEGHuffmanTable <code>JPEGHuffmanTable</code>} for more
* must be provided. See {@link JPEGQTable JPEGQTable} and
* {@link JPEGHuffmanTable JPEGHuffmanTable} for more
* information on the default tables.
*
* <p> The default <code>JPEGImageWriteParam</code> returned by the
@ -80,7 +80,7 @@ import com.sun.imageio.plugins.jpeg.JPEG;
* set of tables has been written, only tables in the metadata can
* override them for subsequent writes, whether to the same stream or
* a different one. In order to specify new tables using this class,
* the {@link javax.imageio.ImageWriter#reset <code>reset</code>}
* the {@link javax.imageio.ImageWriter#reset reset}
* method of the writer must be called.
*
* <p>

2
jdk/src/share/classes/javax/imageio/spi/ImageReaderSpi.java
View File

@ -78,7 +78,7 @@ public abstract class ImageReaderSpi extends ImageReaderWriterSpi {
* <code>ImageInputStream.class</code>, to be returned from
* <code>getInputTypes</code>.
* @deprecated Instead of using this field, directly create
* the equivalent array <code>{ ImageInputStream.class }<code>.
* the equivalent array <code>{ ImageInputStream.class }</code>.
*/
@Deprecated
public static final Class[] STANDARD_INPUT_TYPE =

2
jdk/src/share/classes/javax/imageio/spi/ImageWriterSpi.java
View File

@ -80,7 +80,7 @@ public abstract class ImageWriterSpi extends ImageReaderWriterSpi {
* <code>ImageOutputStream.class</code>, to be returned from
* <code>getOutputTypes</code>.
* @deprecated Instead of using this field, directly create
* the equivalent array <code>{ ImageOutputStream.class }<code>.
* the equivalent array <code>{ ImageOutputStream.class }</code>.
*/
@Deprecated
public static final Class[] STANDARD_OUTPUT_TYPE =

11
jdk/src/share/classes/javax/imageio/spi/ServiceRegistry.java
View File

@ -157,6 +157,8 @@ public class ServiceRegistry {
* or <code>null</code> if the system class loader (or, failing that
* the bootstrap class loader) is to be used.
*
* @param <T> the type of the providerClass.
*
* @return An <code>Iterator</code> that yields provider objects
* for the given service, in some arbitrary order. The iterator
* will throw an <code>Error</code> if a provider-configuration
@ -188,6 +190,8 @@ public class ServiceRegistry {
* @param providerClass a <code>Class</code>object indicating the
* class or interface of the service providers being detected.
*
* @param <T> the type of the providerClass.
*
* @return An <code>Iterator</code> that yields provider objects
* for the given service, in some arbitrary order. The iterator
* will throw an <code>Error</code> if a provider-configuration
@ -247,6 +251,7 @@ public class ServiceRegistry {
* @param provider the service provide object to be registered.
* @param category the category under which to register the
* provider.
* @param <T> the type of the provider.
*
* @return true if no provider of the same class was previously
* registered in the same category category.
@ -348,6 +353,7 @@ public class ServiceRegistry {
* @param provider the service provider object to be deregistered.
* @param category the category from which to deregister the
* provider.
* @param <T> the type of the provider.
*
* @return <code>true</code> if the provider was previously
* registered in the same category category,
@ -435,6 +441,7 @@ public class ServiceRegistry {
* @param category the category to be retrieved from.
* @param useOrdering <code>true</code> if pairwise orderings
* should be taken account in ordering the returned objects.
* @param <T> the type of the category.
*
* @return an <code>Iterator</code> containing service provider
* objects from the given category, possibly in order.
@ -490,6 +497,7 @@ public class ServiceRegistry {
* whose <code>filter</code> method will be invoked.
* @param useOrdering <code>true</code> if pairwise orderings
* should be taken account in ordering the returned objects.
* @param <T> the type of the category.
*
* @return an <code>Iterator</code> containing service provider
* objects from the given category, possibly in order.
@ -517,6 +525,7 @@ public class ServiceRegistry {
*
* @param providerClass the <code>Class</code> of the desired
* service provider object.
* @param <T> the type of the provider.
*
* @return a currently registered service provider object with the
* desired <code>Class</code>type, or <code>null</code> is none is
@ -561,6 +570,7 @@ public class ServiceRegistry {
* @param firstProvider the preferred provider.
* @param secondProvider the provider to which
* <code>firstProvider</code> is preferred.
* @param <T> the type of the category.
*
* @return <code>true</code> if a previously unset ordering
* was established.
@ -606,6 +616,7 @@ public class ServiceRegistry {
* @param firstProvider the formerly preferred provider.
* @param secondProvider the provider to which
* <code>firstProvider</code> was formerly preferred.
* @param <T> the type of the category.
*
* @return <code>true</code> if a previously set ordering was
* disestablished.

74
jdk/src/share/classes/javax/imageio/stream/ImageInputStream.java
View File

@ -183,7 +183,7 @@ public interface ImageInputStream extends DataInput, Closeable {
*
* @return a boolean value from the stream.
*
* @exception EOFException if the end of the stream is reached.
* @exception java.io.EOFException if the end of the stream is reached.
* @exception IOException if an I/O error occurs.
*/
boolean readBoolean() throws IOException;
@ -201,7 +201,7 @@ public interface ImageInputStream extends DataInput, Closeable {
*
* @return a signed byte value from the stream.
*
* @exception EOFException if the end of the stream is reached.
* @exception java.io.EOFException if the end of the stream is reached.
* @exception IOException if an I/O error occurs.
*/
byte readByte() throws IOException;
@ -225,7 +225,7 @@ public interface ImageInputStream extends DataInput, Closeable {
*
* @return an unsigned byte value from the stream.
*
* @exception EOFException if the end of the stream is reached.
* @exception java.io.EOFException if the end of the stream is reached.
* @exception IOException if an I/O error occurs.
*/
int readUnsignedByte() throws IOException;
@ -240,7 +240,7 @@ public interface ImageInputStream extends DataInput, Closeable {
*
* @return a signed short value from the stream.
*
* @exception EOFException if the stream reaches the end before
* @exception java.io.EOFException if the stream reaches the end before
* reading all the bytes.
* @exception IOException if an I/O error occurs.
*
@ -261,7 +261,7 @@ public interface ImageInputStream extends DataInput, Closeable {
*
* @return an unsigned short value from the stream, as an int.
*
* @exception EOFException if the stream reaches the end before
* @exception java.io.EOFException if the stream reaches the end before
* reading all the bytes.
* @exception IOException if an I/O error occurs.
*
@ -278,7 +278,7 @@ public interface ImageInputStream extends DataInput, Closeable {
*
* @return an unsigned char value from the stream.
*
* @exception EOFException if the stream reaches the end before
* @exception java.io.EOFException if the stream reaches the end before
* reading all the bytes.
* @exception IOException if an I/O error occurs.
*
@ -296,7 +296,7 @@ public interface ImageInputStream extends DataInput, Closeable {
*
* @return a signed int value from the stream.
*
* @exception EOFException if the stream reaches the end before
* @exception java.io.EOFException if the stream reaches the end before
* reading all the bytes.
* @exception IOException if an I/O error occurs.
*
@ -316,7 +316,7 @@ public interface ImageInputStream extends DataInput, Closeable {
*
* @return an unsigned int value from the stream, as a long.
*
* @exception EOFException if the stream reaches the end before
* @exception java.io.EOFException if the stream reaches the end before
* reading all the bytes.
* @exception IOException if an I/O error occurs.
*
@ -334,7 +334,7 @@ public interface ImageInputStream extends DataInput, Closeable {
*
* @return a signed long value from the stream.
*
* @exception EOFException if the stream reaches the end before
* @exception java.io.EOFException if the stream reaches the end before
* reading all the bytes.
* @exception IOException if an I/O error occurs.
*
@ -352,7 +352,7 @@ public interface ImageInputStream extends DataInput, Closeable {
*
* @return a float value from the stream.
*
* @exception EOFException if the stream reaches the end before
* @exception java.io.EOFException if the stream reaches the end before
* reading all the bytes.
* @exception IOException if an I/O error occurs.
*
@ -370,7 +370,7 @@ public interface ImageInputStream extends DataInput, Closeable {
*
* @return a double value from the stream.
*
* @exception EOFException if the stream reaches the end before
* @exception java.io.EOFException if the stream reaches the end before
* reading all the bytes.
* @exception IOException if an I/O error occurs.
*
@ -469,7 +469,7 @@ public interface ImageInputStream extends DataInput, Closeable {
* then a <code>UTFDataFormatException</code> is thrown.
*
* <p> If end of file is encountered at any time during this
* entire process, then an <code>EOFException</code> is thrown.
* entire process, then an <code>java.io.EOFException</code> is thrown.
*
* <p> After every group has been converted to a character by this
* process, the characters are gathered, in the same order in
@ -488,10 +488,10 @@ public interface ImageInputStream extends DataInput, Closeable {
*
* @return a String read from the stream.
*
* @exception EOFException if this stream reaches the end
* @exception java.io.EOFException if this stream reaches the end
* before reading all the bytes.
* @exception UTFDataFormatException if the bytes do not represent a
* valid modified UTF-8 encoding of a string.
* @exception java.io.UTFDataFormatException if the bytes do not represent
* a valid modified UTF-8 encoding of a string.
* @exception IOException if an I/O error occurs.
*/
String readUTF() throws IOException;
@ -499,7 +499,7 @@ public interface ImageInputStream extends DataInput, Closeable {
/**
* Reads <code>len</code> bytes from the stream, and stores them
* into <code>b</code> starting at index <code>off</code>.
* If the end of the stream is reached, an <code>EOFException</code>
* If the end of the stream is reached, an <code>java.io.EOFException</code>
* will be thrown.
*
* <p> The bit offset within the stream is reset to zero before
@ -514,7 +514,7 @@ public interface ImageInputStream extends DataInput, Closeable {
* len</code> is greater than <code>b.length</code>.
* @exception NullPointerException if <code>b</code> is
* <code>null</code>.
* @exception EOFException if the stream reaches the end before
* @exception java.io.EOFException if the stream reaches the end before
* reading all the bytes.
* @exception IOException if an I/O error occurs.
*/
@ -523,7 +523,7 @@ public interface ImageInputStream extends DataInput, Closeable {
/**
* Reads <code>b.length</code> bytes from the stream, and stores them
* into <code>b</code> starting at index <code>0</code>.
* If the end of the stream is reached, an <code>EOFException</code>
* If the end of the stream is reached, an <code>java.io.EOFException</code>
* will be thrown.
*
* <p> The bit offset within the stream is reset to zero before
@ -533,7 +533,7 @@ public interface ImageInputStream extends DataInput, Closeable {
*
* @exception NullPointerException if <code>b</code> is
* <code>null</code>.
* @exception EOFException if the stream reaches the end before
* @exception java.io.EOFException if the stream reaches the end before
* reading all the bytes.
* @exception IOException if an I/O error occurs.
*/
@ -544,7 +544,7 @@ public interface ImageInputStream extends DataInput, Closeable {
* stream according to the current byte order, and
* stores them into <code>s</code> starting at index
* <code>off</code>. If the end of the stream is reached, an
* <code>EOFException</code> will be thrown.
* <code>java.io.EOFException</code> will be thrown.
*
* <p> The bit offset within the stream is reset to zero before
* the read occurs.
@ -558,7 +558,7 @@ public interface ImageInputStream extends DataInput, Closeable {
* len</code> is greater than <code>s.length</code>.
* @exception NullPointerException if <code>s</code> is
* <code>null</code>.
* @exception EOFException if the stream reaches the end before
* @exception java.io.EOFException if the stream reaches the end before
* reading all the bytes.
* @exception IOException if an I/O error occurs.
*/
@ -569,7 +569,7 @@ public interface ImageInputStream extends DataInput, Closeable {
* stream according to the current byte order, and
* stores them into <code>c</code> starting at index
* <code>off</code>. If the end of the stream is reached, an
* <code>EOFException</code> will be thrown.
* <code>java.io.EOFException</code> will be thrown.
*
* <p> The bit offset within the stream is reset to zero before
* the read occurs.
@ -583,7 +583,7 @@ public interface ImageInputStream extends DataInput, Closeable {
* len</code> is greater than <code>c.length</code>.
* @exception NullPointerException if <code>c</code> is
* <code>null</code>.
* @exception EOFException if the stream reaches the end before
* @exception java.io.EOFException if the stream reaches the end before
* reading all the bytes.
* @exception IOException if an I/O error occurs.
*/
@ -594,7 +594,7 @@ public interface ImageInputStream extends DataInput, Closeable {
* stream according to the current byte order, and
* stores them into <code>i</code> starting at index
* <code>off</code>. If the end of the stream is reached, an
* <code>EOFException</code> will be thrown.
* <code>java.io.EOFException</code> will be thrown.
*
* <p> The bit offset within the stream is reset to zero before
* the read occurs.
@ -608,7 +608,7 @@ public interface ImageInputStream extends DataInput, Closeable {
* len</code> is greater than <code>i.length</code>.
* @exception NullPointerException if <code>i</code> is
* <code>null</code>.
* @exception EOFException if the stream reaches the end before
* @exception java.io.EOFException if the stream reaches the end before
* reading all the bytes.
* @exception IOException if an I/O error occurs.
*/
@ -619,7 +619,7 @@ public interface ImageInputStream extends DataInput, Closeable {
* stream according to the current byte order, and
* stores them into <code>l</code> starting at index
* <code>off</code>. If the end of the stream is reached, an
* <code>EOFException</code> will be thrown.
* <code>java.io.EOFException</code> will be thrown.
*
* <p> The bit offset within the stream is reset to zero before
* the read occurs.
@ -633,7 +633,7 @@ public interface ImageInputStream extends DataInput, Closeable {
* len</code> is greater than <code>l.length</code>.
* @exception NullPointerException if <code>l</code> is
* <code>null</code>.
* @exception EOFException if the stream reaches the end before
* @exception java.io.EOFException if the stream reaches the end before
* reading all the bytes.
* @exception IOException if an I/O error occurs.
*/
@ -644,7 +644,7 @@ public interface ImageInputStream extends DataInput, Closeable {
* floats) from the stream according to the current byte order,
* and stores them into <code>f</code> starting at
* index <code>off</code>. If the end of the stream is reached,
* an <code>EOFException</code> will be thrown.
* an <code>java.io.EOFException</code> will be thrown.
*
* <p> The bit offset within the stream is reset to zero before
* the read occurs.
@ -658,7 +658,7 @@ public interface ImageInputStream extends DataInput, Closeable {
* len</code> is greater than <code>f.length</code>.
* @exception NullPointerException if <code>f</code> is
* <code>null</code>.
* @exception EOFException if the stream reaches the end before
* @exception java.io.EOFException if the stream reaches the end before
* reading all the bytes.
* @exception IOException if an I/O error occurs.
*/
@ -669,7 +669,7 @@ public interface ImageInputStream extends DataInput, Closeable {
* floats) from the stream according to the current byte order,
* and stores them into <code>d</code> starting at
* index <code>off</code>. If the end of the stream is reached,
* an <code>EOFException</code> will be thrown.
* an <code>java.io.EOFException</code> will be thrown.
*
* <p> The bit offset within the stream is reset to zero before
* the read occurs.
@ -683,7 +683,7 @@ public interface ImageInputStream extends DataInput, Closeable {
* len</code> is greater than <code>d.length</code>.
* @exception NullPointerException if <code>d</code> is
* <code>null</code>.
* @exception EOFException if the stream reaches the end before
* @exception java.io.EOFException if the stream reaches the end before
* reading all the bytes.
* @exception IOException if an I/O error occurs.
*/
@ -748,7 +748,7 @@ public interface ImageInputStream extends DataInput, Closeable {
* @return an <code>int</code> containing the value <code>0</code>
* or <code>1</code>.
*
* @exception EOFException if the stream reaches the end before
* @exception java.io.EOFException if the stream reaches the end before
* reading all the bits.
* @exception IOException if an I/O error occurs.
*/
@ -768,13 +768,13 @@ public interface ImageInputStream extends DataInput, Closeable {
* the right side of the return value, as shown by the following
* pseudo-code:
*
* <pre>
* <pre>{@code
* long accum = 0L;
* for (int i = 0; i < numBits; i++) {
* accum <<= 1; // Shift left one bit to make room
* accum |= readBit();
* }
* </pre>
* }</pre>
*
* Note that the result of <code>readBits(32)</code> may thus not
* be equal to that of <code>readInt()</code> if a reverse network
@ -782,7 +782,7 @@ public interface ImageInputStream extends DataInput, Closeable {
* false</code>).
*
* <p> If the end of the stream is encountered before all the bits
* have been read, an <code>EOFException</code> is thrown.
* have been read, an <code>java.io.EOFException</code> is thrown.
*
* @param numBits the number of bits to read, as an <code>int</code>
* between 0 and 64, inclusive.
@ -791,7 +791,7 @@ public interface ImageInputStream extends DataInput, Closeable {
*
* @exception IllegalArgumentException if <code>numBits</code>
* is not between 0 and 64, inclusive.
* @exception EOFException if the stream reaches the end before
* @exception java.io.EOFException if the stream reaches the end before
* reading all the bits.
* @exception IOException if an I/O error occurs.
*/
@ -850,7 +850,7 @@ public interface ImageInputStream extends DataInput, Closeable {
* returned by <code>getflushedPosition</code>).
*
* <p> It is legal to seek past the end of the file; an
* <code>EOFException</code> will be thrown only if a read is
* <code>java.io.EOFException</code> will be thrown only if a read is
* performed.
*
* @param pos a <code>long</code> containing the desired file

2
jdk/src/share/classes/javax/imageio/stream/ImageInputStreamImpl.java
View File

@ -88,7 +88,7 @@ public abstract class ImageInputStreamImpl implements ImageInputStream {
/**
* The position prior to which data may be discarded. Seeking
* to a smaller position is not allowed. <code>flushedPos</code>
* will always be >= 0.
* will always be {@literal >= 0}.
*/
protected long flushedPos = 0;

17
jdk/src/share/classes/javax/imageio/stream/ImageOutputStream.java
View File

@ -59,9 +59,9 @@ public interface ImageOutputStream extends ImageInputStream, DataOutput {
* remainder of the current byte is padded with 0s
* and written out first. The bit offset will be 0 after the
* write. Implementers can use the
* {@link ImageOutputStreamImpl#flushBits <code>flushBits</code>}
* method of {@link ImageOutputStreamImpl
* <code>ImageOutputStreamImpl</code>} to guarantee this.
* {@link ImageOutputStreamImpl#flushBits flushBits}
* method of {@link ImageOutputStreamImpl ImageOutputStreamImpl}
* to guarantee this.
*
* @param b an <code>int</code> whose lower 8 bits are to be
* written.
@ -99,9 +99,9 @@ public interface ImageOutputStream extends ImageInputStream, DataOutput {
* remainder of the current byte is padded with 0s
* and written out first. The bit offset will be 0 after the
* write. Implementers can use the
* {@link ImageOutputStreamImpl#flushBits <code>flushBits</code>}
* method of {@link ImageOutputStreamImpl
* <code>ImageOutputStreamImpl</code>} to guarantee this.
* {@link ImageOutputStreamImpl#flushBits flushBits}
* method of {@link ImageOutputStreamImpl ImageOutputStreamImpl}
* to guarantee this.
*
* @param b an array of <code>byte</code>s to be written.
* @param off the start offset in the data.
@ -182,8 +182,7 @@ public interface ImageOutputStream extends ImageInputStream, DataOutput {
void writeShort(int v) throws IOException;
/**
* This method is a synonym for
* {@link #writeShort <code>writeShort</code>}.
* This method is a synonym for {@link #writeShort writeShort}.
*
* @param v an <code>int</code> containing the char (unsigned
* short) value to be written.
@ -430,7 +429,7 @@ public interface ImageOutputStream extends ImageInputStream, DataOutput {
*
* @exception NullPointerException if <code>s</code> is
* <code>null</code>.
* @exception UTFDataFormatException if the modified UTF-8
* @exception java.io.UTFDataFormatException if the modified UTF-8
* representation of <code>s</code> requires more than 65536 bytes.
* @exception IOException if an I/O error occurs.
*/