Download Exceptions

Chapter 11
I/O and Exception Handling
Chapter 11  I/O and Exception Handling
1
Chapter Goals

To learn how to read and write text files

To learn how to throw exceptions

To be able to design your own exception classes

To understand the difference between checked and
unchecked exceptions

To learn how to catch exceptions

To know when and where to catch an exception
Chapter 11  I/O and Exception Handling
2
Reading Text Files

Simplest way to read text: use Scanner class

To read from a disk file, construct a FileReader

Then, use FileReader to construct Scanner object
FileReader reader = new FileReader("input.txt");
Scanner in = new Scanner(reader);
Use the Scanner methods to read data from file
 next, nextLine, nextInt and nextDouble
Chapter 11  I/O and Exception Handling
3
Writing Text Files

To write to a file, use a PrintWriter object
PrintWriter out = new PrintWriter("output.txt");


If file already exists, it is emptied before
the new data are written into it
If file doesn't exist, an empty file is created
Chapter 11  I/O and Exception Handling
4
Writing Text Files

Use print and println to write to a PrintWriter
out.println(29.95);
out.println(new Rectangle(5, 10, 15, 25));
out.println("Hello, World!");


You must close a file when you are done processing it
out.close();
Otherwise, not all of the output may be written to
the disk file
Chapter 11  I/O and Exception Handling
5
A Sample Program


Reads all lines of a file and sends them to the
output file, preceded by line numbers
Sample input file
Mary had a little lamb
Whose fleece was white as snow.
And everywhere that Mary went,
The lamb was sure to go!
Chapter 11  I/O and Exception Handling
6
A Sample Program

The program produces the output file
/*
/*
/*
/*

1
2
3
4
*/
*/
*/
*/
Mary had a little lamb
Whose fleece was white as snow.
And everywhere that Mary went,
The lamb was sure to go!
This program can be used to number the lines
of Java source files
Chapter 11  I/O and Exception Handling
7
File LineNumberer.java
01:
02:
03:
04:
05:
06:
07:
08:
09:
10:
11:
12:
13:
14:
15:
16:
17:
import
import
import
import
java.io.FileReader;
java.io.IOException;
java.io.PrintWriter;
java.util.Scanner;
public class LineNumberer
{
public static void main(String[] args)
{
Scanner console = new Scanner(System.in);
System.out.print("Input file: ");
String inputFileName = console.next();
System.out.print("Output file: ");
String outputFileName = console.next();
try
{
Chapter 11  I/O and Exception Handling
Continued…
8
File LineNumberer.java
18:
19:
20:
21:
22:
23:
24:
25:
26:
27:
28:
29:
30:
31:
32:
33:
FileReader reader = new FileReader(inputFileName);
Scanner in = new Scanner(reader);
PrintWriter out = new PrintWriter(outputFileName);
int lineNumber = 1;
while (in.hasNextLine())
{
String line = in.nextLine();
out.println("/* " + lineNumber + " */ " + line);
lineNumber++;
}
out.close();
}
catch (IOException exception)
{
Chapter 11  I/O and Exception Handling
Continued…
9
File LineNumberer.java
34:
35:
36:
37: }
System.out.println("Error processing file:"
+ exception);
}
}
Chapter 11  I/O and Exception Handling
10
Self Check
1.
What happens when you supply the same
name for the input and output files to the
LineNumberer program?
2.
What happens when you supply the name of a
nonexistent input file to the LineNumberer
program?
Chapter 11  I/O and Exception Handling
11
Answers
1.
When the PrintWriter object is created,
the output file is emptied, which is the same
file as the input file. The input file is now
empty and the while loop exits immediately.
2.
The program catches a
FileNotFoundException, prints an error
message, and terminates.
Chapter 11  I/O and Exception Handling
12
Command Line Arguments

Three different ways to run a program





Select “run” in compile environment
Click an icon
Type program name in terminal window
Last method is called invoking the program
from a command line
When program is invoked from command line,
you can provide more info to the program
Chapter 11  I/O and Exception Handling
13
Command Line Arguments


Programs accept command line arguments
For example, program could be written to allow user
to specify input and output files on command line:
java LineNumberer input.txt output.txt


Command line arguments are are placed in args
parameter of main
In this example


args[0] is “input.txt”
args[1] is “output.txt”
Chapter 11  I/O and Exception Handling
14
Command Line Arguments


It is up to the programmer to decide what to do
with command line arguments
It is customary to interpret arguments as follows



If it starts with a hyphen, it is an option
If it does not start with a hyphen, it is a file name
For example, could use -c if comment delimiters are
desired (e.g., if file is a program)
java LineNumberer -c HelloWorld.java HelloWorld.txt
Chapter 11  I/O and Exception Handling
15
Command Line Arguments

Example
for(String a : args)
{
if(a.startsWith(“-”)) // It’s an option
{
if (a.equals(“-c”) useCommentDelimiters = true;
}
else if (inputFileName == null) inputFileName = a;
else if (outputFileName == null) outputFileName = a;
}
Chapter 11  I/O and Exception Handling
16
Command Line Arguments

Are command line arguments a good idea?

It depends…



For casual or infrequent use, graphical user
interface (GUI) is much better
But for frequent use, GUI has some drawbacks
For example, hard to automate, so it is hard to
write a script to automate tasks
Chapter 11  I/O and Exception Handling
17
Therac-25 Incident




Computerized device used for radiation
treatment
Between 1985 and 1987 at least 6 people got
severe overdoses, some died
Cause was a bug in the program that
controlled the machine
See the text
Chapter 11  I/O and Exception Handling
18
Error Handling

Traditional approach:
 Method returns error code

Problem: Might forget to check for error
 Failure notification may go undetected

Problem: Calling method may not be able to do
anything about failure
 Program must fail --- let its caller worry about it
 Many method calls would need to be checked
Chapter 11  I/O and Exception Handling
19
Error Handling

Instead of programming for success…
x.doSomething()

…you would always program for failure
if (!x.doSomething()) return false;

But this might make code hard to read
Chapter 11  I/O and Exception Handling
20
Throwing Exceptions

In Java: Exceptions
 Cannot be overlooked
 Sent directly to an exception handler, not just
caller of failed method
“Throw” an exception object to signal an
exceptional condition
 Example: IllegalArgumentException

// illegal parameter value
IllegalArgumentException exception
= new IllegalArgumentException("Amount exceeds balance");
throw exception;
Chapter 11  I/O and Exception Handling
21
Throwing Exceptions

No need to store exception object in variable
throw new IllegalArgumentException("Amount exceeds balance");

When an exception is thrown, method
terminates immediately
 Execution continues with an exception handler
Chapter 11  I/O and Exception Handling
22
Example
public class BankAccount
{
public void withdraw(double amount)
{
if (amount > balance)
{
IllegalArgumentException exception
= new IllegalArgumentException("Amount
exceeds balance");
throw exception;
}
balance = balance - amount;
}
. . .
}
Chapter 11  I/O and Exception Handling
23
Hierarchy of Exception Classes
Figure 1:
The Hierarchy of Exception Classes
Chapter 11  I/O and Exception Handling
24
Syntax 15.1: Throwing an Exception
throw exceptionObject;
Example:
throw new IllegalArgumentException();
Purpose:
To throw an exception and transfer control to a handler for this
exception type
Chapter 11  I/O and Exception Handling
25
Self Check
1.
How should you modify the deposit method
to ensure that the balance is never negative?
2.
Suppose you modify withdraw to throw
exception if balance is negative. Then you
construct a new bank account object with a
zero balance and call withdraw(10). What
is the value of balance afterwards?
Chapter 11  I/O and Exception Handling
26
Answers
1.
Throw an exception if the amount being
deposited is less than zero.
2.
The balance is still zero because the last
statement of the withdraw method was
never executed.
Chapter 11  I/O and Exception Handling
27
Checked and Unchecked Exceptions

Two types of exceptions:
 checked and unchecked

Checked exceptions
 The compiler checks that you don't ignore them
 Caused by external circumstances that the
programmer cannot prevent
 Majority occur when dealing with I/O
 For example, IOException
Chapter 11  I/O and Exception Handling
28
Checked and Unchecked Exceptions

Two types of exceptions: checked, unchecked

Unchecked exceptions
 Extend the class RuntimeException or Error
 They are the programmer's “fault”
 Examples of runtime exceptions

NumberFormatException
IllegalArgumentException
NullPointerException
Example
of error: OutOfMemoryError
Chapter 11  I/O and Exception Handling
29
Checked and Unchecked Exceptions

Categories are not perfect
 Scanner.nextInt throws unchecked
InputMismatchException
 Programmer cannot prevent users from entering
incorrect input
 This choice makes the class easy to use for
beginning programmers

Checked exceptions arise mostly when
programming with files and streams
Chapter 11  I/O and Exception Handling
30
Checked and Unchecked Exceptions

For example, use a Scanner to read a file
String filename = . . .;
FileReader reader = new FileReader(filename);
Scanner in = new Scanner(reader);

But, FileReader constructor can throw a
FileNotFoundException
Chapter 11  I/O and Exception Handling
31
Checked and Unchecked Exceptions

Two choices…

Handle the exception or

Tell compiler that you want method to be terminated
when the exception occurs
 Use throws specifier; method throws a checked exception
public void read(String filename) throws FileNotFoundException
{
FileReader reader = new FileReader(filename);
Scanner in = new Scanner(reader);
. . .
}
Chapter 11  I/O and Exception Handling
32
Checked and Unchecked Exceptions

For multiple exceptions, use commas
public void read(String filename)
throws IOException, ClassNotFoundException


Exception inheritance hierarchy: for example, if
method can throw an IOException and
FileNotFoundException, only use IOException
Better to just throw exception than to handle it
incompetently
Chapter 11  I/O and Exception Handling
33
Syntax 15.2: Exception Specification
accessSpecifier returnType
methodName(parameterType parameterName, . . .)
throws ExceptionClass, ExceptionClass, . . .
Example:
public void read(BufferedReader in) throws IOException
Purpose:
To indicate the checked exceptions that this method can throw
Chapter 11  I/O and Exception Handling
34
Self Check
3.
Suppose a method calls the FileReader
constructor and the read method of the
FileReader class, which can throw an
IOException. Which throws specification
should you use?
4.
Why is a NullPointerException not a
checked exception?
Chapter 11  I/O and Exception Handling
35
Answer
3.
The specification throws IOException is
sufficient since FileNotFoundException
is a subclass of IOException
4.
Because programmers should simply check
for null pointers instead of trying to
handle a NullPointerException
Chapter 11  I/O and Exception Handling
36
Catching Exceptions



Install an exception handler with try/catch
statement
try block contains statements that may
cause an exception
catch clause contains handler for an
exception type
Chapter 11  I/O and Exception Handling
37
Catching Exceptions

Consider this example
String filename = . . .;
FileReader reader = new FileReader(filename);
Scanner in = new Scanner(reader);
String input = in.next();
int value = Integer.parseInt(input);
. . .
 Three possible exceptions
 FileReader can throw FileNotFoundException
 Scanner.Next can throw NoSuchElementException
 Integer.parseInt throws NumberFormatException
Chapter 11  I/O and Exception Handling
38
Catching Exceptions

Example
of try,
catch
try
{
String filename = . . .;
FileReader reader = new FileReader(filename);
Scanner in = new Scanner(reader);
String input = in.next();
int value = Integer.parseInt(input);
. . .
}
catch (IOException exception)
{
exception.printStackTrace();
}
catch (NumberFormatException exception)
{
System.out.println("Input was not a number");
}
Chapter 11  I/O and Exception Handling
39
Catching Exceptions




Statements in try block are executed
If no exceptions occur, catch clauses are
skipped
If exception of matching type occurs,
execution jumps to catch clause
If exception of another type occurs, it is
thrown, to be caught by another try block
Chapter 11  I/O and Exception Handling
40
Catching Exceptions

catch (IOException exception)
 exception contains reference to the exception
object that was thrown
 catch clause can analyze object to find out more
details
 exception.printStackTrace() printout of
chain of method calls that lead to exception
Chapter 11  I/O and Exception Handling
41
Syntax 15.3: General Try Block
try
{
statement
statement
. . .
}
catch (ExceptionClass exceptionObject)
{
statement
statement
. . .
}
catch (ExceptionClass exceptionObject)
{
statement
statement
. . .
}
. . .
Chapter 11  I/O and Exception Handling
Continued…
42
Syntax 15.3: General Try Block
Example:
try
{
System.out.println("How old are you?");
int age = in.nextInt();
System.out.println("Next year, you'll be " + (age + 1));
}
catch (InputMismatchException exception)
{
exception.printStackTrace();
}
Purpose:
To execute one or more statements that may generate exceptions.
If an exception occurs and it matches one of the catch clauses,
execute the first one that matches. If no exception occurs, or an
exception is thrown that doesn't match any catch clause, then skip
the catch clauses.
Chapter 11  I/O and Exception Handling
43
Self Check
5.
Suppose the file with the given file name
exists and has no contents. Trace the flow
of execution in the try block in this section.
6.
Is there a difference between catching
checked and unchecked exceptions?
Chapter 11  I/O and Exception Handling
44
Answers
5.
The FileReader constructor succeeds, and
it is constructed. Then the call in.next()
throws a NoSuchElementException, and the
try block is terminated. None of the catch
clauses match, so none are executed. If none
of the enclosing method calls catch the
exception, the program terminates.
Chapter 11  I/O and Exception Handling
45
Answers
6.
No, you catch both exception types in the
same way, as you can see from the previous
example, since IOException is a checked
exception and NumberFormatException is an
unchecked exception.
Chapter 11  I/O and Exception Handling
46
The finally clause

Exception terminates current method

Danger: Program can skip over essential code

Example
reader = new FileReader(filename);
Scanner in = new Scanner(reader);
readData(in);
reader.close();// May never get here
Chapter 11  I/O and Exception Handling
47
The finally clause


Must execute reader.close() even if
exception occurs
Use finally clause for code that must be
executed "no matter what"
Chapter 11  I/O and Exception Handling
48
The finally clause
FileReader reader = new FileReader(filename);
try
{
Scanner in = new Scanner(reader);
readData(in);
}
finally
{
reader.close();
}

If an exception occurs, finally clause is also
executed before exception is passed to its
handler, so file is always closed
Chapter 11  I/O and Exception Handling
49
The finally clause

Executed when try block is exited in any of 3 ways:
 After last statement of try block
 After last statement of catch clause, if this try block
caught an exception
 When an exception was thrown in try block and not caught

Recommendation: do not mix catch and finally
clauses in same try block
 See example in textbook
Chapter 11  I/O and Exception Handling
50
Syntax 15.4: The finally clause
try
{
statement
statement
. . .
}
finally
{
statement
statement
. . .
}
Chapter 11  I/O and Exception Handling
Continued…
51
Syntax 15.4: The finally clause
Example:
FileReader reader = new FileReader(filename);
try
{
readData(reader);
}
finally
{
reader.close();
}
Purpose:
To ensure that the statements in the finally clause are executed
whether or not the statements in the try block throw an exception.
Chapter 11  I/O and Exception Handling
52
Self Check
7.
Why was the reader variable declared
outside the try block?
8.
Suppose the file with the given name does
not exist. Trace the flow of execution of the
code segment in this section.
Chapter 11  I/O and Exception Handling
53
Answers
7.
If it had been declared inside the try block, its
scope would only have extended to the end of the
try block, and the catch clause could not have
closed it.
8.
The FileReader constructor throws an exception.
The finally clause is executed. Since reader is
null, the call to close is not executed. Next, a
catch clause that matches the
FileNotFoundException is located. If none
exists, the program terminates.
Chapter 11  I/O and Exception Handling
54
Designing Your Own Execution
Types

You can design your own exception types,
subclasses of Exception or
RuntimeException


if (amount > balance)
{
throw new InsufficientFundsException(
"withdrawal of " + amount + " exceeds balance of
“ + balance);
}
Make it checked or unchecked exception?
Chapter 11  I/O and Exception Handling
55
Designing Your Own Execution
Types

Make it unchecked exception



Programmer could have called getBalance first
Extend RuntimeException or one of its
subclasses
Supply two constructors
1. Default (do nothing) constructor
2. A constructor that accepts a message string
describing reason for exception
Chapter 11  I/O and Exception Handling
56
Designing Your Own Execution
Types
public class InsufficientFundsException
extends RuntimeException
{
public InsufficientFundsException() {}
public InsufficientFundsException(String message)
{
super(message);
}
}
Chapter 11  I/O and Exception Handling
57
Self Check
9.
What is the purpose of the call
super(message) in the second
InsufficientFundsException
constructor?
10.
Suppose you read bank account data from a
file. Contrary to your expectation, the next
input value is not of type double. You
decide to implement a BadDataException.
Which exception class should you extend?
Chapter 11  I/O and Exception Handling
58
Answers
9.
To pass the exception message string to
the RuntimeException superclass.
10.
Exception or IOException are both
good choices. Because file corruption is
beyond the control of the programmer,
this should be a checked exception, so it
would be wrong to extend
RuntimeException.
Chapter 11  I/O and Exception Handling
59
A Complete Program

Program does the following…

Asks user for name of file

File expected to contain data values

First line of file contains total number of values

Remaining lines contain the data

Typical input file:
3
1.45
-2.1
0.05
Chapter 11  I/O and Exception Handling
60
A Complete Program

What can go wrong?
 File might not exist
 File might have data in wrong format

Who can detect the faults?
 FileReader constructor will throw an exception
when file does not exist
 Methods that process input need to throw
exception if they find error in data format
Chapter 11  I/O and Exception Handling
61
A Complete Program

What exceptions can be thrown?
 FileNotFoundException can be thrown by
FileReader constructor
 IOException can be thrown by close method of
FileReader
 BadDataException, a custom checked exception
class
Chapter 11  I/O and Exception Handling
62
A Complete Program

Who can remedy the faults that the
exceptions report?
 Only the main method of DataSetTester
program interacts with user

In this example, main method should
 Catch exceptions
 Print appropriate error messages
 Give user another chance to enter a correct file
Chapter 11  I/O and Exception Handling
63
File DataSetTester.java
01:
02:
03:
04:
05:
06:
07:
08:
09:
10:
11:
12:
13:
14:
15:
16:
import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.Scanner;
public class DataSetTester
{
public static void main(String[] args)
{
Scanner in = new Scanner(System.in);
DataSetReader reader = new DataSetReader();
boolean done = false;
while (!done)
{
try
{
Chapter 11  I/O and Exception Handling
Continued…
64
File DataSetTester.java
17:
18:
19:
20:
21:
22:
23:
24:
25:
26:
27:
28:
29:
30:
31:
32:
System.out.println("Please enter the file name: ");
String filename = in.next();
double[] data = reader.readFile(filename);
double sum = 0;
for (double d : data) sum = sum + d;
System.out.println("The sum is " + sum);
done = true;
}
catch (FileNotFoundException exception)
{
System.out.println("File not found.");
}
catch (BadDataException exception)
{
System.out.println
("Bad data: " + exception.getMessage());
Continued…
Chapter 11  I/O and Exception Handling
65
File DataSetTester.java
33:
34:
35:
36:
37:
38:
39:
40: }
}
catch (IOException exception)
{
exception.printStackTrace();
}
}
}
Chapter 11  I/O and Exception Handling
66
The readFile method of the
DataSetReader class

Constructs Scanner object

Calls readData method

Completely unconcerned with any exceptions
 Exceptions may occur, but this is not a good place to
catch them
Chapter 11  I/O and Exception Handling
67
The readFile method of the
DataSetReader class

If there is a problem with input file, it simply
passes the exception to caller
public double[] readFile(String filename)
throws IOException, BadDataException
// FileNotFoundException is an IOException
{
FileReader reader = new FileReader(filename);
try
{
Scanner in = new Scanner(reader);
readData(in);
}
Chapter 11  I/O and Exception Handling
Continued…
68
The readFile method of the
DataSetReader class
finally
{
reader.close();
}
return data;
}
Chapter 11  I/O and Exception Handling
69
The readData method of the
DataSetReader class

Reads
the
number
of
values
private void readData(Scanner in) throws BadDataException
{
if (!in.hasNextInt())
throw new BadDataException("Length expected");
int numberOfValues = in.nextInt();
data = new double[numberOfValues];
for (int i = 0; i < numberOfValues; i++)
readValue(in, i);
if (in.hasNext())
throw new BadDataException("End of file expected");
}

Constructs an array

Calls readValue for each data value
Chapter 11  I/O and Exception Handling
70
The readData method of the
DataSetReader class

Checks for two potential errors
1. File might not start with an integer
2. File might have additional data after
reading all values

Makes no attempt to catch any
exceptions
Chapter 11  I/O and Exception Handling
71
The readValue method of the
DataSetReader class
private void readValue(Scanner in, int i)
throws BadDataException
{
if (!in.hasNextDouble())
throw new BadDataException("Data value expected");
data[i] = in.nextDouble();
}
Chapter 11  I/O and Exception Handling
72
Scenario
1.
DataSetTester.main calls
DataSetReader.readFile
2.
readFile calls readData
3.
readData calls readValue
4.
readValue doesn't find expected value
and throws BadDataException
5.
readValue has no handler for exception
and terminates
Chapter 11  I/O and Exception Handling
73
Scenario
6.
readData has no handler for exception
and terminates
7.
readFile has no handler for exception
and terminates after executing finally
clause
8.
DataSetTester.main has handler for
BadDataException; handler prints a
message, and user is given another chance
to enter file name
Chapter 11  I/O and Exception Handling
74
File DataSetReader.java
01:
02:
03:
04:
05:
06:
import java.io.FileReader;
import java.io.IOException;
import java.util.Scanner;
/**
Reads a data set from a file. The file must have
// the format
numberOfValues
value1
value2
. . .
07:
08:
09:
10:
11: */
12: public class DataSetReader
13: {
Chapter 11  I/O and Exception Handling
Continued…
75
File DataSetReader.java
14:
15:
16:
17:
18:
19:
20:
21:
22:
23:
24:
25:
26:
27:
28:
29:
30:
31:
/**
Reads a data set.
@param filename the name of file holding the data
@return the data in the file
*/
public double[] readFile(String filename)
throws IOException, BadDataException
{
FileReader reader = new FileReader(filename);
try
{
Scanner in = new Scanner(reader);
readData(in);
}
finally
{
reader.close();
}
Continued…
Chapter 11  I/O and Exception Handling
76
File DataSetReader.java
32:
33:
34:
35:
36:
37:
38:
39:
40:
41:
42:
43:
44:
45:
46:
47:
return data;
}
/**
Reads all data.
@param in the scanner that scans the data
*/
private void readData(Scanner in) throws BadDataException
{
if (!in.hasNextInt())
throw new BadDataException("Length expected");
int numberOfValues = in.nextInt();
data = new double[numberOfValues];
for (int i = 0; i < numberOfValues; i++)
readValue(in, i);
Chapter 11  I/O and Exception Handling
Continued…
77
File DataSetReader.java
48:
49:
50:
51:
52:
53:
54:
55:
56:
57:
58:
59:
if (in.hasNext())
throw new BadDataException("End of file expected");
}
/**
Reads one data value.
@param in the scanner that scans the data
@param i the position of the value to read
*/
private void readValue(Scanner in, int i)
throws BadDataException
{
Chapter 11  I/O and Exception Handling
Continued…
78
File DataSetReader.java
60:
61:
62:
63:
64:
65:
66: }
if (!in.hasNextDouble())
throw new BadDataException("Data value expected");
data[i] = in.nextDouble();
}
private double[] data;
Chapter 11  I/O and Exception Handling
79
Self Check
11.
Why doesn't the
DataSetReader.readFile method catch
any exceptions?
12.
Suppose the user specifies a file that
exists and is empty. Trace the flow of
execution.
Chapter 11  I/O and Exception Handling
80
Answers
11.
It would not be able to do much with them.
The DataSetReader class is a reusable
class that may be used for systems with
different languages and different user
interfaces. Thus, it cannot engage in a
dialog with the program user.
Chapter 11  I/O and Exception Handling
81
Answers
12.
DataSetTester.main calls
DataSetReader.readFile, which calls
readData. The call in.hasNextInt()
returns false, and readData throws a
BadDataException. The readFile
method doesn't catch it, so it propagates
back to main, where it is caught.
Chapter 11  I/O and Exception Handling
82