yetangitu/ghidra
1
0
Fork 0
mirror of https://github.com/NationalSecurityAgency/ghidra.git synced 2025-10-05 10:49:34 +02:00
Code Issues Releases Wiki Activity

GT-3042 tweak related javadoc

Browse source
This commit is contained in:
dev747368 2019-08-08 13:30:21 -04:00
parent bc2c1ac828
commit f073d58fb2
1 changed files with 11 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

21
Ghidra/Framework/Utility/src/main/java/utilities/util/FileUtilities.java
View file

@ -727,11 +727,10 @@ public final class FileUtilities {
/** /**
* Returns all of the lines in the given {@link InputStream} without any newline characters. * Returns all of the lines in the given {@link InputStream} without any newline characters.
* <p> * <p>
* <b> * <b>The input stream is closed as a side-effect.</b>
* You must close the input stream!!!!! *
* </b> * @param is the input stream from which to read, as a side effect, it is closed
* @param is the input stream from which to read * @return a {@link List} of strings representing the text lines of the file
* @return a list of file lines
* @throws IOException if there are any issues reading the file * @throws IOException if there are any issues reading the file
*/ */
public static List<String> getLines(InputStream is) throws IOException { public static List<String> getLines(InputStream is) throws IOException {
@ -743,9 +742,9 @@ public final class FileUtilities {
* <p> * <p>
* EOL characters are normalized to simple '\n's. * EOL characters are normalized to simple '\n's.
* <p> * <p>
* Caller is responsible for closing the input stream, this method does not. * <b>The input stream is closed as a side-effect.</b>
* <p> * <p>
* @param is the input stream from which to read * @param is the input stream from which to read, as a side effect, it is closed
* @return the content as a String * @return the content as a String
* @throws IOException if there are any issues reading the file * @throws IOException if there are any issues reading the file
*/ */
@ -778,10 +777,12 @@ public final class FileUtilities {
} }
/** /**
* Returns all of the lines in the BufferedReader without any newline characters. * Returns all of the lines in the {@link BufferedReader} without any newline characters.
* <p>
* The BufferedReader is closed before returning.
* *
* @param in BufferedReader input * @param in BufferedReader to read lines from, as a side effect, it is closed
* @return a list of file lines * @return a {@link List} of strings representing the text lines of the file
* @throws IOException if there are any issues reading the file * @throws IOException if there are any issues reading the file
*/ */
public static List<String> getLines(BufferedReader in) throws IOException { public static List<String> getLines(BufferedReader in) throws IOException {