infernap12/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2026-05-10 05:29:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

8177526: BufferedReader readLine() javadoc does not match the implementation regarding EOF

Browse Source 
Improve the verbiage of the method and return value descriptions

Reviewed-by: lancea, smarks
This commit is contained in:
Brian Burkhalter 2017-04-03 16:40:49 -07:00
parent 7bae55cd1f
commit 1fb49ba49f
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
jdk/src/java.base/share/classes/java/io/BufferedReader.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1996, 2017, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -297,14 +297,15 @@ public class BufferedReader extends Reader {
/**
* Reads a line of text. A line is considered to be terminated by any one
* of a line feed ('\n'), a carriage return ('\r'), or a carriage return
* followed immediately by a linefeed.
* of a line feed ('\n'), a carriage return ('\r'), a carriage return
* followed immediately by a line feed, or by reaching the end-of-file
* (EOF).
*
* @param ignoreLF If true, the next '\n' will be skipped
*
* @return A String containing the contents of the line, not including
* any line-termination characters, or null if the end of the
* stream has been reached
* stream has been reached without reading any characters
*
* @see java.io.LineNumberReader#readLine()
*
@ -375,12 +376,13 @@ public class BufferedReader extends Reader {
/**
* Reads a line of text. A line is considered to be terminated by any one
* of a line feed ('\n'), a carriage return ('\r'), or a carriage return
* followed immediately by a linefeed.
* of a line feed ('\n'), a carriage return ('\r'), a carriage return
* followed immediately by a line feed, or by reaching the end-of-file
* (EOF).
*
* @return A String containing the contents of the line, not including
* any line-termination characters, or null if the end of the
* stream has been reached
* stream has been reached without reading any characters
*
* @exception IOException If an I/O error occurs
*