changeset 2280:0b7f10901f30

6717164: FilterInputStream.skip incorrectly inherits wording specifying how the InputStream.skip works Summary: restoring the javadoc Reviewed-by: alanb
author sherman
date Tue, 06 Apr 2010 15:45:21 -0700
parents 495ba30cf02f
children fc7c38b2584c
files src/share/classes/java/io/FilterInputStream.java
diffstat 1 files changed, 10 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/src/share/classes/java/io/FilterInputStream.java	Tue Apr 06 15:44:17 2010 +0100
+++ b/src/share/classes/java/io/FilterInputStream.java	Tue Apr 06 15:45:21 2010 -0700
@@ -134,9 +134,18 @@
     }
 
     /**
-     * {@inheritDoc}
+     * Skips over and discards <code>n</code> bytes of data from the
+     * input stream. The <code>skip</code> method may, for a variety of
+     * reasons, end up skipping over some smaller number of bytes,
+     * possibly <code>0</code>. The actual number of bytes skipped is
+     * returned.
      * <p>
      * This method simply performs <code>in.skip(n)</code>.
+     *
+     * @param      n   the number of bytes to be skipped.
+     * @return     the actual number of bytes skipped.
+     * @exception  IOException  if the stream does not support seek,
+     *                          or if some other I/O error occurs.
      */
     public long skip(long n) throws IOException {
         return in.skip(n);