Java Files and I/O: Streams
Java Files and I/O: Streams
Java Files and I/O: Streams
FILES AND I/O
STREAMS
A stream can be defined as a sequence of data. The InputStream is used to read data from a source and the
OutputStream is used for writing data to a destination.
The java.io package contains nearly every class you might ever need to perform input and output (I/O) in
Java. All these streams represent an input source and an output destination. The stream in the java.io
package supports many data such as primitives, Object, localized characters, etc.
Java does provide strong, flexible support for I/O as it relates to files and networks but this tutorial covers very
basic functionality related to streams and I/O. We would see most commonly used example one by one.
READING CONSOLE INPUT
Java input console is accomplished by reading from System.in. To obtain a character‐based stream that is
attached to the console, you wrap System.in in a BufferedReader object, to create a character stream. Here
is most common syntax to obtain BufferedReader:
Once BufferedReader is obtained, we can use read( ) method to reach a character or readLine( )
method to read a string from the console.
READING CHARACTERS FROM CONSOLE
To read a character from a BufferedReader, we would read( ) method whose sytax is as follows:
Each time that read( ) is called, it reads a character from the input stream and returns it as an integer value. It
returns .1 when the end of the stream is encountered. As you can see, it can throw an IOException (more about
exceptions see theme 12 – Exceptions).
The following program demonstrates read( ) by reading characters from the console until the user types a "q":
import java.io.*;
Here is a sample run:
READING STRINGS FROM CONSOLE
To read a string from the keyboard, use the version of readLine( ) that is a member of the
BufferedReader class. Its general form is shown here:
The following program demonstrates BufferedReader and the readLine( ) method. The program reads and
displays lines of text until you enter the word "end":
Here is a sample run:
Enter lines of text.
Enter 'end' to quit.
This is line one
This is line one
This is line two
This is line two
end
end
WRITING CONSOLE OUTPUT
Because PrintStream is an output stream derived from OutputStream, it also implements the low‐level method
write( ). Thus, write( ) can be used to write to the console. The simplest form of write( ) defined
by PrintStream is shown here:
This method writes to the stream the byte specified by byteval. Although byteval is declared as an integer,
only the low‐order eight bits are written.
EXAMPLE
Here is a short example that uses write( ) to output the character "A" followed by a newline to the screen:
import java.io.*;
// Demonstrate System.out.write().
public class WriteDemo {
public static void main(String args[]) {
int b;
b = 'A';
System.out.write(b);
System.out.write('\n');
}
}
This would produce simply 'A' character on the output screen.
NOTE
You will not often use write( ) to perform console output because print( ) and println( ) are substantially easier
to use.
READING AND WRITING FILES
As described earlier, a stream can be defined as a sequence of data. The InputStream is used to read data from
a source and the OutputStream is used for writing data to a destination.
Here is a hierarchy of classes to deal with Input and Output streams:
The three important streams are FileInputStream, ByteArrayInputStream and DataInputStream for inputs and
three streams for outputs FileOutputStream, ByteArrayOutputStream and DataOutputStream. They all would
be discussed below:
FILEINPUTSTREAM
This stream is used for reading data from the files. Objects can be created using the keyword new and there are
several types of constructors available.
Following constructor takes a file name as a string to create an input stream object to read the file.:
Following constructor takes a file object to create an input stream object to read the file. First we create a file
object using File() method as follows:
Once you have InputStream object in hand, then there is a list of helper methods which can be used to read to
stream or to do other operations on the stream.
Methods with Description
1 public void close() throws IOException{}
This method closes the file output stream. Releases any system resources associated with the file. Throws
an IOException.
2 protected void finalize()throws IOException {}
This method cleans up the connection to the file. Ensures that the close method of this file output stream
is called when there are no more references to this stream. Throws an IOException.
3 public int read(int r)throws IOException{}
This method reads the specified byte of data from the InputStream. Returns an int. Returns the next byte
of data and ‐1 will be returned if it's end of file.
4 public int read(byte[] r) throws IOException{}
This method reads r.length bytes from the input stream into an array. Returns the total number of bytes
read. If end of file ‐1 will be returned.
5 public int available() throws IOException{}
Gives the number of bytes that can be read from this file input stream. Returns an int.
BYTEARRAYINPUTSTREAM
The ByteArrayInputStream class allows a buffer in the memory to be used as an InputStream. The input source
is a byte array. There are following forms of constructors to create ByteArrayInputStream objects
Takes a byte array as the parameter:
Another form takes an array of bytes, and two ints, where off is the first byte to be read and len is the number
of bytes to be read.
Once you have ByteArrayInputStream object in hand then there is a list of helper methods which can be used
to read the stream or to do other operations on the stream.
Methods with Description
1 public int read()
This method reads the next byte of data from the InputStream. Returns an int as the next byte of data. If
it is end of file then it returns ‐1.
2 public int read(byte[] r, int off, int len)
This method reads upto len number of bytes starting from off from the input stream into an array.
Returns the total number of bytes read. If end of file ‐1 will be returned
3 public int available()
Gives the number of bytes that can be read from this file input stream. Returns an int that gives the
number of bytes to be read.
4 public void mark(int read)
This sets the current marked position in the stream. The parameter gives the maximum limit of bytes that
can be read before the marked position becomes invalid.
5 public long skip(long n)
Skips n number of bytes from the stream. This returns the actual number of bytes skipped
EXAMPLE
Following is the example to demonstrate ByteArrayInputStream and ByteArrayOutputStream
import java.io.*;
while( bOutput.size()!= 10 ) {
// Gets the inputs from the user
bOutput.write(System.in.read());
}
byte b [] = bOutput.toByteArray();
System.out.println("Print the content");
for(int x= 0 ; x < b.length; x++) {
// printing the characters
System.out.print((char)b[x] + " ");
}
System.out.println(" ");
int c;
Here is the sample run of the above program:
asdfghjkly
Print the content
a s d f g h j k l y
Converting characters to Upper case
A
S
D
F
G
H
J
K
L
Y
DATAINPUTSTREAM
The DataInputStream is used in the context of InputStream and can be used to read primitives.
Following is the constructor to create an InputStream:
Once you have DataInputStream object in hand, then there is a list of helper methods, which can be used to
read the stream or to do other operations on the stream.
Methods with Description
1 public final int read(byte[] r, int off, int len)throws IOException
Reads up to len bytes of data from the input stream into an array of bytes. Returns the total number of
bytes read into the buffer otherwise ‐1 if it is end of file.
2 Public final int read(byte [] b)throws IOException
Reads some bytes from the inputstream an stores in to the byte array. Returns the total number of bytes
read into the buffer otherwise ‐1 if it is end of file.
3 (a) public final Boolean readBooolean()throws IOException,
(b) public final byte readByte()throws IOException,
(c) public final short readShort()throws IOException
(d) public final Int readInt()throws IOException
These methods will read the bytes from the contained InputStream. Returns the next two bytes of the
InputStream as the specific primitive type.
4 public String readLine() throws IOException
Reads the next line of text from the input stream. It reads successive bytes, converting each byte
separately into a character, until it encounters a line terminator or end of file; the characters read are
then returned as a String.
EXAMPLE
Following is the example to demonstrate DataInputStream. This example reads 5 lines given in a file test.txt
and convert those lines into capital letters and finally copies them into another file test1.txt.
import java.io.*;
String count;
while((count = d.readLine()) != null){
String u = count.toUpperCase();
System.out.println(u);
out.writeBytes(u + " ,");
}
d.close();
out.close();
}
}
Here is the sample run of the above program:
THIS IS TEST 1 ,
THIS IS TEST 2 ,
THIS IS TEST 3 ,
THIS IS TEST 4 ,
THIS IS TEST 5 ,
FILEOUTPUTSTREAM
FileOutputStream is used to create a file and write data into it. The stream would create a file, if it
doesn't already exist, before opening it for output.
Here are two constructors which can be used to create a FileOutputStream object.
Following constructor takes a file name as a string to create an input stream object to write the file:
Following constructor takes a file object to create an output stream object to write the file. First, we create a
file object using File() method as follows:
Once you have OutputStream object in hand, then there is a list of helper methods, which can be used to write
to stream or to do other operations on the stream.
Methods with Description
1 public void close() throws IOException{}
This method closes the file output stream. Releases any system resources associated with the file. Throws
an IOException
2 protected void finalize()throws IOException {}
This method cleans up the connection to the file. Ensures that the close method of this file output stream
is called when there are no more references to this stream. Throws an IOException
3 public void write(int w)throws IOException{}
This methods writes the specified byte to the output stream
4 public void write(byte[] w)
Writes w.length bytes from the mentioned byte array to the OutputStream
EXAMPLE
Following is the example to demonstrate InputStream and OutputStream:
import java.io.*;
The above code would create file test.txt and would write given numbers in binary format. Same would be
output on the stdout screen.
DIRECTORIES
CREATING DIRECTORIES
There are two useful File utility methods, which can be used to create directories:
The mkdir( ) method creates a directory, returning true on success and false on failure. Failure indicates
that the path specified in the File object already exists, or that the directory cannot be created because the
entire path does not exist yet.
The mkdirs() method creates both a directory and all the parents of the directory.
Following example creates "/tmp/user/java/bin" directory:
import java.io.File;
Compile and execute above code to create "/tmp/user/java/bin".
NOTE
Java automatically takes care of path separators on UNIX and Windows as per conventions. If you use a forward
slash (/) on a Windows version of Java, the path will still resolve correctly.
READING DIRECTORIES
A directory is a File that contains a list of other files and directories. When you create a File object and it is a
directory, the isDirectory( ) method will return true.
You can call list( ) on that object to extract the list of other files and directories inside. The program shown here
illustrates how to use list( ) to examine the contents of a directory:
import java.io.File;
This would produce the following result:
Directory of /tmp
bin is a directory
lib is a directory
demo is a directory
test.txt is a file
README is a file
index.html is a file
include is a directory