Java IO, how does inputstream/reader read() work, why the while loop

[jmu2101]

How does inputstream, or reader work in java, and why is there always a while loop in code snippets online?

while ((read = reader.read(buf)) >= 0)
{
writer.write(buf, 0, read);
}

about the reader:
"Reads characters into an array. This method will block until some input is available, an I/O error occurs, or the end of the stream is reached."

So what is the while loop doing in every code snippet which uses this read? If the method automatically calls input stream characters into an array, why do you need to program the code to loop?

Java api 7 states the int returned by reader is: "The number of characters read, or -1 if the end of the stream has been reached".

So how often does this int returned update itself? for every character? Or before it starts and once the reader is finished?

Thanks for your info.

[Norm]

why is there always a while loop in code snippets online

The call to the read() method does NOT always receive all the data that was sent. So you need to keep using the read method until it tells you there is no more data. With data coming over the internet it can be split up into several pieces. Each read can return the next piece of data. You need to continue reading until read tells you there is no more data.

[pbrockway2]

So what is the while loop doing in every code snippet which uses this read?

It is performing a read into the array buf over and over again until all the data has been read (EOF) or there is an error. How many times this will happen depends on the size of the array which might be quite small relative to what is being read. Basically you are reading one array (buffer) full at a time.

Notice that inside the loop you should not write the all of the array - only the number of characters that were actually read.

Have a read of Basic I/O in Oracle's Tutorial for details.

[jmu2101]

Thanks for your info. Still not sure about how often the int gets returned, and whether you could put an if statement directly below the int read, like: do{
read = reader.read(buf);
if (read!=-1){writer.write(buf, 0, read);}


} while(read>0);

[Norm]

not sure about how often the int gets returned

An int value gets returned on EVERY and ALL calls.

Read the API doc for the read() method for a description of what it does and what it returns.

[pbrockway2]

If you are unsure what the docs and Tutorial are saying, play with some code. What you posted would be an example. If the results are weird, post code, description of observed behaviour and your thoughts: it's sure to get a response.