60

Does Java has a one line instruction to read to a text file, like what C# has?

I mean, is there something equivalent to this in Java?:

String data = System.IO.File.ReadAllText("path to file"); 

If not... what is the 'optimal way' to do this...?

Edit:
I prefer a way within Java standard libraries... I can not use 3rd party libraries..

1

10 Answers 10

51

apache commons-io has:

String str = FileUtils.readFileToString(file, "utf-8"); 

But there is no such utility in the standard java classes. If you (for some reason) don't want external libraries, you'd have to reimplement it. Here are some examples, and alternatively, you can see how it is implemented by commons-io or Guava.

Sign up to request clarification or add additional context in comments.

1 Comment

I'd use the FileUtils.readFileToString(file,encoding) version - may as well recommend good habits!
29

Java 11 adds support for this use-case with Files.readString, sample code:

Files.readString(Path.of("/your/directory/path/file.txt")); 

Before Java 11, typical approach with standard libraries would be something like this:

public static String readStream(InputStream is) { StringBuilder sb = new StringBuilder(512); try { Reader r = new InputStreamReader(is, "UTF-8"); int c = 0; while ((c = r.read()) != -1) { sb.append((char) c); } } catch (IOException e) { throw new RuntimeException(e); } return sb.toString(); } 

Notes:

  • in order to read text from file, use FileInputStream
  • if performance is important and you are reading large files, it would be advisable to wrap the stream in BufferedInputStream
  • the stream should be closed by the caller

6 Comments

buffered reader has a read line which would be better than reading a char at a time
If you would use a BufferedInputStream, it would not make a difference
This way it adds last (-1) to the string.
No, it doesn't. It checks for that in while condition (c != -1)
This is really not cool. The return string always ends with -1 because of the careless coding around while loop.
|
28

Not within the main Java libraries, but you can use Guava:

String data = Files.asCharSource(new File("path.txt"), Charsets.UTF_8).read(); 

Or to read lines:

List<String> lines = Files.readLines( new File("path.txt"), Charsets.UTF_8 ); 

Of course I'm sure there are other 3rd party libraries which would make it similarly easy - I'm just most familiar with Guava.

Comments

24

Java 7 improves on this sorry state of affairs with the Files class (not to be confused with Guava's class of the same name), you can get all lines from a file - without external libraries - with:

List<String> fileLines = Files.readAllLines(path, StandardCharsets.UTF_8); 

Or into one String:

String contents = new String(Files.readAllBytes(path), StandardCharsets.UTF_8); // or equivalently: StandardCharsets.UTF_8.decode(ByteBuffer.wrap(Files.readAllBytes(path))); 

If you need something out of the box with a clean JDK this works great. That said, why are you writing Java without Guava?

2 Comments

The path in the second example is of type Path and can be retrieved from a String with var path = Paths.get(filePathAsString);
All of Files methods use Path; see the java.nio.file package. Paths.get() is just one way to get a Path instance.
11

In Java 8 (no external libraries) you could use streams. This code reads a file and puts all lines separated by ', ' into a String.

try (Stream<String> lines = Files.lines(myPath)) { list = lines.collect(Collectors.joining(", ")); } catch (IOException e) { LOGGER.error("Failed to load file.", e); } 

Comments

5

With JDK/11, you can read a complete file at a Path as a string using Files.readString(Path path):

try { String fileContent = Files.readString(Path.of("/foo/bar/gus")); } catch (IOException e) { // handle exception in i/o } 

the method documentation from the JDK reads as follows:

/** * Reads all content from a file into a string, decoding from bytes to characters * using the {@link StandardCharsets#UTF_8 UTF-8} {@link Charset charset}. * The method ensures that the file is closed when all content have been read * or an I/O error, or other runtime exception, is thrown. * * <p> This method is equivalent to: * {@code readString(path, StandardCharsets.UTF_8) } * * @param path the path to the file * * @return a String containing the content read from the file * * @throws IOException * if an I/O error occurs reading from the file or a malformed or * unmappable byte sequence is read * @throws OutOfMemoryError * if the file is extremely large, for example larger than {@code 2GB} * @throws SecurityException * In the case of the default provider, and a security manager is * installed, the {@link SecurityManager#checkRead(String) checkRead} * method is invoked to check read access to the file. * * @since 11 */ public static String readString(Path path) throws IOException 

1 Comment

And it was about frickin' time you could do this. I don't see the point in reading lines and throwing away the line end encoding.
3

No external libraries needed. The content of the file will be buffered before converting to string.

Path path = FileSystems.getDefault().getPath(directory, filename); String fileContent = new String(Files.readAllBytes(path), StandardCharsets.UTF_8); 

2 Comments

Note String(byte[], String) throws an UnsupportedEncodingException. You should prefer the String(byte[], Charset) constructor along with the constants in StandardCharsets or Guava's Charsets.
This is a code only answer, and your answer fails to mention that it requires the buffering of all bytes before converting it to a string (i.e. it is not very memory efficient).
0

Here are 3 ways to read a text file in one line, without requiring a loop. I documented 15 ways to read from a file in Java and these are from that article.

Note that you still have to loop through the list that's returned, even though the actual call to read the contents of the file requires just 1 line, without looping.

1) java.nio.file.Files.readAllLines() - Default Encoding

import java.io.File; import java.io.IOException; import java.nio.file.Files; import java.util.List; public class ReadFile_Files_ReadAllLines { public static void main(String [] pArgs) throws IOException { String fileName = "c:\\temp\\sample-10KB.txt"; File file = new File(fileName); List fileLinesList = Files.readAllLines(file.toPath()); for(String line : fileLinesList) { System.out.println(line); } } } 

2) java.nio.file.Files.readAllLines() - Explicit Encoding

import java.io.File; import java.io.IOException; import java.nio.charset.StandardCharsets; import java.nio.file.Files; import java.util.List; public class ReadFile_Files_ReadAllLines_Encoding { public static void main(String [] pArgs) throws IOException { String fileName = "c:\\temp\\sample-10KB.txt"; File file = new File(fileName); //use UTF-8 encoding List fileLinesList = Files.readAllLines(file.toPath(), StandardCharsets.UTF_8); for(String line : fileLinesList) { System.out.println(line); } } } 

3) java.nio.file.Files.readAllBytes()

import java.io.File; import java.io.IOException; import java.nio.file.Files; public class ReadFile_Files_ReadAllBytes { public static void main(String [] pArgs) throws IOException { String fileName = "c:\\temp\\sample-10KB.txt"; File file = new File(fileName); byte [] fileBytes = Files.readAllBytes(file.toPath()); char singleChar; for(byte b : fileBytes) { singleChar = (char) b; System.out.print(singleChar); } } } 

Comments

0

No external libraries needed. The content of the file will be buffered before converting to string.

 String fileContent=""; try { File f = new File("path2file"); byte[] bf = new byte[(int)f.length()]; new FileInputStream(f).read(bf); fileContent = new String(bf, "UTF-8"); } catch (FileNotFoundException e) { // handle file not found exception } catch (IOException e) { // handle IO-exception } 

2 Comments

But only if you never followed the I/O stream tutorials and don't understand how to handle errors and if you want to copy all characters into a buffer before converting them to a string. Please describe your answers, code only answers are generally not upvoted.
It's lacking a close statement for the stream, but besides that, this suggestion's general principle is useful for smaller files.
0

Not quite a one liner and probably obsolete if using JDK 11 as posted by nullpointer. Still usefull if you have a non file input stream

InputStream inStream = context.getAssets().open(filename); Scanner s = new Scanner(inStream).useDelimiter("\\A"); String string = s.hasNext() ? s.next() : ""; inStream.close(); return string; 

Comments

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.