changeset 8453:7c1d6b2c41ea

Another round of javadoc review for BufferedReader::lines
author henryjen
date Wed, 01 May 2013 23:18:30 -0700
parents bfa882164c34
children 6a75d5409258
files src/share/classes/java/io/BufferedReader.java
diffstat 1 files changed, 11 insertions(+), 16 deletions(-) [+]
line wrap: on
line diff
--- a/src/share/classes/java/io/BufferedReader.java	Wed May 01 14:59:49 2013 -0700
+++ b/src/share/classes/java/io/BufferedReader.java	Wed May 01 23:18:30 2013 -0700
@@ -531,24 +531,19 @@
     }
 
     /**
-     * Returns a {@code Stream}, the elements of which are lines read from this
-     * {@code BufferedReader}.  The {@link Stream} is lazily populated via
-     * calls to {@link #readLine()}.
+     * Returns a {@code Stream}, the elements of which are lines read from
+     * this {@code BufferedReader}.  The {@link Stream} is lazily populated,
+     * i.e, read only occurs during the
+     * <a href="../util/stream/package-summary.html#StreamOps">terminal
+     * stream operation</a>.
      *
-     * <p>Each element consumed by the {@code Stream} caused a line to be
-     * read from this {@code BufferedReader}. Since the {@code Stream} does
-     * not necessarily consume all lines, it is possible to mix and use
-     * different read methods on a {@code BufferedReader}. Each method will
-     * simply pick up from where it was left on last read.
+     * <p>The reader must not be operated on during the execution of the
+     * terminal stream operation. Otherwise, the result of the terminal stream
+     * operation is undefined.
      *
-     * <p>The reader must not be operated on during the execution of the terminal
-     * stream operation. Otherwise, the result of the terminal stream operation is
-     * undefined
-     *
-     * <p>Noted that some terminal stream operations make no guarantee how many
-     * element to be consumed. Therefore after execution of the terminal
-     * stream operation there are no guarantees that the reader will be at a
-     * specific position from which to read the next character or line.
+     * <p>After execution of the terminal stream operation there are no
+     * guarantees that the reader will be at a specific position from which to
+     * read the next character or line.
      *
      * <p>If an {@link IOException} is thrown when accessing the underlying
      * {@code BufferedReader}, it is wrapped in an {@link