6588417: Incorrect javadoc: no @throws or @exception tag in javax.*
authoryan
Mon, 22 Sep 2014 11:25:33 +0400
changeset 26755 70eafa5df34b
parent 26754 317ece99e83d
child 26756 2f8b9266922b
6588417: Incorrect javadoc: no @throws or @exception tag in javax.* Summary: Fix remaining missing @throws tags. Reviewed-by: prr Contributed-by: anisha.nagarajan1@gmail.com
jdk/src/java.desktop/share/classes/javax/imageio/stream/FileCacheImageInputStream.java
jdk/src/java.desktop/share/classes/javax/imageio/stream/MemoryCache.java
--- a/jdk/src/java.desktop/share/classes/javax/imageio/stream/FileCacheImageInputStream.java	Mon Sep 22 11:23:19 2014 +0400
+++ b/jdk/src/java.desktop/share/classes/javax/imageio/stream/FileCacheImageInputStream.java	Mon Sep 22 11:25:33 2014 +0400
@@ -87,7 +87,7 @@
      * <code>null</code>.
      * @exception IllegalArgumentException if <code>cacheDir</code> is
      * non-<code>null</code> but is not a directory.
-     * @exception IOException if a cache file cannot be created.
+     * @throws IOException if a cache file cannot be created.
      */
     public FileCacheImageInputStream(InputStream stream, File cacheDir)
         throws IOException {
@@ -122,6 +122,9 @@
      * or the end of the source is reached.  The return value
      * is equal to the smaller of <code>pos</code> and the
      * length of the source file.
+     *
+     * @throws IOException if an I/O error occurs while reading from the
+     * source file
      */
     private long readUntil(long pos) throws IOException {
         // We've already got enough data cached
@@ -244,7 +247,7 @@
      * and removing the cache file.  The source <code>InputStream</code>
      * is not closed.
      *
-     * @exception IOException if an error occurs.
+     * @throws IOException if an error occurs.
      */
     public void close() throws IOException {
         super.close();
--- a/jdk/src/java.desktop/share/classes/javax/imageio/stream/MemoryCache.java	Mon Sep 22 11:23:19 2014 +0400
+++ b/jdk/src/java.desktop/share/classes/javax/imageio/stream/MemoryCache.java	Mon Sep 22 11:25:33 2014 +0400
@@ -82,6 +82,8 @@
      * or the end of the source is reached.  The return value
      * is equal to the smaller of <code>pos</code> and the
      * length of the source.
+     *
+     * @throws IOException if there is no more memory for cache
      */
     public long loadFromStream(InputStream stream, long pos)
         throws IOException {
@@ -143,6 +145,8 @@
      * the requested data is not in the cache (including if <code>pos</code>
      * is in a block already disposed), or if either <code>pos</code> or
      * <code>len</code> is < 0.
+     * @throws IOException if there is an I/O exception while writing to the
+     * stream
      */
     public void writeToStream(OutputStream stream, long pos, long len)
         throws IOException {
@@ -177,6 +181,8 @@
 
     /**
      * Ensure that there is space to write a byte at the given position.
+     *
+     * throws IOException if there is no more memory left for cache
      */
     private void pad(long pos) throws IOException {
         long currIndex = cacheStart + cache.size() - 1;
@@ -197,7 +203,7 @@
      * the incoming data.
      *
      * @param b an array of bytes containing data to be written.
-     * @param off the starting offset withing the data array.
+     * @param off the starting offset within the data array.
      * @param len the number of bytes to be written.
      * @param pos the cache position at which to begin writing.
      *
@@ -205,6 +211,7 @@
      * @exception IndexOutOfBoundsException if <code>off</code>,
      * <code>len</code>, or <code>pos</code> are negative,
      * or if <code>off+len > b.length</code>.
+     * @throws IOException if there is an I/O error while writing to the cache
      */
     public void write(byte[] b, int off, int len, long pos)
         throws IOException {
@@ -248,6 +255,7 @@
      * @param pos the cache position at which to begin writing.
      *
      * @exception IndexOutOfBoundsException if <code>pos</code> is negative.
+     * @throws IOException if there is an I/O error while writing to the cache
      */
     public void write(int b, long pos) throws IOException {
         if (pos < 0) {
@@ -279,6 +287,9 @@
      * Returns the single byte at the given position, as an
      * <code>int</code>.  Returns -1 if this position has
      * not been cached or has been disposed.
+     *
+     * @throws IOException if an I/O error occurs while reading from the byte
+     * array
      */
     public int read(long pos) throws IOException {
         if (pos >= length) {
@@ -304,6 +315,8 @@
      * <code>off + len > b.length</code> or if any portion of the
      * requested data is not in the cache (including if
      * <code>pos</code> is in a block that has already been disposed).
+     * @throws IOException if an I/O exception occurs while reading from the
+     * byte array
      */
     public void read(byte[] b, int off, int len, long pos)
         throws IOException {