CODEWITHSUNDEEP
javaiofileoutputstream
javauser35
javauser35

Reputation: 1315

FileOutputStream: Does the "close" method calls also "flush"?

I'm really confused about flush and close method.In my code I always close my FileOutputStream object. But I want to know that if I have to use flush method here, and where can I use it?

I will write a project that download 4 or 5 files repeatedly. I will write a method(for download files) and my method will be in a loop and download files repeatedly.My method will have a code like this.

Does the close method calls flush, or do I have to use flush before closing?

try {
    InputStream inputStream = con.getInputStream();
    FileOutputStream outputStream = new FileOutputStream("C:\\programs\\TRYFILE.csv");

    int bytesRead = -1;
    byte[] buffer = new byte[4096];
    while ((bytesRead = inputStream.read(buffer)) != -1) {
    outputStream.write(buffer, 0, bytesRead);
}

} catch(Exception e) {
    //
} finally {
    outputStream.close();
    inputStream.close();
}

Note that the code works well: it download the file successfully. But I'm not sure about using flush.

Upvotes: 29

Views: 23289

Answers (2)

Davide Lorenzo MARINO
Davide Lorenzo MARINO

Reputation: 26926

The method flush is used to "flush" bytes retained in a buffer. FileOutputStream doesn't use any buffer, so flush method is empty. Calling it or not doesn't change the result of your code.

With buffered writers the method close call explicitly flush.

So you need to call flush when you like to write the data before closing the stream and before the buffer is full (when the buffer is full the writer starts writing without waiting a flush call).

The source code of class FileOutputStream hasn't a custom version of method flush. So the flush method used is the version of its super class OutputStream. The code of flush in OutputStream is the following

public void flush() throws IOException {
}

As you see this is an empty method doing nothing, so calling it or not is the same.

Upvotes: 40

Puce
Puce

Reputation: 38122

I will write a project that download 4 or 5 files repeatedly. I will write a method(for download files) and my method will be in a loop and download files repeatedly.My method will have a code like this.

Does the close method calls flush, or do I have to use flush before closing?

I recommend to use the NIO.2 API and the try-with-resources statement. This will reduce the amount of code and takes care of flushing and closing the streams:

try (InputStream inputStream = con.getInputStream()){
    Files.copy(inputStream, Paths.get("C:\\programs\\TRYFILE.csv"));
}

The topic is a bit confusing since OutputStream.close does indeed not require an automatic flush, but subclasses might specify that. They might also provide a flush method which does nothing (e.g. as the one inherited from OutputStream, which is the case for FileOutputStream). In this case it has no effect to call the flush method, of course, so you can omit it.

If in doubt (if you don't know which subclass you're working with) I guess it's better to call the flush manually.

But again, using the code above this is taken care for you.

Upvotes: -1

Related Questions