aboutsummaryrefslogtreecommitdiff
path: root/src/share/classes/java/io
diff options
context:
space:
mode:
authorsherman <none@none>2013-09-04 12:35:22 -0700
committersherman <none@none>2013-09-04 12:35:22 -0700
commit6d8a07904d1a207d7d2234e07b3fd753966394ea (patch)
tree9a9f280126a9bf68a8aa724e1f2ec2cd2f875dde /src/share/classes/java/io
parentfb8298b5a5ab19d5df14814dd28b35956135d0dc (diff)
downloadjdk8u_jdk-6d8a07904d1a207d7d2234e07b3fd753966394ea.tar.gz
6341345: (spec) Console.reader() should make it clear that the reader requires line termination
Summary: to clarify the spec Reviewed-by: alanb
Diffstat (limited to 'src/share/classes/java/io')
-rw-r--r--src/share/classes/java/io/Console.java8
1 files changed, 5 insertions, 3 deletions
diff --git a/src/share/classes/java/io/Console.java b/src/share/classes/java/io/Console.java
index c100f8a0cc..292e42eec7 100644
--- a/src/share/classes/java/io/Console.java
+++ b/src/share/classes/java/io/Console.java
@@ -124,9 +124,11 @@ public final class Console implements Flushable
* {@link java.io.Reader#read(java.nio.CharBuffer) read(java.nio.CharBuffer)}
* on the returned object will not read in characters beyond the line
* bound for each invocation, even if the destination buffer has space for
- * more characters. A line bound is considered to be any one of a line feed
- * (<tt>'\n'</tt>), a carriage return (<tt>'\r'</tt>), a carriage return
- * followed immediately by a linefeed, or an end of stream.
+ * more characters. The {@code Reader}'s {@code read} methods may block if a
+ * line bound has not been entered or reached on the console's input device.
+ * A line bound is considered to be any one of a line feed (<tt>'\n'</tt>),
+ * a carriage return (<tt>'\r'</tt>), a carriage return followed immediately
+ * by a linefeed, or an end of stream.
*
* @return The reader associated with this console
*/