![2.1. THE BASIC JAVA APPLICATION 21
now:
// A program to display the message
// "Hello World!" on standard output
public class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello World!");
}
} // end of class HelloWorld
The command that actually displays the message is:
System.out.println("Hello World!");
This command is an example of a subroutine call statement. It uses a “built-in subroutine”
named System.out.println to do the actual work. Recall that a subroutine consists of the
instructions for performing some task, chunked together and given a name. That name can be
used to “call” the subroutine whenever that task needs to be performed. A built-in subroutine
is one that is already defined as part of the language and therefore automatically available for
use in any program.
When you run this program, the message “Hello World!” (without the quotes) will be
displayed on standard output. Unfortunately, I can’t say exactly what that means! Java is
meant to run on many different platforms, and standard output will mean different things on
different platforms. However, you can expect the message to show up in some convenient place.
(If you use a command-line interface, like that in Sun Microsystem’s Java Development Kit,
you type in a command to tell the computer to run the program. The computer will type the
output from the program, Hello World!, on the next line.)
You must be curious about all the other stuff in the above program. Part of it consists of
comments. Comments in a program are entirely ignored by the computer; they are there for
human readers only. This doesn’t mean that they are unimportant. Programs are meant to be
read by people as well as by computers, and without comments, a program can be very difficult
to understand. Java has two types of comments. The first type, used in the above program,
begins with // and extends to the end of a line. The computer ignores the // and everything
that follows it on the same line. Java has another style of comment that can extend over many
lines. That type of comment begins with /* and ends with */.
Everything else in the program is required by the rules of Java syntax. All programming in
Java is done inside “classes.” The first line in the above program (not counting the comments)
says that this is a class named HelloWorld. “HelloWorld,” the name of the class, also serves as
the name of the program. Not every class is a program. In order to define a program, a class
must include a subroutine named main, with a definition that takes the form:
public static void main(String[] args) {
hstatementsi
}
When you tell the Java interpreter to run the program, the interpreter calls the main()
subroutine, and the statements that it contains are executed. These statements make up the
script that tells the computer exactly what to do when the program is executed. The main()
routine can call subroutines that are defined in the same class or even in other classes, but it is
the main() routine that determines how and in what order the other subroutines are used.](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-37-320.jpg)
![22 CHAPTER 2. NAMES AND THINGS
The word “public” in the first line of main() means that this routine can be called from out-
side the program. This is essential because the main() routine is called by the Java interpreter,
which is something external to the program itself. The remainder of the first line of the routine
is harder to explain at the moment; for now, just think of it as part of the required syntax.
The definition of the subroutine—that is, the instructions that say what it does—consists of
the sequence of “statements” enclosed between braces, { and }. Here, I’ve used hstatementsi as
a placeholder for the actual statements that make up the program. Throughout this textbook,
I will always use a similar format: anything that you see in hthis style of texti (italic in angle
brackets) is a placeholder that describes something you need to type when you write an actual
program.
As noted above, a subroutine can’t exist by itself. It has to be part of a “class”. A program
is defined by a public class that takes the form:
public class hprogram-namei {
hoptional-variable-declarations-and-subroutinesi
public static void main(String[] args) {
hstatementsi
}
hoptional-variable-declarations-and-subroutinesi
}
The name on the first line is the name of the program, as well as the name of the class. If the
name of the class is HelloWorld, then the class must be saved in a file called HelloWorld.java.
When this file is compiled, another file named HelloWorld.class will be produced. This class
file, HelloWorld.class, contains the Java bytecode that is executed by a Java interpreter.
HelloWorld.java is called the source code for the program. To execute the program, you
only need the compiled class file, not the source code.
The layout of the program on the page, such as the use of blank lines and indentation, is
not part of the syntax or semantics of the language. The computer doesn’t care about layout—
you could run the entire program together on one line as far as it is concerned. However,
layout is important to human readers, and there are certain style guidelines for layout that are
followed by most programmers. These style guidelines are part of the pragmatics of the Java
programming language.
Also note that according to the above syntax specification, a program can contain other
subroutines besides main(), as well as things called “variable declarations.” You’ll learn more
about these later, but not until Chapter 4.
2.2 Variables and the Primitive Types
Names are fundamental to programming. In programs, names are used to refer to many
different sorts of things. In order to use those things, a programmer must understand the rules
for giving names to things and the rules for using the names to work with those things. That
is, the programmer must understand the syntax and the semantics of names.
According to the syntax rules of Java, a name is a sequence of one or more characters. It must
begin with a letter or underscore and must consist entirely of letters, digits, and underscores.
(“Underscore” refers to the character ’ ’.) For example, here are some legal names:
N n rate x15 quite a long name HelloWorld](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-38-320.jpg)
![2.2. VARIABLES AND TYPES 27
2.2.3 Variables in Programs
A variable can be used in a program only if it has first been declared. A variable declaration
statement is used to declare one or more variables and to give them names. When the computer
executes a variable declaration, it sets aside memory for the variable and associates the variable’s
name with that memory. A simple variable declaration takes the form:
htype-namei hvariable-name-or-namesi;
The hvariable-name-or-namesi can be a single variable name or a list of variable names
separated by commas. (We’ll see later that variable declaration statements can actually be
somewhat more complicated than this.) Good programming style is to declare only one variable
in a declaration statement, unless the variables are closely related in some way. For example:
int numberOfStudents;
String name;
double x, y;
boolean isFinished;
char firstInitial, middleInitial, lastInitial;
It is also good style to include a comment with each variable declaration to explain its
purpose in the program, or to give other information that might be useful to a human reader.
For example:
double principal; // Amount of money invested.
double interestRate; // Rate as a decimal, not percentage.
In this chapter, we will only use variables declared inside the main() subroutine of a pro-
gram. Variables declared inside a subroutine are called local variables for that subroutine.
They exist only inside the subroutine, while it is running, and are completely inaccessible from
outside. Variable declarations can occur anywhere inside the subroutine, as long as each variable
is declared before it is used in any expression. Some people like to declare all the variables at
the beginning of the subroutine. Others like to wait to declare a variable until it is needed. My
preference: Declare important variables at the beginning of the subroutine, and use a comment
to explain the purpose of each variable. Declare “utility variables” which are not important to
the overall logic of the subroutine at the point in the subroutine where they are first used. Here
is a simple program using some variables and assignment statements:
/**
* This class implements a simple program that
* will compute the amount of interest that is
* earned on $17,000 invested at an interest
* rate of 0.07 for one year. The interest and
* the value of the investment after one year are
* printed to standard output.
*/
public class Interest {
public static void main(String[] args) {
/* Declare the variables. */
double principal; // The value of the investment.
double rate; // The annual interest rate.
double interest; // Interest earned in one year.](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-43-320.jpg)
![32 CHAPTER 2. NAMES AND THINGS
/**
* This program performs some mathematical computations and displays
* the results. It then reports the number of seconds that the
* computer spent on this task.
*/
public class TimedComputation {
public static void main(String[] args) {
long startTime; // Starting time of program, in milliseconds.
long endTime; // Time when computations are done, in milliseconds.
double time; // Time difference, in seconds.
startTime = System.currentTimeMillis();
double width, height, hypotenuse; // sides of a triangle
width = 42.0;
height = 17.0;
hypotenuse = Math.sqrt( width*width + height*height );
System.out.print("A triangle with sides 42 and 17 has hypotenuse ");
System.out.println(hypotenuse);
System.out.println("nMathematically, sin(x)*sin(x) + "
+ "cos(x)*cos(x) - 1 should be 0.");
System.out.println("Let’s check this for x = 1:");
System.out.print(" sin(1)*sin(1) + cos(1)*cos(1) - 1 is ");
System.out.println( Math.sin(1)*Math.sin(1)
+ Math.cos(1)*Math.cos(1) - 1 );
System.out.println("(There can be round-off errors when"
+ " computing with real numbers!)");
System.out.print("nHere is a random number: ");
System.out.println( Math.random() );
endTime = System.currentTimeMillis();
time = (endTime - startTime) / 1000.0;
System.out.print("nRun time in seconds was: ");
System.out.println(time);
} // end main()
} // end class TimedComputation
2.3.2 Operations on Strings
A value of type String is an object. That object contains data, namely the sequence of characters
that make up the string. It also contains subroutines. All of these subroutines are in fact
functions. For example, every string object contains a function named length that computes
the number of characters in that string. Suppose that advice is a variable that refers to a
String. For example, advice might have been declared and assigned a value as follows:
String advice;
advice = "Seize the day!";](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-48-320.jpg)
![36 CHAPTER 2. NAMES AND THINGS
public class EnumDemo {
// Define two enum types -- remember that the definitions
// go OUTSIDE The main() routine!
enum Day { SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY }
enum Month { JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP, OCT, NOV, DEC }
public static void main(String[] args) {
Day tgif; // Declare a variable of type Day.
Month libra; // Declare a variable of type Month.
tgif = Day.FRIDAY; // Assign a value of type Day to tgif.
libra = Month.OCT; // Assign a value of type Month to libra.
System.out.print("My sign is libra, since I was born in ");
System.out.println(libra); // Output value will be: OCT
System.out.print("That’s the ");
System.out.print( libra.ordinal() );
System.out.println("-th month of the year.");
System.out.println(" (Counting from 0, of course!)");
System.out.print("Isn’t it nice to get to ");
System.out.println(tgif); // Output value will be: FRIDAY
System.out.println( tgif + " is the " + tgif.ordinal()
+ "-th day of the week.");
// You can concatenate enum values onto Strings!
}
}
2.4 Text Input and Output
For some unfathomable reason, Java has never made it easy to read data typed in
by the user of a program. You’ve already seen that output can be displayed to the user
using the subroutine System.out.print. This subroutine is part of a pre-defined object called
System.out. The purpose of this object is precisely to display output to the user. There is
a corresponding object called System.in that exists to read data input by the user, but it
provides only very primitive input facilities, and it requires some advanced Java programming
skills to use it effectively.
Java 5.0 finally makes input a little easier with a new Scanner class. However, it requires
some knowledge of object-oriented programming to use this class, so it’s not appropriate for
use here at the beginning of this course. (Furthermore, in my opinion, Scanner still does not
get things quite right.)
There is some excuse for this lack of concern with input, since Java is meant mainly to
write programs for Graphical User Interfaces, and those programs have their own style of
input/output, which is implemented in Java. However, basic support is needed for input/output
in old-fashioned non-GUI programs. Fortunately, it is possible to extend Java by creating new
classes that provide subroutines that are not available in the standard part of the language.
As soon as a new class is available, the subroutines that it contains can be used in exactly the
same way as built-in routines.](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-52-320.jpg)
![2.4. TEXT INPUT AND OUTPUT 37
Along these lines, I’ve written a class called TextIO that defines subroutines for reading
values typed by the user of a non-GUI program. The subroutines in this class make it possible
to get input from the standard input object, System.in, without knowing about the advanced
aspects of Java that are needed to use Scanner or to use System.in directly. TextIO also
contains a set of output subroutines. The output subroutines are similar to those provided in
System.out, but they provide a few additional features. You can use whichever set of output
subroutines you prefer, and you can even mix them in the same program.
To use the TextIO class, you must make sure that the class is available to your program.
What this means depends on the Java programming environment that you are using. In general,
you just have to add the source code file, TextIO.java, to the same directory that contains your
main program. See Section 2.6 for more information about how to use TextIO.
2.4.1 A First Text Input Example
The input routines in the TextIO class are static member functions. (Static member functions
were introduced in the previous section.) Let’s suppose that you want your program to read
an integer typed in by the user. The TextIO class contains a static member function named
getlnInt that you can use for this purpose. Since this function is contained in the TextIO class,
you have to refer to it in your program as TextIO.getlnInt. The function has no parameters,
so a complete call to the function takes the form “TextIO.getlnInt()”. This function call
represents the int value typed by the user, and you have to do something with the returned
value, such as assign it to a variable. For example, if userInput is a variable of type int
(created with a declaration statement “int userInput;”), then you could use the assignment
statement
userInput = TextIO.getlnInt();
When the computer executes this statement, it will wait for the user to type in an integer
value. The value typed will be returned by the function, and it will be stored in the variable,
userInput. Here is a complete program that uses TextIO.getlnInt to read a number typed
by the user and then prints out the square of the number that the user types:
/**
* A program that reads an integer that is typed in by the
* user and computes and prints the square of that integer.
*/
public class PrintSquare {
public static void main(String[] args) {
int userInput; // The number input by the user.
int square; // The userInput, multiplied by itself.
System.out.print("Please type a number: ");
userInput = TextIO.getlnInt();
square = userInput * userInput;
System.out.print("The square of that number is ");
System.out.println(square);
} // end of main()
} //end of class PrintSquare](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-53-320.jpg)
![2.4. TEXT INPUT AND OUTPUT 41
distinguished by having different names.)
∗ ∗ ∗
Using TextIO for input and output, we can now improve the program from Section 2.2 for
computing the value of an investment. We can have the user type in the initial value of the
investment and the interest rate. The result is a much more useful program—for one thing, it
makes sense to run it more than once!
/**
* This class implements a simple program that will compute
* the amount of interest that is earned on an investment over
* a period of one year. The initial amount of the investment
* and the interest rate are input by the user. The value of
* the investment at the end of the year is output. The
* rate must be input as a decimal, not a percentage (for
* example, 0.05 rather than 5).
*/
public class Interest2 {
public static void main(String[] args) {
double principal; // The value of the investment.
double rate; // The annual interest rate.
double interest; // The interest earned during the year.
TextIO.put("Enter the initial investment: ");
principal = TextIO.getlnDouble();
TextIO.put("Enter the annual interest rate (decimal, not percentage!): ");
rate = TextIO.getlnDouble();
interest = principal * rate; // Compute this year’s interest.
principal = principal + interest; // Add it to principal.
TextIO.put("The value of the investment after one year is $");
TextIO.putln(principal);
} // end of main()
} // end of class Interest2
2.4.4 Formatted Output
If you ran the preceding Interest2 example, you might have noticed that the answer is not
always written in the format that is usually used for dollar amounts. In general, dollar amounts
are written with two digits after the decimal point. But the program’s output can be a number
like 1050.0 or 43.575. It would be better if these numbers were printed as 1050.00 and 43.58.
Java 5.0 introduced a formatted output capability that makes it much easier than it used
to be to control the format of output numbers. A lot of formatting options are available. I will
cover just a few of the simplest and most commonly used possibilities here.
You can use the function System.out.printf to produce formatted output. (The name
“printf,” which stands for “print formatted,” is copied from the C and C++ programming
languages, which have always have a similar formatting capability). System.out.printf takes
two or more parameters. The first parameter is a String that specifies the format of the output.
This parameter is called the format string. The remaining parameters specify the values that](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-57-320.jpg)
![2.4. TEXT INPUT AND OUTPUT 43
value of y for the second %d, and the value of the expression x*y for the third, so the output
would be something like “The product of 17 and 42 is 714” (quotation marks not included in
output!).
2.4.5 Introduction to File I/O
System.out sends its output to the output destination known as “standard output.” But stan-
dard output is just one possible output destination. For example, data can be written to a file
that is stored on the user’s hard drive. The advantage to this, of course, is that the data is
saved in the file even after the program ends, and the user can print the file, email it to someone
else, edit it with another program, and so on.
TextIO has the ability to write data to files and to read data from files. When you write
output using the put, putln, or putf method in TextIO, the output is sent to the current
output destination. By default, the current output destination is standard output. However,
TextIO has some subroutines that can be used to change the current output destination. To
write to a file named “result.txt”, for example, you would use the statement:
TextIO.writeFile("result.txt");
After this statement is executed, any output from TextIO output statements will be sent to the
file named “result.txt” instead of to standard output. The file should be created in the same
directory that contains the program. Note that if a file with the same name already exists, its
previous contents will be erased! In many cases, you want to let the user select the file that
will be used for output. The statement
TextIO.writeUserSelectedFile();
will open a typical graphical-user-interface file selection dialog where the user can specify the
output file. If you want to go back to sending output to standard output, you can say
TextIO.writeStandardOutput();
You can also specify the input source for TextIO’s various “get” functions. The default input
source is standard input. You can use the statement TextIO.readFile("data.txt") to read
from a file named “data.txt” instead, or you can let the user select the input file by saying
TextIO.readUserSelectedFile(), and you can go back to reading from standard input with
TextIO.readStandardInput().
When your program is reading from standard input, the user gets a chance to correct any
errors in the input. This is not possible when the program is reading from a file. If illegal data
is found when a program tries to read from a file, an error occurs that will crash the program.
(Later, we will see that is is possible to “catch” such errors and recover from them.) Errors can
also occur, though more rarely, when writing to files.
A complete understanding of file input/output in Java requires a knowledge of object ori-
ented programming. We will return to the topic later, in Chapter 11. The file I/O capabilities
in TextIO are rather primitive by comparison. Nevertheless, they are sufficient for many appli-
cations, and they will allow you to get some experience with files sooner rather than later.
As a simple example, here is a program that asks the user some questions and outputs the
user’s responses to a file named “profile.txt”:
public class CreateProfile {
public static void main(String[] args) {](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-59-320.jpg)
![64 CHAPTER 3. CONTROL
public class Interest3 {
/*
This class implements a simple program that
will compute the amount of interest that is
earned on an investment over a period of
5 years. The initial amount of the investment
and the interest rate are input by the user.
The value of the investment at the end of each
year is output.
*/
public static void main(String[] args) {
double principal; // The value of the investment.
double rate; // The annual interest rate.
/* Get the initial investment and interest rate from the user. */
TextIO.put("Enter the initial investment: ");
principal = TextIO.getlnDouble();
TextIO.put("Enter the annual interest rate: ");
rate = TextIO.getlnDouble();
/* Simulate the investment for 5 years. */
int years; // Counts the number of years that have passed.
years = 0;
while (years < 5) {
double interest; // Interest for this year.
interest = principal * rate;
principal = principal + interest; // Add it to principal.
years = years + 1; // Count the current year.
System.out.print("The value of the investment after ");
System.out.print(years);
System.out.print(" years is $");
System.out.printf("%1.2f", principal);
System.out.println();
} // end of while loop
} // end of main()
} // end of class Interest3
You should study this program, and make sure that you understand what the computer does
step-by-step as it executes the while loop.
3.1.3 The Basic If Statement
An if statement tells the computer to take one of two alternative courses of action, depending
on whether the value of a given boolean-valued expression is true or false. It is an example of
a “branching” or “decision” statement. An if statement has the form:](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-80-320.jpg)
![3.2. ALGORITHM DEVELOPMENT 71
number input by the user is also non-positive. The if statement is only executed once, so the
second input number is never tested. With the while loop, after the second number is input,
the computer jumps back to the beginning of the loop and tests whether the second number
is positive. If not, it asks the user for a third number, and it will continue asking for numbers
until the user enters an acceptable input.)
Here is a Java program implementing this algorithm. It uses the operators <= to mean “is
less than or equal to” and != to mean “is not equal to.” To test whether N is even, it uses
“N % 2 == 0”. All the operators used here were discussed in Section 2.5.
/**
* This program prints out a 3N+1 sequence starting from a positive
* integer specified by the user. It also counts the number of
* terms in the sequence, and prints out that number.
*/
public class ThreeN1 {
public static void main(String[] args) {
int N; // for computing terms in the sequence
int counter; // for counting the terms
TextIO.put("Starting point for sequence: ");
N = TextIO.getlnInt();
while (N <= 0) {
TextIO.put("The starting point must be positive. Please try again: ");
N = TextIO.getlnInt();
}
// At this point, we know that N > 0
counter = 0;
while (N != 1) {
if (N % 2 == 0)
N = N / 2;
else
N = 3 * N + 1;
TextIO.putln(N);
counter = counter + 1;
}
TextIO.putln();
TextIO.put("There were ");
TextIO.put(counter);
TextIO.putln(" terms in the sequence.");
} // end of main()
} // end of class ThreeN1
Two final notes on this program: First, you might have noticed that the first term of the
sequence—the value of N input by the user—is not printed or counted by this program. Is
this an error? It’s hard to say. Was the specification of the program careful enough to decide?
This is the type of thing that might send you back to the boss/professor for clarification. The
problem (if it is one!) can be fixed easily enough. Just replace the line “counter = 0” before
the while loop with the two lines:](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-87-320.jpg)
![3.3. WHILE AND DO..WHILE 75
Add the integer to the sum
Count it
Read an integer
Divide sum by count to get the average
Print out the average
Notice that I’ve rearranged the body of the loop. Since an integer is read before the loop, the
loop has to begin by processing that integer. At the end of the loop, the computer reads a new
integer. The computer then jumps back to the beginning of the loop and tests the integer that
it has just read. Note that when the computer finally reads the sentinel value, the loop ends
before the sentinel value is processed. It is not added to the sum, and it is not counted. This
is the way it’s supposed to work. The sentinel is not part of the data. The original algorithm,
even if it could have been made to work without priming, was incorrect since it would have
summed and counted all the integers, including the sentinel. (Since the sentinel is zero, the sum
would still be correct, but the count would be off by one. Such so-called off-by-one errors
are very common. Counting turns out to be harder than it looks!)
We can easily turn the algorithm into a complete program. Note that the program cannot
use the statement “average = sum/count;” to compute the average. Since sum and count
are both variables of type int, the value of sum/count is an integer. The average should be
a real number. We’ve seen this problem before: we have to convert one of the int values to
a double to force the computer to compute the quotient as a real number. This can be done
by type-casting one of the variables to type double. The type cast “(double)sum” converts
the value of sum to a real number, so in the program the average is computed as “average =
((double)sum) / count;”. Another solution in this case would have been to declare sum to
be a variable of type double in the first place.
One other issue is addressed by the program: If the user enters zero as the first input value,
there are no data to process. We can test for this case by checking whether count is still equal
to zero after the while loop. This might seem like a minor point, but a careful programmer
should cover all the bases.
Here is the program:
/*
* This program reads a sequence of positive integers input
* by the user, and it will print out the average of those
* integers. The user is prompted to enter one integer at a
* time. The user must enter a 0 to mark the end of the
* data. (The zero is not counted as part of the data to
* be averaged.) The program does not check whether the
* user’s input is positive, so it will actually work for
* both positive and negative input values.
*/
public class ComputeAverage {
public static void main(String[] args) {
int inputNumber; // One of the integers input by the user.
int sum; // The sum of the positive integers.
int count; // The number of positive integers.
double average; // The average of the positive integers.
/* Initialize the summation and counting variables. */
sum = 0;](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-91-320.jpg)
![84 CHAPTER 3. CONTROL
Finally, we can translate the algorithm into a complete Java program:
/**
* This program reads a positive integer from the user.
* It counts how many divisors that number has, and
* then it prints the result.
*/
public class CountDivisors {
public static void main(String[] args) {
int N; // A positive integer entered by the user.
// Divisors of this number will be counted.
int testDivisor; // A number between 1 and N that is a
// possible divisor of N.
int divisorCount; // Number of divisors of N that have been found.
int numberTested; // Used to count how many possible divisors
// of N have been tested. When the number
// reaches 1000000, a period is output and
// the value of numberTested is reset to zero.
/* Get a positive integer from the user. */
while (true) {
TextIO.put("Enter a positive integer: ");
N = TextIO.getlnInt();
if (N > 0)
break;
TextIO.putln("That number is not positive. Please try again.");
}
/* Count the divisors, printing a "." after every 1000000 tests. */
divisorCount = 0;
numberTested = 0;
for (testDivisor = 1; testDivisor <= N; testDivisor++) {
if ( N % testDivisor == 0 )
divisorCount++;
numberTested++;
if (numberTested == 1000000) {
TextIO.put(’.’);
numberTested = 0;
}
}
/* Display the result. */
TextIO.putln();
TextIO.putln("The number of divisors of " + N
+ " is " + divisorCount);
} // end main()
} // end class CountDivisors](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-100-320.jpg)
![3.4. THE FOR STATEMENT 87
public class ListLetters {
public static void main(String[] args) {
String str; // Line of text entered by the user.
int count; // Number of different letters found in str.
char letter; // A letter of the alphabet.
TextIO.putln("Please type in a line of text.");
str = TextIO.getln();
str = str.toUpperCase();
count = 0;
TextIO.putln("Your input contains the following letters:");
TextIO.putln();
TextIO.put(" ");
for ( letter = ’A’; letter <= ’Z’; letter++ ) {
int i; // Position of a character in str.
for ( i = 0; i < str.length(); i++ ) {
if ( letter == str.charAt(i) ) {
TextIO.put(letter);
TextIO.put(’ ’);
count++;
break;
}
}
}
TextIO.putln();
TextIO.putln();
TextIO.putln("There were " + count + " different letters.");
} // end main()
} // end class ListLetters
In fact, there is actually an easier way to determine whether a given letter occurs in a string,
str. The built-in function str.indexOf(letter) will return -1 if letter does not occur in
the string. It returns a number greater than or equal to zero if it does occur. So, we could
check whether letter occurs in str simply by checking “if (str.indexOf(letter) >= 0)”.
If we used this technique in the above program, we wouldn’t need a nested for loop. This gives
you a preview of how subroutines can be used to deal with complexity.
3.4.4 Enums and for-each Loops
Java 5.0 introduces a new “enhanced” form of the for loop that is designed to be convenient
for processing data structures. A data structure is a collection of data items, considered as
a unit. For example, a list is a data structure that consists simply of a sequence of items.
The enhanced for loop makes it easy to apply the same processing to every element of a list
or other data structure. Data structures are a major topic in computer science, but we won’t
encounter them in any serious way until Chapter 7. However, one of the applications of the
enhanced for loop is to enum types, and so we consider it briefly here. (Enums were introduced
in Subsection 2.3.3.)](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-103-320.jpg)
![3.5. THE IF STATEMENT 93
converting the user’s input into inches. From there, the number of inches can easily be con-
verted into feet, yards, and miles. Before converting into inches, we have to test the input to
determine which unit of measure the user has specified:
Let measurement = TextIO.getDouble()
Let units = TextIO.getlnWord()
if the units are inches
Let inches = measurement
else if the units are feet
Let inches = measurement * 12 // 12 inches per foot
else if the units are yards
Let inches = measurement * 36 // 36 inches per yard
else if the units are miles
Let inches = measurement * 12 * 5280 // 5280 feet per mile
else
The units are illegal!
Print an error message and stop processing
Let feet = inches / 12.0
Let yards = inches / 36.0
Let miles = inches / (12.0 * 5280.0)
Display the results
Since units is a String, we can use units.equals("inches") to check whether the spec-
ified unit of measure is “inches”. However, it would be nice to allow the units to be spec-
ified as “inch” or abbreviated to “in”. To allow these three possibilities, we can check if
(units.equals("inches") || units.equals("inch") || units.equals("in")). It would
also be nice to allow upper case letters, as in “Inches” or “IN”. We can do this by converting
units to lower case before testing it or by substituting the function units.equalsIgnoreCase
for units.equals.
In my final program, I decided to make things more interesting by allowing the user to enter
a whole sequence of measurements. The program will end only when the user inputs 0. To do
this, I just have to wrap the above algorithm inside a while loop, and make sure that the loop
ends when the user inputs a 0. Here’s the complete program:
/*
* This program will convert measurements expressed in inches,
* feet, yards, or miles into each of the possible units of
* measure. The measurement is input by the user, followed by
* the unit of measure. For example: "17 feet", "1 inch",
* "2.73 mi". Abbreviations in, ft, yd, and mi are accepted.
* The program will continue to read and convert measurements
* until the user enters an input of 0.
*/
public class LengthConverter {
public static void main(String[] args) {
double measurement; // Numerical measurement, input by user.
String units; // The unit of measure for the input, also
// specified by the user.
double inches, feet, yards, miles; // Measurement expressed in
// each possible unit of
// measure.](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-109-320.jpg)
![3.7. EXCEPTIONS AND TRY..CATCH 103
throws exceptions of type IllegalArgumentException, no matter what type of error it encounters.
For example, an exception will occur if an attempt is made to read from a file after all the data
in the file has already been read. In TextIO, the exception is of type IllegalArgumentException. If
you have a better response to file errors than to let the program crash, you can use a try..catch
to catch exceptions of type IllegalArgumentException.
For example, suppose that a file contains nothing but real numbers, and we want a program
that will read the numbers and find their sum and their average. Since it is unknown how many
numbers are in the file, there is the question of when to stop reading. One approach is simply
to try to keep reading indefinitely. When the end of the file is reached, an exception occurs.
This exception is not really an error—it’s just a way of detecting the end of the data, so we
can catch the exception and finish up the program. We can read the data in a while (true)
loop and break out of the loop when an exception occurs. This is an example of the somewhat
unusual technique of using an exception as part of the expected flow of control in a program.
To read from the file, we need to know the file’s name. To make the program more general,
we can let the user enter the file name, instead of hard-coding a fixed file name in the program.
However, it is possible that the user will enter the name of a file that does not exist. When
we use TextIO.readfile to open a file that does not exist, an exception of type IllegalArgu-
mentException occurs. We can catch this exception and ask the user to enter a different file
name. Here is a complete program that uses all these ideas:
/**
* This program reads numbers from a file. It computes the sum and
* the average of the numbers that it reads. The file should contain
* nothing but numbers of type double; if this is not the case, the
* output will be the sum and average of however many numbers were
* successfully read from the file. The name of the file will be
* input by the user.
*/
public class ReadNumbersFromFile {
public static void main(String[] args) {
while (true) {
String fileName; // The name of the file, to be input by the user.
TextIO.put("Enter the name of the file: ");
fileName = TextIO.getln();
try {
TextIO.readFile( fileName ); // Try to open the file for input.
break; // If that succeeds, break out of the loop.
}
catch ( IllegalArgumentException e ) {
TextIO.putln("Can’t read from the file "" + fileName + "".");
TextIO.putln("Please try again.n");
}
}
// At this point, TextIO is reading from the file.
double number; // A number read from the data file.
double sum; // The sum of all the numbers read so far.
int count; // The number of numbers that were read.
sum = 0;](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-119-320.jpg)
![114 CHAPTER 3. CONTROL
Quiz on Chapter 3
1. What is an algorithm?
2. Explain briefly what is meant by “pseudocode” and how is it useful in the development
of algorithms.
3. What is a block statement? How are block statements used in Java programs?
4. What is the main difference between a while loop and a do..while loop?
5. What does it mean to prime a loop?
6. Explain what is meant by an animation and how a computer displays an animation.
7. Write a for loop that will print out all the multiples of 3 from 3 to 36, that is: 3 6 9 12
15 18 21 24 27 30 33 36.
8. Fill in the following main() routine so that it will ask the user to enter an integer, read
the user’s response, and tell the user whether the number entered is even or odd. (You can
use TextIO.getInt() to read the integer. Recall that an integer n is even if n % 2 == 0.)
public static void main(String[] args) {
// Fill in the body of this subroutine!
}
9. Suppose that s1 and s2 are variables of type String, whose values are expected to be
string representations of values of type int. Write a code segment that will compute and
print the integer sum of those values, or will print an error message if the values cannot
successfully be converted into integers. (Use a try..catch statement.)
10. Show the exact output that would be produced by the following main() routine:
public static void main(String[] args) {
int N;
N = 1;
while (N <= 32) {
N = 2 * N;
System.out.println(N);
}
}
11. Show the exact output produced by the following main() routine:
public static void main(String[] args) {
int x,y;
x = 5;
y = 1;
while (x > 0) {
x = x - 1;
y = y * x;
System.out.println(y);
}
}](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-130-320.jpg)
![4.2. STATIC SUBROUTINES AND VARIABLES 121
// parameter-list includes two parameters whose names are
// "x" and "y", and the type of each of these parameters
// is "double".
. . . // Statements that define what lessThan does go here.
}
In the second example given here, getNextN is a non-static method, since its definition does
not include the modifier “static”—and so it’s not an example that we should be looking at in
this chapter! The other modifier shown in the examples is “public”. This modifier indicates
that the method can be called from anywhere in a program, even from outside the class where
the method is defined. There is another modifier, “private”, which indicates that the method
can be called only from inside the same class. The modifiers public and private are called
access specifiers. If no access specifier is given for a method, then by default, that method
can be called from anywhere in the “package” that contains the class, but not from outside
that package. (Packages were introduced in Subsection 2.6.4, and you’ll learn more about them
later in this chapter, in Section 4.5.) There is one other access modifier, protected, which will
only become relevant when we turn to object-oriented programming in Chapter 5.
Note, by the way, that the main() routine of a program follows the usual syntax rules for
a subroutine. In
public static void main(String[] args) { ... }
the modifiers are public and static, the return type is void, the subroutine name is main, and
the parameter list is “String[] args”. The only question might be about “String[]”, which
has to be a type if it is to match the syntax of a parameter list. In fact, String[] represents
a so-called “array type”, so the syntax is valid. We will cover arrays in Chapter 7. (The
parameter, args, represents information provided to the program when the main() routine is
called by the system. In case you know the term, the information consists of any “command-line
arguments” specified in the command that the user typed to run the program.)
You’ve already had some experience with filling in the implementation of a subroutine. In
this chapter, you’ll learn all about writing your own complete subroutine definitions, including
the interface part.
4.2.2 Calling Subroutines
When you define a subroutine, all you are doing is telling the computer that the subroutine
exists and what it does. The subroutine doesn’t actually get executed until it is called. (This
is true even for the main() routine in a class—even though you don’t call it, it is called by the
system when the system runs your program.) For example, the playGame() method given as
an example above could be called using the following subroutine call statement:
playGame();
This statement could occur anywhere in the same class that includes the definition of
playGame(), whether in a main() method or in some other subroutine. Since playGame()
is a public method, it can also be called from other classes, but in that case, you have to tell
the computer which class it comes from. Since playGame() is a static method, its full name
includes the name of the class in which it is defined. Let’s say, for example, that playGame() is
defined in a class named Poker. Then to call playGame() from outside the Poker class, you
would have to say
Poker.playGame();](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-137-320.jpg)
![4.2. STATIC SUBROUTINES AND VARIABLES 123
Tell the user the guess was low
else if the user’s guess is higher than computersNumber:
Tell the user the guess was high
With variable declarations added and translated into Java, this becomes the definition of the
playGame() routine. A random integer between 1 and 100 can be computed as (int)(100 *
Math.random()) + 1. I’ve cleaned up the interaction with the user to make it flow better.
static void playGame() {
int computersNumber; // A random number picked by the computer.
int usersGuess; // A number entered by user as a guess.
int guessCount; // Number of guesses the user has made.
computersNumber = (int)(100 * Math.random()) + 1;
// The value assigned to computersNumber is a randomly
// chosen integer between 1 and 100, inclusive.
guessCount = 0;
TextIO.putln();
TextIO.put("What is your first guess? ");
while (true) {
usersGuess = TextIO.getInt(); // Get the user’s guess.
guessCount++;
if (usersGuess == computersNumber) {
TextIO.putln("You got it in " + guessCount
+ " guesses! My number was " + computersNumber);
break; // The game is over; the user has won.
}
if (guessCount == 6) {
TextIO.putln("You didn’t get the number in 6 guesses.");
TextIO.putln("You lose. My number was " + computersNumber);
break; // The game is over; the user has lost.
}
// If we get to this point, the game continues.
// Tell the user if the guess was too high or too low.
if (usersGuess < computersNumber)
TextIO.put("That’s too low. Try again: ");
else if (usersGuess > computersNumber)
TextIO.put("That’s too high. Try again: ");
}
TextIO.putln();
} // end of playGame()
Now, where exactly should you put this? It should be part of the same class as the main()
routine, but not inside the main routine. It is not legal to have one subroutine physically
nested inside another. The main() routine will call playGame(), but not contain it physically.
You can put the definition of playGame() either before or after the main() routine. Java is not
very picky about having the members of a class in any particular order.
It’s pretty easy to write the main routine. You’ve done things like this before. Here’s what
the complete program looks like (except that a serious program needs more comments than I’ve
included here).
public class GuessingGame {
public static void main(String[] args) {
TextIO.putln("Let’s play a game. I’ll pick a number between");
TextIO.putln("1 and 100, and you try to guess it.");](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-139-320.jpg)
![126 CHAPTER 4. SUBROUTINES
Here’s a revised version of GuessingGame.java that includes the gamesWon variable. The
changes from the above version are shown in italic:
public class GuessingGame2 {
static int gamesWon; // The number of games won by
// the user.
public static void main(String[] args) {
gamesWon = 0; // This is actually redundant, since 0 is
// the default initial value.
TextIO.putln("Let’s play a game. I’ll pick a number between");
TextIO.putln("1 and 100, and you try to guess it.");
boolean playAgain;
do {
playGame(); // call subroutine to play one game
TextIO.put("Would you like to play again? ");
playAgain = TextIO.getlnBoolean();
} while (playAgain);
TextIO.putln();
TextIO.putln("You won " + gamesWon + " games.");
TextIO.putln("Thanks for playing. Goodbye.");
} // end of main()
static void playGame() {
int computersNumber; // A random number picked by the computer.
int usersGuess; // A number entered by user as a guess.
int guessCount; // Number of guesses the user has made.
computersNumber = (int)(100 * Math.random()) + 1;
// The value assigned to computersNumber is a randomly
// chosen integer between 1 and 100, inclusive.
guessCount = 0;
TextIO.putln();
TextIO.put("What is your first guess? ");
while (true) {
usersGuess = TextIO.getInt(); // Get the user’s guess.
guessCount++;
if (usersGuess == computersNumber) {
TextIO.putln("You got it in " + guessCount
+ " guesses! My number was " + computersNumber);
gamesWon++; // Count this game by incrementing gamesWon.
break; // The game is over; the user has won.
}
if (guessCount == 6) {
TextIO.putln("You didn’t get the number in 6 guesses.");
TextIO.putln("You lose. My number was " + computersNumber);
break; // The game is over; the user has lost.
}
// If we get to this point, the game continues.
// Tell the user if the guess was too high or too low.
if (usersGuess < computersNumber)
TextIO.put("That’s too low. Try again: ");
else if (usersGuess > computersNumber)
TextIO.put("That’s too high. Try again: ");
}](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-142-320.jpg)
![128 CHAPTER 4. SUBROUTINES
count++; // count this term
System.out.println(N); // print this term
}
System.out.println();
System.out.println("There were " + count + " terms in the sequence.");
} // end print3NSequence
The parameter list of this subroutine, “(int startingValue)”, specifies that the subroutine
has one parameter, of type int. Within the body of the subroutine, the parameter name can
be used in the same way as a variable name. However, the parameter gets its initial value
from outside the subroutine. When the subroutine is called, a value must be provided for
this parameter in the subroutine call statement. This value will be assigned to the parameter,
startingValue, before the body of the subroutine is executed. For example, the subrou-
tine could be called using the subroutine call statement “print3NSequence(17);”. When the
computer executes this statement, the computer assigns the value 17 to startingValue and
then executes the statements in the subroutine. This prints the 3N+1 sequence starting from
17. If K is a variable of type int, then when the computer executes the subroutine call state-
ment “print3NSequence(K);”, it will take the value of the variable K, assign that value to
startingValue, and execute the body of the subroutine.
The class that contains print3NSequence can contain a main() routine (or other subrou-
tines) that call print3NSequence. For example, here is a main() program that prints out 3N+1
sequences for various starting values specified by the user:
public static void main(String[] args) {
TextIO.putln("This program will print out 3N+1 sequences");
TextIO.putln("for starting values that you specify.");
TextIO.putln();
int K; // Input from user; loop ends when K < 0.
do {
TextIO.putln("Enter a starting value;")
TextIO.put("To end the program, enter 0: ");
K = TextIO.getInt(); // Get starting value from user.
if (K > 0) // Print sequence, but only if K is > 0.
print3NSequence(K);
} while (K > 0); // Continue only if K > 0.
} // end main
Remember that before you can use this program, the definitions of main and of
print3NSequence must both be wrapped inside a class definition.
4.3.2 Formal and Actual Parameters
Note that the term “parameter” is used to refer to two different, but related, concepts. There
are parameters that are used in the definitions of subroutines, such as startingValue in the
above example. And there are parameters that are used in subroutine call statements, such
as the K in the statement “print3NSequence(K);”. Parameters in a subroutine definition are
called formal parameters or dummy parameters. The parameters that are passed to a
subroutine when it is called are called actual parameters or arguments. When a subroutine
is called, the actual parameters in the subroutine call statement are evaluated and the values
are assigned to the formal parameters in the subroutine’s definition. Then the body of the
subroutine is executed.](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-144-320.jpg)
![132 CHAPTER 4. SUBROUTINES
/**
* Write one line of output containing N copies of the
* character ch. If N <= 0, an empty line is output.
*/
static void printRow( char ch, int N ) {
int i; // Loop-control variable for counting off the copies.
for ( i = 1; i <= N; i++ ) {
System.out.print( ch );
}
System.out.println();
}
Note that in this case, the contract makes no assumption about N, but it makes it clear what
will happen in all cases, including the unexpected case that N < 0.
Finally, let’s do an example that shows how one subroutine can build on another. Let’s
write a subroutine that takes a String as a parameter. For each character in the string, it will
print a line of output containing 25 copies of that character. It should use the printRow()
subroutine to produce the output.
Again, we get to choose a name for the subroutine and a name for the parameter. I’ll call
the subroutine printRowsFromString and the parameter str. The algorithm is pretty clear:
For each position i in the string str, call printRow(str.charAt(i),25) to print one line of
the output. So, we get:
/**
* For each character in str, write a line of output
* containing 25 copies of that character.
*/
static void printRowsFromString( String str ) {
int i; // Loop-control variable for counting off the chars.
for ( i = 0; i < str.length(); i++ ) {
printRow( str.charAt(i), 25 );
}
}
We could use printRowsFromString in a main() routine such as
public static void main(String[] args) {
String inputLine; // Line of text input by user.
TextIO.put("Enter a line of text: ");
inputLine = TextIO.getln();
TextIO.putln();
printRowsFromString( inputLine );
}
Of course, the three routines, main(), printRowsFromString(), and printRow(), would
have to be collected together inside the same class. The program is rather useless, but it does
demonstrate the use of subroutines. You’ll find the program in the file RowsOfChars.java, if
you want to take a look.
4.3.5 Throwing Exceptions
I have been talking about the “contract” of a subroutine. The contract says what the subroutine
will do, provided that the caller of the subroutine provides acceptable values for subroutine’s](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-148-320.jpg)
![138 CHAPTER 4. SUBROUTINES
// Append i-th char of str to copy.
copy = copy + str.charAt(i);
}
return copy;
}
A palindrome is a string that reads the same backwards and forwards, such as “radar”. The
reverse() function could be used to check whether a string, word, is a palindrome by testing
“if (word.equals(reverse(word)))”.
By the way, a typical beginner’s error in writing functions is to print out the answer, instead
of returning it. This represents a fundamental misunderstanding. The task of a function is to
compute a value and return it to the point in the program where the function was called. That’s
where the value is used. Maybe it will be printed out. Maybe it will be assigned to a variable.
Maybe it will be used in an expression. But it’s not for the function to decide.
4.4.3 3N+1 Revisited
I’ll finish this section with a complete new version of the 3N+1 program. This will give me a
chance to show the function nextN(), which was defined above, used in a complete program.
I’ll also take the opportunity to improve the program by getting it to print the terms of the
sequence in columns, with five terms on each line. This will make the output more presentable.
This idea is this: Keep track of how many terms have been printed on the current line; when
that number gets up to 5, start a new line of output. To make the terms line up into neat
columns, I use formatted output.
/**
* A program that computes and displays several 3N+1 sequences. Starting
* values for the sequences are input by the user. Terms in the sequence
* are printed in columns, with five terms on each line of output.
* After a sequence has been displayed, the number of terms in that
* sequence is reported to the user.
*/
public class ThreeN2 {
public static void main(String[] args) {
TextIO.putln("This program will print out 3N+1 sequences");
TextIO.putln("for starting values that you specify.");
TextIO.putln();
int K; // Starting point for sequence, specified by the user.
do {
TextIO.putln("Enter a starting value;");
TextIO.put("To end the program, enter 0: ");
K = TextIO.getInt(); // get starting value from user
if (K > 0) // print sequence, but only if K is > 0
print3NSequence(K);
} while (K > 0); // continue only if K > 0
} // end main
/**
* print3NSequence prints a 3N+1 sequence to standard output, using](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-154-320.jpg)
![152 CHAPTER 4. SUBROUTINES
/**
* This program opens a window full of randomly colored squares. A "disturbance"
* moves randomly around in the window, randomly changing the color of each
* square that it visits. The program runs until the user closes the window.
*/
public class RandomMosaicWalk {
static int currentRow; // Row currently containing the disturbance.
static int currentColumn; // Column currently containing disturbance.
/**
* The main program creates the window, fills it with random colors,
* and then moves the disturbances in a random walk around the window
* as long as the window is open.
*/
public static void main(String[] args) {
Mosaic.open(10,20,10,10);
fillWithRandomColors();
currentRow = 5; // start at center of window
currentColumn = 10;
while (Mosaic.isOpen()) {
changeToRandomColor(currentRow, currentColumn);
randomMove();
Mosaic.delay(20);
}
} // end main
/**
* Fills the window with randomly colored squares.
* Precondition: The mosaic window is open.
* Postcondition: Each square has been set to a random color.
*/
static void fillWithRandomColors() {
for (int row=0; row < 10; row++) {
for (int column=0; column < 20; column++) {
changeToRandomColor(row, column);
}
}
} // end fillWithRandomColors
/**
* Changes one square to a new randomly selected color.
* Precondition: The specified rowNum and colNum are in the valid range
* of row and column numbers.
* Postcondition: The square in the specified row and column has
* been set to a random color.
* @param rowNum the row number of the square, counting rows down
* from 0 at the top
* @param colNum the column number of the square, counting columns over
* from 0 at the left
*/
static void changeToRandomColor(int rowNum, int colNum) {
int red = (int)(256*Math.random()); // Choose random levels in range
int green = (int)(256*Math.random()); // 0 to 255 for red, green,
int blue = (int)(256*Math.random()); // and blue color components.](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-168-320.jpg)
![4.7. THE TRUTH ABOUT DECLARATIONS 157
final static int ROWS = 30; // Number of rows in mosaic.
final static int COLUMNS = 30; // Number of columns in mosaic.
final static int SQUARE SIZE = 15; // Size of each square in mosaic.
The rest of the program is carefully modified to use the named constants. For example, in
the new version of the program, the Mosaic window is opened with the statement
Mosaic.open(ROWS, COLUMNS, SQUARE SIZE, SQUARE SIZE);
Sometimes, it’s not easy to find all the places where a named constant needs to be used. If
you don’t use the named constant consistently, you’ve more or less defeated the purpose. It’s
always a good idea to run a program using several different values for any named constants, to
test that it works properly in all cases.
Here is the complete new program, RandomMosaicWalk2, with all modifications from the
previous version shown in italic. I’ve left out some of the comments to save space.
public class RandomMosaicWalk2 {
final static int ROWS = 30; // Number of rows in mosaic.
final static int COLUMNS = 30; // Number of columns in mosaic.
final static int SQUARE SIZE = 15; // Size of each square in mosaic.
static int currentRow; // Row currently containing the disturbance.
static int currentColumn; // Column currently containing disturbance.
public static void main(String[] args) {
Mosaic.open( ROWS, COLUMNS, SQUARE SIZE, SQUARE SIZE );
fillWithRandomColors();
currentRow = ROWS / 2; // start at center of window
currentColumn = COLUMNS / 2;
while (Mosaic.isOpen()) {
changeToRandomColor(currentRow, currentColumn);
randomMove();
Mosaic.delay(20);
}
} // end main
static void fillWithRandomColors() {
for (int row=0; row < ROWS; row++) {
for (int column=0; column < COLUMNS; column++) {
changeToRandomColor(row, column);
}
}
} // end fillWithRandomColors
static void changeToRandomColor(int rowNum, int colNum) {
int red = (int)(256*Math.random()); // Choose random levels in range
int green = (int)(256*Math.random()); // 0 to 255 for red, green,
int blue = (int)(256*Math.random()); // and blue color components.
Mosaic.setColor(rowNum,colNum,red,green,blue);
} // end changeToRandomColor
static void randomMove() {
int directionNum; // Randomly set to 0, 1, 2, or 3 to choose direction.
directionNum = (int)(4*Math.random());
switch (directionNum) {
case 0: // move up](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-173-320.jpg)
![176 CHAPTER 5. OBJECTS AND CLASSES
problem, since we can add a second constructor to the class, one that has no parameters. In
fact, you can have as many different constructors as you want, as long as their signatures are
different, that is, as long as they have different numbers or types of formal parameters. In the
PairOfDice class, we might have a constructor with no parameters which produces a pair of
dice showing random numbers:
public class PairOfDice {
public int die1; // Number showing on the first die.
public int die2; // Number showing on the second die.
public PairOfDice() {
// Constructor. Rolls the dice, so that they initially
// show some random values.
roll(); // Call the roll() method to roll the dice.
}
public PairOfDice(int val1, int val2) {
// Constructor. Creates a pair of dice that
// are initially showing the values val1 and val2.
die1 = val1; // Assign specified values
die2 = val2; // to the instance variables.
}
public void roll() {
// Roll the dice by setting each of the dice to be
// a random number between 1 and 6.
die1 = (int)(Math.random()*6) + 1;
die2 = (int)(Math.random()*6) + 1;
}
} // end class PairOfDice
Now we have the option of constructing a PairOfDice object either with “new PairOfDice()”
or with “new PairOfDice(x,y)”, where x and y are int-valued expressions.
This class, once it is written, can be used in any program that needs to work with one
or more pairs of dice. None of those programs will ever have to use the obscure incantation
“(int)(Math.random()*6)+1”, because it’s done inside the PairOfDice class. And the pro-
grammer, having once gotten the dice-rolling thing straight will never have to worry about it
again. Here, for example, is a main program that uses the PairOfDice class to count how many
times two pairs of dice are rolled before the two pairs come up showing the same value. This
illustrates once again that you can create several instances of the same class:
public class RollTwoPairs {
public static void main(String[] args) {
PairOfDice firstDice; // Refers to the first pair of dice.
firstDice = new PairOfDice();
PairOfDice secondDice; // Refers to the second pair of dice.
secondDice = new PairOfDice();
int countRolls; // Counts how many times the two pairs of
// dice have been rolled.
int total1; // Total showing on first pair of dice.
int total2; // Total showing on second pair of dice.](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-192-320.jpg)
![5.4. PROGRAMMING EXAMPLE: CARD, HAND, DECK 191
*/
public String toString() {
if (suit == JOKER) {
if (value == 1)
return "Joker";
else
return "Joker #" + value;
}
else
return getValueAsString() + " of " + getSuitAsString();
}
} // end class Card
5.4.3 Example: A Simple Card Game
I will finish this section by presenting a complete program that uses the Card and Deck classes.
The program lets the user play a very simple card game called HighLow. A deck of cards is
shuffled, and one card is dealt from the deck and shown to the user. The user predicts whether
the next card from the deck will be higher or lower than the current card. If the user predicts
correctly, then the next card from the deck becomes the current card, and the user makes
another prediction. This continues until the user makes an incorrect prediction. The number
of correct predictions is the user’s score.
My program has a subroutine that plays one game of HighLow. This subroutine has a
return value that represents the user’s score in the game. The main() routine lets the user play
several games of HighLow. At the end, it reports the user’s average score.
I won’t go through the development of the algorithms used in this program, but I encourage
you to read it carefully and make sure that you understand how it works. Note in particular
that the subroutine that plays one game of HighLow returns the user’s score in the game as its
return value. This gets the score back to the main program, where it is needed. Here is the
program:
/**
* This program lets the user play HighLow, a simple card game
* that is described in the output statements at the beginning of
* the main() routine. After the user plays several games,
* the user’s average score is reported.
*/
public class HighLow {
public static void main(String[] args) {
System.out.println("This program lets you play the simple card game,");
System.out.println("HighLow. A card is dealt from a deck of cards.");
System.out.println("You have to predict whether the next card will be");
System.out.println("higher or lower. Your score in the game is the");
System.out.println("number of correct predictions you make before");
System.out.println("you guess wrong.");
System.out.println();
int gamesPlayed = 0; // Number of games user has played.
int sumOfScores = 0; // The sum of all the scores from](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-207-320.jpg)
![226 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING
other. A GUI program offers a much richer type of user interface, where the user uses a mouse
and keyboard to interact with GUI components such as windows, menus, buttons, check boxes,
text input boxes, scroll bars, and so on. The main routine of a GUI program creates one or
more such components and displays them on the computer screen. Very often, that’s all it does.
Once a GUI component has been created, it follows its own programming—programming that
tells it how to draw itself on the screen and how to respond to events such as being clicked on
by the user.
A GUI program doesn’t have to be immensely complex. We can, for example, write a very
simple GUI “Hello World” program that says “Hello” to the user, but does it by opening a
window where the the greeting is displayed:
import javax.swing.JOptionPane;
public class HelloWorldGUI1 {
public static void main(String[] args) {
JOptionPane.showMessageDialog( null, "Hello World!" );
}
}
When this program is run, a window appears on the screen that contains the message
“Hello World!”. The window also contains an “OK” button for the user to click after reading
the message. When the user clicks this button, the window closes and the program ends. By
the way, this program can be placed in a file named HelloWorldGUI1.java, compiled, and run
just like any other Java program.
Now, this program is already doing some pretty fancy stuff. It creates a window, it draws
the contents of that window, and it handles the event that is generated when the user clicks
the button. The reason the program was so easy to write is that all the work is done by
showMessageDialog(), a static method in the built-in class JOptionPane. (Note that the
source code “imports” the class javax.swing.JOptionPane to make it possible to refer to the
JOptionPane class using its simple name. See Subsection 4.5.3 for information about importing
classes from Java’s standard packages.)
If you want to display a message to the user in a GUI program, this is a good way to do it:
Just use a standard class that already knows how to do the work! And in fact, JOptionPane is
regularly used for just this purpose (but as part of a larger program, usually). Of course, if you
want to do anything serious in a GUI program, there is a lot more to learn. To give you an idea
of the types of things that are involved, we’ll look at a short GUI program that does the same
things as the previous program—open a window containing a message and an OK button, and
respond to a click on the button by ending the program—but does it all by hand instead of by
using the built-in JOptionPane class. Mind you, this is not a good way to write the program,
but it will illustrate some important aspects of GUI programming in Java.
Here is the source code for the program. You are not expected to understand it yet. I
will explain how it works below, but it will take the rest of the chapter before you will really
understand completely. In this section, you will just get a brief overview of GUI programming.
import java.awt.*;
import java.awt.event.*;
import javax.swing.*;
public class HelloWorldGUI2 {
private static class HelloWorldDisplay extends JPanel {](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-242-320.jpg)
![6.1. THE BASIC GUI APPLICATION 227
public void paintComponent(Graphics g) {
super.paintComponent(g);
g.drawString( "Hello World!", 20, 30 );
}
}
private static class ButtonHandler implements ActionListener {
public void actionPerformed(ActionEvent e) {
System.exit(0);
}
}
public static void main(String[] args) {
HelloWorldDisplay displayPanel = new HelloWorldDisplay();
JButton okButton = new JButton("OK");
ButtonHandler listener = new ButtonHandler();
okButton.addActionListener(listener);
JPanel content = new JPanel();
content.setLayout(new BorderLayout());
content.add(displayPanel, BorderLayout.CENTER);
content.add(okButton, BorderLayout.SOUTH);
JFrame window = new JFrame("GUI Test");
window.setContentPane(content);
window.setSize(250,100);
window.setLocation(100,100);
window.setVisible(true);
}
}
6.1.1 JFrame and JPanel
In a Java GUI program, each GUI component in the interface is represented by an object in
the program. One of the most fundamental types of component is the window. Windows have
many behaviors. They can be opened and closed. They can be resized. They have “titles” that
are displayed in the title bar above the window. And most important, they can contain other
GUI components such as buttons and menus.
Java, of course, has a built-in class to represent windows. There are actually several different
types of window, but the most common type is represented by the JFrame class (which is
included in the package javax.swing). A JFrame is an independent window that can, for
example, act as the main window of an application. One of the most important things to
understand is that a JFrame object comes with many of the behaviors of windows already
programmed in. In particular, it comes with the basic properties shared by all windows, such
as a titlebar and the ability to be opened and closed. Since a JFrame comes with these behaviors,
you don’t have to program them yourself! This is, of course, one of the central ideas of object-
oriented programming. What a JFrame doesn’t come with, of course, is content, the stuff that
is contained in the window. If you don’t add any other content to a JFrame, it will just display
a large blank area. You can add content either by creating a JFrame object and then adding
the content to it or by creating a subclass of JFrame and adding the content in the constructor
of that subclass.](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-243-320.jpg)
![234 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING
else
currentMessage = "Hello World!";
displayPanel.repaint(); // Paint display panel with new message.
}
}
/**
* The constructor creates the components that will be contained inside this
* panel, and then adds those components to this panel.
*/
public HelloWorldPanel() {
displayPanel = new MessageDisplay(); // Create the display subpanel.
JButton changeMessageButton = new JButton("Change Message"); // The button.
ButtonHandler listener = new ButtonHandler();
changeMessageButton.addActionListener(listener);
setLayout(new BorderLayout()); // Set the layout manager for this panel.
add(displayPanel, BorderLayout.CENTER); // Add the display panel.
add(changeMessageButton, BorderLayout.SOUTH); // Add the button.
}
}
Once this class exists, it can be used in an applet. The applet class only has to create an object
of type HelloWorldPanel and use that object as its content pane:
import javax.swing.JApplet;
public class HelloWorldApplet2 extends JApplet {
public void init() {
HelloWorldPanel content = new HelloWorldPanel();
setContentPane(content);
}
}
Similarly, its easy to make a frame that uses an object of type HelloWorldPanel as its content
pane:
import javax.swing.JFrame;
public class HelloWorldGUI3 {
public static void main(String[] args) {
JFrame window = new JFrame("GUI Test");
HelloWorldPanel content = new HelloWorldPanel();
window.setContentPane(content);
window.setSize(250,100);
window.setLocation(100,100);
window.setDefaultCloseOperation( JFrame.EXIT ON CLOSE );
window.setVisible(true);
}
}
One new feature of this example is the line
window.setDefaultCloseOperation( JFrame.EXIT ON CLOSE );](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-250-320.jpg)
![6.4. MOUSE EVENTS 255
events from the other object. This is something that can potentially be done from outside
both objects. Each object can be developed independently, with no knowledge of the internal
operation of the other object. This is the essence of modular design: Build a complex system
out of modules that interact only in straightforward, easy to understand ways. Then each
module is a separate design problem that can be tackled independently.
To make this clearer, consider the application version of the ClickableRandomStrings
program. I have included RepaintOnClick as a nested class, although it could just as easily be
a separate class. The main point is that this program uses the same RandomStringsPanel class
that was used in the original program, which did not respond to mouse clicks. The mouse
handling has been “bolted on” to an existing class, without having to make any changes at all
to that class:
import java.awt.Component;
import java.awt.event.MouseEvent;
import java.awt.event.MouseListener;
import javax.swing.JFrame;
/**
* Displays a window that shows 25 copies of the string "Java!" in
* random colors, fonts, and positions. The content of the window
* is an object of type RandomStringsPanel. When the user clicks
* the window, the content of the window is repainted, with the
* strings in newly selected random colors, fonts, and positions.
*/
public class ClickableRandomStringsApp {
public static void main(String[] args) {
JFrame window = new JFrame("Random Strings");
RandomStringsPanel content = new RandomStringsPanel();
content.addMouseListener( new RepaintOnClick() ); // Register mouse listener.
window.setContentPane(content);
window.setDefaultCloseOperation(JFrame.EXIT ON CLOSE);
window.setLocation(100,75);
window.setSize(300,240);
window.setVisible(true);
}
private static class RepaintOnClick implements MouseListener {
public void mousePressed(MouseEvent evt) {
Component source = (Component)evt.getSource();
source.repaint();
}
public void mouseClicked(MouseEvent evt) { }
public void mouseReleased(MouseEvent evt) { }
public void mouseEntered(MouseEvent evt) { }
public void mouseExited(MouseEvent evt) { }
}
}](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-271-320.jpg)
![6.4. MOUSE EVENTS 263
public static void main(String[] args) {
JFrame window = new JFrame("Random Strings");
RandomStringsPanel content = new RandomStringsPanel();
content.addMouseListener( new MouseAdapter() {
// Register a mouse listener that is defined by an anonymous subclass
// of MouseAdapter. This replaces the RepaintOnClick class that was
// used in the original version.
public void mousePressed(MouseEvent evt) {
Component source = (Component)evt.getSource();
source.repaint();
}
} );
window.setContentPane(content);
window.setDefaultCloseOperation(JFrame.EXIT ON CLOSE);
window.setLocation(100,75);
window.setSize(300,240);
window.setVisible(true);
}
}
Anonymous inner classes can be used for other purposes besides event handling. For ex-
ample, suppose that you want to define a subclass of JPanel to represent a drawing surface.
The subclass will only be used once. It will redefine the paintComponent() method, but will
make no other changes to JPanel. It might make sense to define the subclass as an anony-
mous nested class. As an example, I present HelloWorldGUI4.java. This version is a variation
of HelloWorldGUI2.java that uses anonymous nested classes where the original program uses
ordinary, named nested classes:
import java.awt.*;
import java.awt.event.*;
import javax.swing.*;
/**
* A simple GUI program that creates and opens a JFrame containing
* the message "Hello World" and an "OK" button. When the user clicks
* the OK button, the program ends. This version uses anonymous
* classes to define the message display panel and the action listener
* object. Compare to HelloWorldGUI2, which uses nested classes.
*/
public class HelloWorldGUI4 {
/**
* The main program creates a window containing a HelloWorldDisplay
* and a button that will end the program when the user clicks it.
*/
public static void main(String[] args) {
JPanel displayPanel = new JPanel() {
// An anonymous subclass of JPanel that displays "Hello World!".
public void paintComponent(Graphics g) {
super.paintComponent(g);
g.drawString( "Hello World!", 20, 30 );
}](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-279-320.jpg)
![302 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING
The final parameter is a constant which specifies that only a “Yes” button and a “No” button
should be used. The third parameter is a string that will be displayed as the title of the dialog
box window.
If you would like to see how dialogs are created and used in the sample applet, you can find
the source code in the file SimpleDialogDemo.java.
6.8.3 Fine Points of Frames
In previous sections, whenever I used a frame, I created a JFrame object in a main() routine
and installed a panel as the content pane of that frame. This works fine, but a more object-
oriented approach is to define a subclass of JFrame and to set up the contents of the frame
in the constructor of that class. This is what I did in the case of the MosaicDraw program.
MosaicDrawFrame is defined as a subclass of JFrame. The definition of this class is very short,
but it illustrates several new features of frames that I want to discuss:
public class MosaicDrawFrame extends JFrame {
public static void main(String[] args) {
JFrame window = new MosaicDrawFrame();
window.setDefaultCloseOperation(JFrame.EXIT ON CLOSE);
window.setVisible(true);
}
public MosaicDrawFrame() {
super("Mosaic Draw");
MosaicDrawController controller = new MosaicDrawController();
setContentPane( controller.getMosaicPanel() );
setJMenuBar( controller.getMenuBar() );
pack();
Dimension screensize = Toolkit.getDefaultToolkit().getScreenSize();
setLocation( (screensize.width - getWidth())/2,
(screensize.height - getHeight())/2 );
}
}
The constructor in this class begins with the statement super("Mosaic Draw"), which calls
the constructor in the superclass, JFrame. The parameter specifies a title that will appear in
the title bar of the window. The next three lines of the constructor set up the contents of the
window; a MosaicDrawController is created, and the content pane and menu bar of the window
are obtained from the controller. The next line is something new. If window is a variable of
type JFrame (or JDialog), then the statement window.pack() will resize the window so that its
size matches the preferred size of its contents. (In this case, of course, “pack()” is equivalent
to “this.pack()”; that is, it refers to the window that is being created by the constructor.)
The pack() method is usually the best way to set the size of a window. Note that it will only
work correctly if every component in the window has a correct preferred size. This is only a
problem in two cases: when a panel is used as a drawing surface and when a panel is used as
a container with a null layout manager. In both these cases there is no way for the system to
determine the correct preferred size automatically, and you should set a preferred size by hand.
For example:
panel.setPreferredSize( new Dimension(400, 250) );](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-318-320.jpg)
![314 CHAPTER 7. ARRAYS
int id number;
Date birthday;
int age;
}
then an object of class Person could be considered to be a record with four fields. The field
names are name, id number, birthday, and age. Note that the fields are of various types:
String, int, and Date.
Because records are just a special type of object, I will not discuss them further.
7.1.1 Arrays
Like a record, an array is a sequence of items. However, where items in a record are referred
to by name, the items in an array are numbered, and individual items are referred to by their
position number. Furthermore, all the items in an array must be of the same type. The
definition of an array is: a numbered sequence of items, which are all of the same type. The
number of items in an array is called the length of the array. The position number of an item
in an array is called the index of that item. The type of the individual items in an array is
called the base type of the array.
The base type of an array can be any Java type, that is, one of the primitive types, or a class
name, or an interface name. If the base type of an array is int, it is referred to as an “array of
ints.” An array with base type String is referred to as an “array of Strings.” However, an array
is not, properly speaking, a list of integers or strings or other values. It is better thought of as
a list of variables of type int, or of type String, or of some other type. As always, there is some
potential for confusion between the two uses of a variable: as a name for a memory location
and as a name for the value stored in that memory location. Each position in an array acts as
a variable. Each position can hold a value of a specified type (the base type of the array). The
value can be changed at any time. Values are stored in an array. The array is the container,
not the values.
The items in an array—really, the individual variables that make up the array—are more
often referred to as the elements of the array. In Java, the elements in an array are always
numbered starting from zero. That is, the index of the first element in the array is zero. If the
length of the array is N, then the index of the last element in the array is N-1. Once an array
has been created, its length cannot be changed.
Java arrays are objects. This has several consequences. Arrays are created using a form of
the new operator. No variable can ever hold an array; a variable can only refer to an array.
Any variable that can refer to an array can also hold the value null, meaning that it doesn’t
at the moment refer to anything. Like any object, an array belongs to a class, which like all
classes is a subclass of the class Object. The elements of the array are, essentially, instance
variables in the array object, except that they are referred to by number rather than by name.
Nevertheless, even though arrays are objects, there are differences between arrays and other
kinds of objects, and there are a number of special language features in Java for creating and
using arrays.
7.1.2 Using Arrays
Suppose that A is a variable that refers to an array. Then the element at index k in A is referred
to as A[k]. The first element is A[0], the second is A[1], and so forth. “A[k]” is really a
variable, and it can be used just like any other variable. You can assign values to it, you can](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-330-320.jpg)
![7.1. CREATING AND USING ARRAYS 315
use it in expressions, and you can pass it as a parameter to a subroutine. All of this will be
discussed in more detail below. For now, just keep in mind the syntax
harray-variablei [ hinteger-expressioni ]
for referring to an element of an array.
Although every array, as an object, belongs to some class, array classes never have to be
defined. Once a type exists, the corresponding array class exists automatically. If the name
of the type is BaseType, then the name of the associated array class is BaseType[ ]. That is
to say, an object belonging to the class BaseType[ ] is an array of items, where each item is a
variable of type BaseType. The brackets, “[]”, are meant to recall the syntax for referring to
the individual items in the array. “BaseType[ ]” is read as “array of BaseType” or “BaseType
array.” It might be worth mentioning here that if ClassA is a subclass of ClassB, then the class
ClassA[ ] is automatically a subclass of ClassB[ ].
The base type of an array can be any legal Java type. From the primitive type int, the
array type int[ ] is derived. Each element in an array of type int[ ] is a variable of type int, which
holds a value of type int. From a class named Shape, the array type Shape[ ] is derived. Each
item in an array of type Shape[ ] is a variable of type Shape, which holds a value of type Shape.
This value can be either null or a reference to an object belonging to the class Shape. (This
includes objects belonging to subclasses of Shape.)
∗ ∗ ∗
Let’s try to get a little more concrete about all this, using arrays of integers as our first
example. Since int[ ] is a class, it can be used to declare variables. For example,
int[] list;
creates a variable named list of type int[ ]. This variable is capable of referring to an array
of ints, but initially its value is null (if list is a member variable in a class) or undefined (if
list is a local variable in a method). The new operator is used to create a new array object,
which can then be assigned to list. The syntax for using new with arrays is different from the
syntax you learned previously. As an example,
list = new int[5];
creates an array of five integers. More generally, the constructor “new BaseType[N]” is used to
create an array belonging to the class BaseType[ ]. The value N in brackets specifies the length
of the array, that is, the number of elements that it contains. Note that the array “knows”
how long it is. The length of the array is an instance variable in the array object. In fact, the
length of an array, list, can be referred to as list.length. (However, you are not allowed to
change the value of list.length, so it’s really a “final” instance variable, that is, one whose
value cannot be changed after it has been initialized.)
The situation produced by the statement “list = new int[5];” can be pictured like this:
l i s t : ( 5 )
l i s t . l e n g t h
l i s t [ 0 ]
0
l i s t [ 1 ]
0
l i s t [ 2 ]
0
l i s t [ 3 ]
0
l i s t [ 4 ]
0
T h e s t a t e m e n t
" l i s t = n e w i n t [ 5 ] ; "
c r
e a t e s a n a
r r
a y
t h a t
c
a n h o l d fi v e
i n t s , a n d s e t s l i s t
t o
r
e f e
r
t o i t .
T h e a
r r
a y o b j e
c
t
c
o n t a i n s
fi v e i n t e g e
r
s , w h i
c
h a
r
e
r
e f e
r r
e d t o a s l i s t [ 0 ] , l i s t [ 1 ] ,
a n d s o o n . I t a l s o
c
o n t a i n s
l i s t . l e n g t h , w h i
c
h g i v e s t h e
n u m b e
r
o f i t e m s i n t h e a
r r
a y .
l i s t . l e n g t h
c
a n ' t b e
c
h a n g e d .](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-331-320.jpg)
![316 CHAPTER 7. ARRAYS
Note that the newly created array of integers is automatically filled with zeros. In Java, a
newly created array is always filled with a known, default value: zero for numbers, false for
boolean, the character with Unicode number zero for char, and null for objects.
The elements in the array, list, are referred to as list[0], list[1], list[2], list[3],
and list[4]. (Note again that the index for the last item is one less than list.length.)
However, array references can be much more general than this. The brackets in an array
reference can contain any expression whose value is an integer. For example if indx is a
variable of type int, then list[indx] and list[2*indx+7] are syntactically correct references
to elements of the array list. Thus, the following loop would print all the integers in the array,
list, to standard output:
for (int i = 0; i < list.length; i++) {
System.out.println( list[i] );
}
The first time through the loop, i is 0, and list[i] refers to list[0]. So, it is the value
stored in the variable list[0] that is printed. The second time through the loop, i is 1, and
the value stored in list[1] is printed. The loop ends after printing the value of list[4],
when i becomes equal to 5 and the continuation condition “i < list.length” is no longer
true. This is a typical example of using a loop to process an array. I’ll discuss more examples
of array processing throughout this chapter.
Every use of a variable in a program specifies a memory location. Think for a moment
about what the computer does when it encounters a reference to an array element, list[k],
while it is executing a program. The computer must determine which memory location is being
referred to. To the computer, list[k] means something like this: “Get the pointer that is
stored in the variable, list. Follow this pointer to find an array object. Get the value of k.
Go to the k-th position in the array, and that’s the memory location you want.” There are two
things that can go wrong here. Suppose that the value of list is null. If that is the case,
then list doesn’t even refer to an array. The attempt to refer to an element of an array that
doesn’t exist is an error that will cause an exception of type NullPointerException to be thrown.
The second possible error occurs if list does refer to an array, but the value of k is outside the
legal range of indices for that array. This will happen if k < 0 or if k >= list.length. This
is called an “array index out of bounds” error. When an error of this type occurs, an exception
of type ArrayIndexOutOfBoundsException is thrown. When you use arrays in a program, you
should be mindful that both types of errors are possible. However, array index out of bounds
errors are by far the most common error when working with arrays.
7.1.3 Array Initialization
For an array variable, just as for any variable, you can declare the variable and initialize it in
a single step. For example,
int[] list = new int[5];
If list is a local variable in a subroutine, then this is exactly equivalent to the two statements:
int[] list;
list = new int[5];
(If list is an instance variable, then of course you can’t simply replace “int[] list = new
int[5];” with “int[] list; list = new int[5];” since the assignment statement “list =
new int[5];” is only legal inside a subroutine.)](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-332-320.jpg)
![7.1. CREATING AND USING ARRAYS 317
The new array is filled with the default value appropriate for the base type of the array—zero
for int and null for class types, for example. However, Java also provides a way to initialize an
array variable with a new array filled with a specified list of values. In a declaration statement
that creates a new array, this is done with an array initializer. For example,
int[] list = { 1, 4, 9, 16, 25, 36, 49 };
creates a new array containing the seven values 1, 4, 9, 16, 25, 36, and 49, and sets list to
refer to that new array. The value of list[0] will be 1, the value of list[1] will be 4, and so
forth. The length of list is seven, since seven values are provided in the initializer.
An array initializer takes the form of a list of values, separated by commas and enclosed
between braces. The length of the array does not have to be specified, because it is implicit in
the list of values. The items in an array initializer don’t have to be constants. They can be
variables or arbitrary expressions, provided that their values are of the appropriate type. For
example, the following declaration creates an array of eight Colors. Some of the colors are given
by expressions of the form “new Color(r,g,b)” instead of by constants:
Color[] palette = {
Color.BLACK,
Color.RED,
Color.PINK,
new Color(0,180,0), // dark green
Color.GREEN,
Color.BLUE,
new Color(180,180,255), // light blue
Color.WHITE
};
A list initializer of this form can be used only in a declaration statement, to give an
initial value to a newly declared array variable. It cannot be used in an assignment statement
to assign a value to a variable that has been previously declared. However, there is another,
similar notation for creating a new array that can be used in an assignment statement or passed
as a parameter to a subroutine. The notation uses another form of the new operator to both
create and initialize a new array object at the same time. (The rather odd syntax is similar to
the syntax for anonymous classes, which were discussed in Subsection 5.7.3.) For example to
assign a new value to an array variable, list, that was declared previously, you could use:
list = new int[] { 1, 8, 27, 64, 125, 216, 343 };
The general syntax for this form of the new operator is
new hbase-typei [ ] { hlist-of-valuesi }
This is actually an expression whose value is a reference to a newly created array object. This
means that it can be used in any context where an object of type hbase-typei[] is expected.
For example, if makeButtons is a method that takes an array of Strings as a parameter, you
could say:
makeButtons( new String[] { "Stop", "Go", "Next", "Previous" } );
Being able to create and use an array “in place” in this way can be very convenient, in the
same way that anonymous nested classes are convenient.
By the way, it is perfectly legal to use the “new BaseType[] { ... }” syntax instead of
the array initializer syntax in the declaration of an array variable. For example, instead of
saying:](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-333-320.jpg)
![318 CHAPTER 7. ARRAYS
int[] primes = { 2, 3, 5, 7, 11, 13, 17, 19 };
you can say, equivalently,
int[] primes = new int[] { 2, 3, 5, 7, 11, 17, 19 };
In fact, rather than use a special notation that works only in the context of declaration state-
ments, I prefer to use the second form.
∗ ∗ ∗
One final note: For historical reasons, an array declaration such as
int[] list;
can also be written as
int list[];
which is a syntax used in the languages C and C++. However, this alternative syntax does not
really make much sense in the context of Java, and it is probably best avoided. After all, the
intent is to declare a variable of a certain type, and the name of that type is “int[ ]”. It makes
sense to follow the “htype-namei hvariable-namei;” syntax for such declarations.
7.2 Programming With Arrays
Arrays are the most basic and the most important type of data structure, and tech-
niques for processing arrays are among the most important programming techniques you can
learn. Two fundamental array processing techniques—searching and sorting—will be covered
in Section 7.4. This section introduces some of the basic ideas of array processing in general.
7.2.1 Arrays and for Loops
In many cases, processing an array means applying the same operation to each item in the
array. This is commonly done with a for loop. A loop for processing all the elements of an
array A has the form:
// do any necessary initialization
for (int i = 0; i < A.length; i++) {
. . . // process A[i]
}
Suppose, for example, that A is an array of type double[ ]. Suppose that the goal is to add
up all the numbers in the array. An informal algorithm for doing this would be:
Start with 0;
Add A[0]; (process the first item in A)
Add A[1]; (process the second item in A)
.
.
.
Add A[ A.length - 1 ]; (process the last item in A)
Putting the obvious repetition into a loop and giving a name to the sum, this becomes:](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-334-320.jpg)
![7.2. PROGRAMMING WITH ARRAYS 319
double sum; // The sum of the numbers in A.
sum = 0; // Start with 0.
for (int i = 0; i < A.length; i++)
sum += A[i]; // add A[i] to the sum, for
// i = 0, 1, ..., A.length - 1
Note that the continuation condition, “i < A.length”, implies that the last value of i that
is actually processed is A.length-1, which is the index of the final item in the array. It’s
important to use “<” here, not “<=”, since “<=” would give an array index out of bounds error.
There is no element at position A.length in A.
Eventually, you should just about be able to write loops similar to this one in your sleep.
I will give a few more simple examples. Here is a loop that will count the number of items in
the array A which are less than zero:
int count; // For counting the items.
count = 0; // Start with 0 items counted.
for (int i = 0; i < A.length; i++) {
if (A[i] < 0.0) // if this item is less than zero...
count++; // ...then count it
}
// At this point, the value of count is the number
// of items that have passed the test of being < 0
Replace the test “A[i] < 0.0”, if you want to count the number of items in an array that
satisfy some other property. Here is a variation on the same theme. Suppose you want to count
the number of times that an item in the array A is equal to the item that follows it. The item
that follows A[i] in the array is A[i+1], so the test in this case is “if (A[i] == A[i+1])”.
But there is a catch: This test cannot be applied when A[i] is the last item in the array, since
then there is no such item as A[i+1]. The result of trying to apply the test in this case would
be an ArrayIndexOutOfBoundsException. This just means that we have to stop one item short
of the final item:
int count = 0;
for (int i = 0; i < A.length - 1; i++) {
if (A[i] == A[i+1])
count++;
}
Another typical problem is to find the largest number in A. The strategy is to go through
the array, keeping track of the largest number found so far. We’ll store the largest number
found so far in a variable called max. As we look through the array, whenever we find a number
larger than the current value of max, we change the value of max to that larger value. After the
whole array has been processed, max is the largest item in the array overall. The only question
is, what should the original value of max be? One possibility is to start with max equal to A[0],
and then to look through the rest of the array, starting from A[1], for larger items:
double max = A[0];
for (int i = 1; i < A.length; i++) {
if (A[i] > max)
max = A[i];
}
// at this point, max is the largest item in A](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-335-320.jpg)
![320 CHAPTER 7. ARRAYS
(There is one subtle problem here. It’s possible in Java for an array to have length zero. In
that case, A[0] doesn’t exist, and the reference to A[0] in the first line gives an array index out
of bounds error. However, zero-length arrays are normally something that you want to avoid
in real problems. Anyway, what would it mean to ask for the largest item in an array that
contains no items at all?)
As a final example of basic array operations, consider the problem of copying an array. To
make a copy of our sample array A, it is not sufficient to say
double[] B = A;
since this does not create a new array object. All it does is declare a new array variable and
make it refer to the same object to which A refers. (So that, for example, a change to A[i] will
automatically change B[i] as well.) To make a new array that is a copy of A, it is necessary to
make a new array object and to copy each of the individual items from A into the new array:
double[] B = new double[A.length]; // Make a new array object,
// the same size as A.
for (int i = 0; i < A.length; i++)
B[i] = A[i]; // Copy each item from A to B.
Copying values from one array to another is such a common operation that Java has a
predefined subroutine to do it. The subroutine, System.arraycopy(), is a static member
subroutine in the standard System class. Its declaration has the form
public static void arraycopy(Object sourceArray, int sourceStartIndex,
Object destArray, int destStartIndex, int count)
where sourceArray and destArray can be arrays with any base type. Values are copied from
sourceArray to destArray. The count tells how many elements to copy. Values are taken from
sourceArray starting at position sourceStartIndex and are stored in destArray starting at
position destStartIndex. For example, to make a copy of the array, A, using this subroutine,
you would say:
double B = new double[A.length];
System.arraycopy( A, 0, B, 0, A.length );
7.2.2 Arrays and for-each Loops
Java 5.0 introduced a new form of the for loop, the “for-each loop” that was introduced in
Subsection 3.4.4. The for-each loop is meant specifically for processing all the values in a data
structure. When used to process an array, a for-each loop can be used to perform the same
operation on each value that is stored in the array. If anArray is an array of type BaseType[ ],
then a for-each loop for anArray has the form:
for ( BaseType item : anArray ) {
.
. // process the item
.
}
In this loop, item is the loop control variable. It is being declared as a variable of type BaseType,
where BaseType is the base type of the array. (In a for-each loop, the loop control variable must
be declared in the loop.) When this loop is executed, each value from the array is assigned
to item in turn and the body of the loop is executed for each value. Thus, the above loop is
exactly equivalent to:](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-336-320.jpg)
![7.2. PROGRAMMING WITH ARRAYS 321
for ( int index = 0; index < anArray.length; index++ ) {
BaseType item;
item = anArray[index]; // Get one of the values from the array
.
. // process the item
.
}
For example, if A is an array of type int[ ], then we could print all the values from A with
the for-each loop:
for ( int item : A )
System.out.println( item );
and we could add up all the positive integers in A with:
int sum = 0; // This will be the sum of all the positive numbers in A
for ( int item : A ) {
if (item > 0)
sum = sum + item;
}
The for-each loop is not always appropriate. For example, there is no simple way to use it
to process the items in just a part of an array. However, it does make it a little easier to process
all the values in an array, since it eliminates any need to use array indices.
It’s important to note that a for-each loop processes the values in the array, not the
elements (where an element means the actual memory location that is part of the array). For
example, consider the following incorrect attempt to fill an array of integers with 17’s:
int[] intList = new int[10];
for ( int item : intList ) { // INCORRECT! DOES NOT MODIFY THE ARRAY!
item = 17;
}
The assignment statement item = 17 assigns the value 17 to the loop control variable, item.
However, this has nothing to do with the array. When the body of the loop is executed, the
value from one of the elements of the array is copied into item. The statement item = 17
replaces that copied value but has no effect on the array element from which it was copied; the
value in the array is not changed.
7.2.3 Array Types in Subroutines
Any array type, such as double[ ], is a full-fledged Java type, so it can be used in all the ways
that any other Java type can be used. In particular, it can be used as the type of a formal
parameter in a subroutine. It can even be the return type of a function. For example, it might
be useful to have a function that makes a copy of an array of double:
/**
* Create a new array of doubles that is a copy of a given array.
* @param source the array that is to be copied; the value can be null
* @return a copy of source; if source is null, then the return value is also null
*/
public static double[] copy( double[] source ) {
if ( source == null )](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-337-320.jpg)
![322 CHAPTER 7. ARRAYS
return null;
double[] cpy; // A copy of the source array.
cpy = new double[source.length];
System.arraycopy( source, 0, cpy, 0, source.length );
return cpy;
}
The main() routine of a program has a parameter of type String[ ]. You’ve seen this used
since all the way back in Section 2.1, but I haven’t really been able to explain it until now.
The parameter to the main() routine is an array of Strings. When the system calls the main()
routine, the strings in this array are the command-line arguments from the command that
was used to run the program. When using a command-line interface, the user types a command
to tell the system to execute a program. The user can include extra input in this command,
beyond the name of the program. This extra input becomes the command-line arguments. For
example, if the name of the class that contains the main() routine is myProg, then the user
can type “java myProg” to execute the program. In this case, there are no command-line
arguments. But if the user types the command
java myProg one two three
then the command-line arguments are the strings “one”, “two”, and “three”. The system puts
these strings into an array of Strings and passes that array as a parameter to the main()
routine. Here, for example, is a short program that simply prints out any command line
arguments entered by the user:
public class CLDemo {
public static void main(String[] args) {
System.out.println("You entered " + args.length
+ " command-line arguments");
if (args.length > 0) {
System.out.println("They were:");
for (int i = 0; i < args.length; i++)
System.out.println(" " + args[i]);
}
} // end main()
} // end class CLDemo
Note that the parameter, args, is never null when main() is called by the system, but it might
be an array of length zero.
In practice, command-line arguments are often the names of files to be processed by the
program. I will give some examples of this in Chapter 11, when I discuss file processing.
7.2.4 Random Access
So far, all my examples of array processing have used sequential access. That is, the elements
of the array were processed one after the other in the sequence in which they occur in the array.
But one of the big advantages of arrays is that they allow random access. That is, every
element of the array is equally accessible at any given time.
As an example, let’s look at a well-known problem called the birthday problem: Suppose
that there are N people in a room. What’s the chance that there are two people in the room
who have the same birthday? (That is, they were born on the same day in the same month,
but not necessarily in the same year.) Most people severely underestimate the probability. We](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-338-320.jpg)
![7.2. PROGRAMMING WITH ARRAYS 323
will actually look at a different version of the question: Suppose you choose people at random
and check their birthdays. How many people will you check before you find one who has the
same birthday as someone you’ve already checked? Of course, the answer in a particular case
depends on random factors, but we can simulate the experiment with a computer program and
run the program several times to get an idea of how many people need to be checked on average.
To simulate the experiment, we need to keep track of each birthday that we find. There are
365 different possible birthdays. (We’ll ignore leap years.) For each possible birthday, we need
to keep track of whether or not we have already found a person who has that birthday. The
answer to this question is a boolean value, true or false. To hold the data for all 365 possible
birthdays, we can use an array of 365 boolean values:
boolean[] used;
used = new boolean[365];
The days of the year are numbered from 0 to 364. The value of used[i] is true if someone
has been selected whose birthday is day number i. Initially, all the values in the array, used,
are false. When we select someone whose birthday is day number i, we first check whether
used[i] is true. If so, then this is the second person with that birthday. We are done. If
used[i] is false, we set used[i] to be true to record the fact that we’ve encountered someone
with that birthday, and we go on to the next person. Here is a subroutine that carries out
the simulated experiment (of course, in the subroutine, there are no simulated people, only
simulated birthdays):
/**
* Simulate choosing people at random and checking the day of the year they
* were born on. If the birthday is the same as one that was seen previously,
* stop, and output the number of people who were checked.
*/
private static void birthdayProblem() {
boolean[] used; // For recording the possible birthdays
// that have been seen so far. A value
// of true in used[i] means that a person
// whose birthday is the i-th day of the
// year has been found.
int count; // The number of people who have been checked.
used = new boolean[365]; // Initially, all entries are false.
count = 0;
while (true) {
// Select a birthday at random, from 0 to 364.
// If the birthday has already been used, quit.
// Otherwise, record the birthday as used.
int birthday; // The selected birthday.
birthday = (int)(Math.random()*365);
count++;
if ( used[birthday] ) // This day was found before; It’s a duplicate.
break;
used[birthday] = true;
}
System.out.println("A duplicate birthday was found after "](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-339-320.jpg)
![324 CHAPTER 7. ARRAYS
+ count + " tries.");
} // end birthdayProblem()
This subroutine makes essential use of the fact that every element in a newly created array of
boolean is set to be false. If we wanted to reuse the same array in a second simulation, we
would have to reset all the elements in it to be false with a for loop:
for (int i = 0; i < 365; i++)
used[i] = false;
The program that uses this subroutine is BirthdayProblemDemo.java. An applet version of
the program can be found in the online version of this section.
7.2.5 Arrays of Objects
One of the examples in Subsection 6.4.2 was an applet that shows multiple copies of a message
in random positions, colors, and fonts. When the user clicks on the applet, the positions, colors,
and fonts are changed to new random values. Like several other examples from that chapter,
the applet had a flaw: It didn’t have any way of storing the data that would be necessary to
redraw itself. Arrays provide us with one possible solution to this problem. We can write a new
version of the RandomStrings applet that uses an array to store the position, font, and color of
each string. When the content pane of the applet is painted, this information is used to draw
the strings, so the applet will paint itself correctly whenever it has to be redrawn. When the
user clicks on the applet, the array is filled with new random values and the applet is repainted
using the new data. So, the only time that the picture will change is in response to a mouse
click.
In this applet, the number of copies of the message is given by a named constant,
MESSAGE COUNT. One way to store the position, color, and font of MESSAGE COUNT strings would
be to use four arrays:
int[] x = new int[MESSAGE COUNT];
int[] y = new int[MESSAGE COUNT];
Color[] color = new Color[MESSAGE COUNT];
Font[] font = new Font[MESSAGE COUNT];
These arrays would be filled with random values. In the paintComponent() method, the i-th
copy of the string would be drawn at the point (x[i],y[i]). Its color would be given by
color[i]. And it would be drawn in the font font[i]. This would be accomplished by the
paintComponent() method
public void paintComponent(Graphics g) {
super.paintComponent(); // (Fill with background color.)
for (int i = 0; i < MESSAGE COUNT; i++) {
g.setColor( color[i] );
g.setFont( font[i] );
g.drawString( message, x[i], y[i] );
}
}
This approach is said to use parallel arrays. The data for a given copy of the message is
spread out across several arrays. If you think of the arrays as laid out in parallel columns—
array x in the first column, array y in the second, array color in the third, and array font
in the fourth—then the data for the i-th string can be found along the the i-th row. There](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-340-320.jpg)
![7.2. PROGRAMMING WITH ARRAYS 325
is nothing wrong with using parallel arrays in this simple example, but it does go against the
object-oriented philosophy of keeping related data in one object. If we follow this rule, then we
don’t have to imagine the relationship among the data, because all the data for one copy of
the message is physically in one place. So, when I wrote the applet, I made a simple class to
represent all the data that is needed for one copy of the message:
/**
* An object of this type holds the position, color, and font
* of one copy of the string.
*/
private static class StringData {
int x, y; // The coordinates of the left end of baseline of string.
Color color; // The color in which the string is drawn.
Font font; // The font that is used to draw the string.
}
(This class is actually defined as a static nested class in the main applet class.) To store the data
for multiple copies of the message, I use an array of type StringData[ ]. The array is declared
as an instance variable, with the name stringData:
StringData[] stringData;
Of course, the value of stringData is null until an actual array is created and assigned to it.
This is done in the init() method of the applet with the statement
stringData = new StringData[MESSAGE COUNT];
The base type of this array is StringData, which is a class. We say that stringData is an array
of objects. This means that the elements of the array are variables of type StringData. Like
any object variable, each element of the array can either be null or can hold a reference to an
object. (Note that the term “array of objects” is a little misleading, since the objects are not
in the array; the array can only contain references to objects). When the stringData array is
first created, the value of each element in the array is null.
The data needed by the RandomStrings program will be stored in objects of type StringData,
but no such objects exist yet. All we have so far is an array of variables that are capable of
referring to such objects. I decided to create the StringData objects in the applet’s init method.
(It could be done in other places—just so long as we avoid trying to use an object that doesn’t
exist. This is important: Remember that a newly created array whose base type is an object
type is always filled with null elements. There are no objects in the array until you put them
there.) The objects are created with the for loop
for (int i = 0; i < MESSAGE COUNT; i++)
stringData[i] = new StringData();
For the RandomStrings applet, the idea is to store data for the i-th copy of the
message in the variables stringData[i].x, stringData[i].y, stringData[i].color, and
stringData[i].font. Make sure that you understand the notation here: stringData[i]
refers to an object. That object contains instance variables. The notation stringData[i].x
tells the computer: “Find your way to the object that is referred to by stringData[i]. Then
go to the instance variable named x in that object.” Variable names can get even more com-
plicated than this, so it is important to learn how to read them. Using the array, stringData,
the paintComponent() method for the applet could be written](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-341-320.jpg)
![326 CHAPTER 7. ARRAYS
public void paintComponent(Graphics g) {
super.paintComponent(g); // (Fill with background color.)
for (int i = 0; i < MESSAGE COUNT; i++) {
g.setColor( stringData[i].color );
g.setFont( stringData[i].font );
g.drawString( message, stringData[i].x, stringData[i].y );
}
}
However, since the for loop is processing every value in the array, an alternative would be to
use a for-each loop:
public void paintComponent(Graphics g) {
super.paintComponent(g);
for ( StringData data : stringData) {
// Draw a copy of the message in the position, color,
// and font stored in data.
g.setColor( data.color );
g.setFont( data.font );
g.drawString( message, data.x, data.y );
}
}
In the loop, the loop control variable, data, holds a copy of one of the values from the array.
That value is a reference to an object of type StringData, which has instance variables named
color, font, x, and y. Once again, the use of a for-each loop has eliminated the need to work
with array indices.
There is still the matter of filling the array, data, with random values. If you are interested,
you can look at the source code for the applet, RandomStringsWithArray.java.
∗ ∗ ∗
The RandomStrings applet uses one other array of objects. The font for a given copy of
the message is chosen at random from a set of five possible fonts. In the original version of the
applet, there were five variables of type Font to represent the fonts. The variables were named
font1, font2, font3, font4, and font5. To select one of these fonts at random, a switch
statement could be used:
Font randomFont; // One of the 5 fonts, chosen at random.
int rand; // A random integer in the range 0 to 4.
rand = (int)(Math.random() * 5);
switch (rand) {
case 0:
randomFont = font1;
break;
case 1:
randomFont = font2;
break;
case 2:
randomFont = font3;
break;
case 3:
randomFont = font4;
break;
case 4:](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-342-320.jpg)
![7.2. PROGRAMMING WITH ARRAYS 327
randomFont = font5;
break;
}
In the new version of the applet, the five fonts are stored in an array, which is named fonts.
This array is declared as an instance variable of type Font[ ]
Font[] fonts;
The array is created in the init() method of the applet, and each element of the array is set
to refer to a new Font object:
fonts = new Font[5]; // Create the array to hold the five fonts.
fonts[0] = new Font("Serif", Font.BOLD, 14);
fonts[1] = new Font("SansSerif", Font.BOLD + Font.ITALIC, 24);
fonts[2] = new Font("Monospaced", Font.PLAIN, 20);
fonts[3] = new Font("Dialog", Font.PLAIN, 30);
fonts[4] = new Font("Serif", Font.ITALIC, 36);
This makes it much easier to select one of the fonts at random. It can be done with the
statements
Font randomFont; // One of the 5 fonts, chosen at random.
int fontIndex; // A random number in the range 0 to 4.
fontIndex = (int)(Math.random() * 5);
randomFont = fonts[ fontIndex ];
The switch statement has been replaced by a single line of code. In fact, the preceding four
lines could be replaced by the single line:
Font randomFont = fonts[ (int)(Math.random() * 5) ];
This is a very typical application of arrays. Note that this example uses the random access
property of arrays: We can pick an array index at random and go directly to the array element
at that index.
Here is another example of the same sort of thing. Months are often stored as numbers 1, 2,
3, . . . , 12. Sometimes, however, these numbers have to be translated into the names January,
February, . . . , December. The translation can be done with an array. The array can be declared
and initialized as
static String[] monthName = { "January", "February", "March",
"April", "May", "June",
"July", "August", "September",
"October", "November", "December" };
If mnth is a variable that holds one of the integers 1 through 12, then monthName[mnth-1] is the
name of the corresponding month. We need the “-1” because months are numbered starting
from 1, while array elements are numbered starting from 0. Simple array indexing does the
translation for us!
7.2.6 Variable Arity Methods
Arrays are used in the implementation of one of the new features in Java 5.0. Before version 5.0,
every method in Java had a fixed arity. (The arity of a subroutine is defined as the number of
parameters in a call to the method.) In a fixed arity method, the number of parameters must
be the same in every call to the method. Java 5.0 introduced variable arity methods. In a](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-343-320.jpg)
![328 CHAPTER 7. ARRAYS
variable arity method, different calls to the method can have different numbers of parameters.
For example, the formatted output method System.out.printf, which was introduced in Sub-
section 2.4.4, is a variable arity method. The first parameter of System.out.printf must be
a String, but it can have any number of additional parameters, of any types.
Calling a variable arity method is no different from calling any other sort of method, but
writing one requires some new syntax. As an example, consider a method that can compute
the average of any number of values of type double. The definition of such a method could
begin with:
public static double average( double... numbers ) {
Here, the ... after the type name, double, indicates that any number of values of type
double can be provided when the subroutine is called, so that for example average(1,2,3),
average(3.14,2.17), average(0.375), and even average() are all legal calls to this method.
Note that actual parameters of type int can be passed to average. The integers will, as usual,
be automatically converted to real numbers.
When the method is called, the values of all the actual parameters that correspond to the
variable arity parameter are placed into an array, and it is this array that is actually passed to
the method. That is, in the body of a method, a variable arity parameter of type T actually
looks like an ordinary parameter of type T[ ]. The length of the array tells you how many
actual parameters were provided in the method call. In the average example, the body of the
method would see an array named numbers of type double[ ]. The number of actual parameters
in the method call would be numbers.length, and the values of the actual parameters would
be numbers[0], numbers[1], and so on. A complete definition of the method would be:
public static double average( double... numbers ) {
double sum; // The sum of all the actual parameters.
double average; // The average of all the actual parameters.
sum = 0;
for (int i = 0; i < numbers.length; i++) {
sum = sum + numbers[i]; // Add one of the actual parameters to the sum.
}
average = sum / numbers.length;
return average;
}
Note that the “...” can be applied only to the last formal parameter in a method definition.
Note also that it is possible to pass an actual array to the method, instead of a list of individual
values. For example, if salesData is a variable of type double[ ], then it would be legal to call
average(salesData), and this would compute the average of all the numbers in the array.
As another example, consider a method that can draw a polygon through any number of
points. The points are given as values of type Point, where an object of type Point has two
instance variables, x and y, of type int. In this case, the method has one ordinary parameter—
the graphics context that will be used to draw the polygon—in addition to the variable arity
parameter:
public static void drawPolygon(Graphics g, Point... points) {
if (points.length > 1) { // (Need at least 2 points to draw anything.)
for (int i = 0; i < points.length - 1; i++) {
// Draw a line from i-th point to (i+1)-th point
g.drawline( points[i].x, points[i].y, points[i+1].x, points[i+1].y );
}](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-344-320.jpg)
![7.3. DYNAMIC ARRAYS AND ARRAYLISTS 329
// Now, draw a line back to the starting point.
g.drawLine( points[points.length-1].x, points[points.length-1].y,
points[0].x, points[0].y );
}
}
Because of automatic type conversion, a variable arity parameter of type “Object...” can
take actual parameters of any type whatsoever. Even primitive type values are allowed, because
of autoboxing. (A primitive type value belonging to a type such as int is converted to an object
belonging to a “wrapper” class such as Integer. See Subsection 5.3.2.) For example, the method
definition for System.out.printf could begin:
public void printf(String format, Object... values) {
This allows the printf method to output values of any type. Similarly, we could write a method
that strings together the string representations of all its parameters into one long string:
public static String concat( Object... values ) {
String str = ""; // Start with an empty string.
for ( Object obj : values ) { // A "for each" loop for processing the values.
if (obj == null )
str = str + "null"; // Represent null values by "null".
else
str = str + obj.toString();
}
}
7.3 Dynamic Arrays and ArrayLists
The size of an array is fixed when it is created. In many cases, however, the number of data
items that are actually stored in the array varies with time. Consider the following examples:
An array that stores the lines of text in a word-processing program. An array that holds the list
of computers that are currently downloading a page from a Web site. An array that contains
the shapes that have been added to the screen by the user of a drawing program. Clearly, we
need some way to deal with cases where the number of data items in an array is not fixed.
7.3.1 Partially Full Arrays
Consider an application where the number of items that we want to store in an array changes
as the program runs. Since the size of the array can’t actually be changed, a separate counter
variable must be used to keep track of how many spaces in the array are in use. (Of course,
every space in the array has to contain something; the question is, how many spaces contain
useful or valid items?)
Consider, for example, a program that reads positive integers entered by the user and stores
them for later processing. The program stops reading when the user inputs a number that is
less than or equal to zero. The input numbers can be kept in an array, numbers, of type int[ ].
Let’s say that no more than 100 numbers will be input. Then the size of the array can be fixed
at 100. But the program must keep track of how many numbers have actually been read and
stored in the array. For this, it can use an integer variable, numCount. Each time a number
is stored in the array, numCount must be incremented by one. As a rather silly example, let’s
write a program that will read the numbers input by the user and then print them in reverse](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-345-320.jpg)
![330 CHAPTER 7. ARRAYS
order. (This is, at least, a processing task that requires that the numbers be saved in an array.
Remember that many types of processing, such as finding the sum or average or maximum of
the numbers, can be done without saving the individual numbers.)
public class ReverseInputNumbers {
public static void main(String[] args) {
int[] numbers; // An array for storing the input values.
int numCount; // The number of numbers saved in the array.
int num; // One of the numbers input by the user.
numbers = new int[100]; // Space for 100 ints.
numCount = 0; // No numbers have been saved yet.
TextIO.putln("Enter up to 100 positive integers; enter 0 to end.");
while (true) { // Get the numbers and put them in the array.
TextIO.put("? ");
num = TextIO.getlnInt();
if (num <= 0)
break;
numbers[numCount] = num;
numCount++;
}
TextIO.putln("nYour numbers in reverse order are:n");
for (int i = numCount - 1; i >= 0; i--) {
TextIO.putln( numbers[i] );
}
} // end main();
} // end class ReverseInputNumbers
It is especially important to note that the variable numCount plays a dual role. It is the
number of items that have been entered into the array. But it is also the index of the next
available spot in the array. For example, if 4 numbers have been stored in the array, they occupy
locations number 0, 1, 2, and 3. The next available spot is location 4. When the time comes to
print out the numbers in the array, the last occupied spot in the array is location numCount -
1, so the for loop prints out values starting from location numCount - 1 and going down to 0.
Let’s look at another, more realistic example. Suppose that you write a game program, and
that players can join the game and leave the game as it progresses. As a good object-oriented
programmer, you probably have a class named Player to represent the individual players in
the game. A list of all players who are currently in the game could be stored in an array,
playerList, of type Player[ ]. Since the number of players can change, you will also need a
variable, playerCt, to record the number of players currently in the game. Assuming that there
will never be more than 10 players in the game, you could declare the variables as:
Player[] playerList = new Player[10]; // Up to 10 players.
int playerCt = 0; // At the start, there are no players.
After some players have joined the game, playerCt will be greater than 0, and
the player objects representing the players will be stored in the array elements
playerList[0], playerList[1], . . . , playerList[playerCt-1]. Note that the array element](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-346-320.jpg)
![7.3. DYNAMIC ARRAYS AND ARRAYLISTS 331
playerList[playerCt] is not in use. The procedure for adding a new player, newPlayer, to
the game is simple:
playerList[playerCt] = newPlayer; // Put new player in next
// available spot.
playerCt++; // And increment playerCt to count the new player.
Deleting a player from the game is a little harder, since you don’t want to leave a “hole”
in the array. Suppose you want to delete the player at index k in playerList. If you are not
worried about keeping the players in any particular order, then one way to do this is to move
the player from the last occupied position in the array into position k and then to decrement
the value of playerCt:
playerList[k] = playerList[playerCt - 1];
playerCt--;
The player previously in position k is no longer in the array. The player previously in position
playerCt - 1 is now in the array twice. But it’s only in the occupied or valid part of the array
once, since playerCt has decreased by one. Remember that every element of the array has to
hold some value, but only the values in positions 0 through playerCt - 1 will be looked at or
processed in any way. (By the way, you should think about what happens if the player that
is being deleted is in the last position in the list. The code does still work in this case. What
exactly happens?)
Suppose that when deleting the player in position k, you’d like to keep the remaining players
in the same order. (Maybe because they take turns in the order in which they are stored in the
array.) To do this, all the players in positions k+1 and above must move down one position in
the array. Player k+1 replaces player k, who is out of the game. Player k+2 fills the spot left
open when player k+1 is moved. And so on. The code for this is
for (int i = k+1; i < playerCt; i++) {
playerList[i-1] = playerList[i];
}
playerCt--;
∗ ∗ ∗
It’s worth emphasizing that the Player example deals with an array whose base type is a
class. An item in the array is either null or is a reference to an object belonging to the class,
Player. The Player objects themselves are not really stored in the array, only references to
them. Note that because of the rules for assignment in Java, the objects can actually belong to
subclasses of Player. Thus there could be different classes of players such as computer players,
regular human players, players who are wizards, . . . , all represented by different subclasses of
Player.
As another example, suppose that a class Shape represents the general idea of a shape
drawn on a screen, and that it has subclasses to represent specific types of shapes such as
lines, rectangles, rounded rectangles, ovals, filled-in ovals, and so forth. (Shape itself would be
an abstract class, as discussed in Subsection 5.5.5.) Then an array of type Shape[ ] can hold
references to objects belonging to the subclasses of Shape. For example, the situation created
by the statements
Shape[] shapes = new Shape[100]; // Array to hold up to 100 shapes.
shapes[0] = new Rect(); // Put some objects in the array.
shapes[1] = new Line();
shapes[2] = new FilledOval();
int shapeCt = 3; // Keep track of number of objects in array.](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-347-320.jpg)
![332 CHAPTER 7. ARRAYS
could be illustrated as:
s h a p e s
s h a p e s . l e n g t h
s h a p e s [ 0 ]
s h a p e s [ 1 ]
s h a p e s [ 2 ]
s h a p e s [ 3 ]
s h a p e s [ 4 ]
Such an array would be useful in a drawing program. The array could be used to hold a list
of shapes to be displayed. If the Shape class includes a method, “void redraw(Graphics g)”,
for drawing the shape in a graphics context g, then all the shapes in the array could be redrawn
with a simple for loop:
for (int i = 0; i < shapeCt; i++)
shapes[i].redraw(g);
The statement “shapes[i].redraw(g);” calls the redraw() method belonging to the partic-
ular shape at index i in the array. Each object knows how to redraw itself, so that repeated
executions of the statement can produce a variety of different shapes on the screen. This is nice
example both of polymorphism and of array processing.
7.3.2 Dynamic Arrays
In each of the above examples, an arbitrary limit was set on the number of items—100 ints, 10
Players, 100 Shapes. Since the size of an array is fixed, a given array can only hold a certain
maximum number of items. In many cases, such an arbitrary limit is undesirable. Why should
a program work for 100 data values, but not for 101? The obvious alternative of making an
array that’s so big that it will work in any practical case is not usually a good solution to the
problem. It means that in most cases, a lot of computer memory will be wasted on unused space
in the array. That memory might be better used for something else. And what if someone is
using a computer that could handle as many data values as the user actually wants to process,
but doesn’t have enough memory to accommodate all the extra space that you’ve allocated for
your huge array?
Clearly, it would be nice if we could increase the size of an array at will. This is not possible,
but what is possible is almost as good. Remember that an array variable does not actually
hold an array. It just holds a reference to an array object. We can’t make the array bigger,
but we can make a new, bigger array object and change the value of the array variable so that
it refers to the bigger array. Of course, we also have to copy the contents of the old array into
the new array. The array variable then refers to an array object that contains all the data of
the old array, with room for additional data. The old array will be garbage collected, since it
is no longer in use.
Let’s look back at the game example, in which playerList is an array of type Player[ ] and
playerCt is the number of spaces that have been used in the array. Suppose that we don’t
want to put a pre-set limit on the number of players. If a new player joins the game and the](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-348-320.jpg)
![7.3. DYNAMIC ARRAYS AND ARRAYLISTS 333
current array is full, we just make a new, bigger one. The same variable, playerList, will refer
to the new array. Note that after this is done, playerList[0] will refer to a different memory
location, but the value stored in playerList[0] will still be the same as it was before. Here is
some code that will do this:
// Add a new player, even if the current array is full.
if (playerCt == playerList.length) {
// Array is full. Make a new, bigger array,
// copy the contents of the old array into it,
// and set playerList to refer to the new array.
int newSize = 2 * playerList.length; // Size of new array.
Player[] temp = new Player[newSize]; // The new array.
System.arraycopy(playerList, 0, temp, 0, playerList.length);
playerList = temp; // Set playerList to refer to new array.
}
// At this point, we KNOW there is room in the array.
playerList[playerCt] = newPlayer; // Add the new player...
playerCt++; // ...and count it.
If we are going to be doing things like this regularly, it would be nice to define a reusable
class to handle the details. An array-like object that changes size to accommodate the amount
of data that it actually contains is called a dynamic array. A dynamic array supports the
same operations as an array: putting a value at a given position and getting the value that is
stored at a given position. But there is no upper limit on the positions that can be used (except
those imposed by the size of the computer’s memory). In a dynamic array class, the put and
get operations must be implemented as instance methods. Here, for example, is a class that
implements a dynamic array of ints:
/**
* An object of type DynamicArrayOfInt acts like an array of int
* of unlimited size. The notation A.get(i) must be used instead
* of A[i], and A.set(i,v) must be used instead of A[i] = v.
*/
public class DynamicArrayOfInt {
private int[] data; // An array to hold the data.
/**
* Constructor creates an array with an initial size of 1,
* but the array size will be increased whenever a reference
* is made to an array position that does not yet exist.
*/
public DynamicArrayOfInt() {
data = new int[1];
}
/**
* Get the value from the specified position in the array.
* Since all array elements are initialized to zero, when the
* specified position lies outside the actual physical size
* of the data array, a value of 0 is returned. Note that
* a negative value of position will still produce an
* ArrayIndexOutOfBoundsException.](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-349-320.jpg)
![334 CHAPTER 7. ARRAYS
*/
public int get(int position) {
if (position >= data.length)
return 0;
else
return data[position];
}
/**
* Store the value in the specified position in the array.
* The data array will increase in size to include this
* position, if necessary.
*/
public void put(int position, int value) {
if (position >= data.length) {
// The specified position is outside the actual size of
// the data array. Double the size, or if that still does
// not include the specified position, set the new size
// to 2*position.
int newSize = 2 * data.length;
if (position >= newSize)
newSize = 2 * position;
int[] newData = new int[newSize];
System.arraycopy(data, 0, newData, 0, data.length);
data = newData;
// The following line is for demonstration purposes only !!
System.out.println("Size of dynamic array increased to " + newSize);
}
data[position] = value;
}
} // end class DynamicArrayOfInt
The data in a DynamicArrayOfInt object is actually stored in a regular array, but that array
is discarded and replaced by a bigger array whenever necessary. If numbers is a variable of
type DynamicArrayOfInt, then the command numbers.put(pos,val) stores the value val at
position number pos in the dynamic array. The function numbers.get(pos) returns the value
stored at position number pos.
The first example in this section used an array to store positive integers input by the
user. We can rewrite that example to use a DynamicArrayOfInt. A reference to numbers[i]
is replaced by numbers.get(i). The statement “numbers[numCount] = num;” is replaced by
“numbers.put(numCount,num);”. Here’s the program:
public class ReverseWithDynamicArray {
public static void main(String[] args) {
DynamicArrayOfInt numbers; // To hold the input numbers.
int numCount; // The number of numbers stored in the array.
int num; // One of the numbers input by the user.
numbers = new DynamicArrayOfInt();
numCount = 0;
TextIO.putln("Enter some positive integers; Enter 0 to end");
while (true) { // Get numbers and put them in the dynamic array.](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-350-320.jpg)
![7.3. DYNAMIC ARRAYS AND ARRAYLISTS 335
TextIO.put("? ");
num = TextIO.getlnInt();
if (num <= 0)
break;
numbers.put(numCount, num); // Store num in the dynamic array.
numCount++;
}
TextIO.putln("nYour numbers in reverse order are:n");
for (int i = numCount - 1; i >= 0; i--) {
TextIO.putln( numbers.get(i) ); // Print the i-th number.
}
} // end main();
} // end class ReverseWithDynamicArray
7.3.3 ArrrayLists
The DynamicArrayOfInt class could be used in any situation where an array of int with no preset
limit on the size is needed. However, if we want to store Shapes instead of ints, we would have
to define a new class to do it. That class, probably named “DynamicArrayOfShape”, would look
exactly the same as the DynamicArrayOfInt class except that everywhere the type “int” appears,
it would be replaced by the type “Shape”. Similarly, we could define a DynamicArrayOfDouble
class, a DynamicArrayOfPlayer class, and so on. But there is something a little silly about this,
since all these classes are close to being identical. It would be nice to be able to write some
kind of source code, once and for all, that could be used to generate any of these classes on
demand, given the type of value that we want to store. This would be an example of generic
programming. Some programming languages, including C++, have had support for generic
programming for some time. With version 5.0, Java introduced true generic programming,
but even before that it had something that was very similar: One can come close to generic
programming in Java by working with data structures that contain elements of type Object.
We will first consider the almost-generic programming that has been available in Java from
the beginning, and then we will look at the change that was introduced in Java 5.0. A full
discussion of generic programming will be given in Chapter 10.
In Java, every class is a subclass of the class named Object. This means that every object can
be assigned to a variable of type Object. Any object can be put into an array of type Object[ ].
If we defined a DynamicArrayOfObject class, then we could store objects of any type. This is not
true generic programming, and it doesn’t apply to the primitive types such as int and double.
But it does come close. In fact, there is no need for us to define a DynamicArrayOfObject class.
Java already has a standard class named ArrayList that serves much the same purpose. The
ArrayList class is in the package java.util, so if you want to use it in a program, you should
put the directive “import java.util.ArrayList;” at the beginning of your source code file.
The ArrayList class differs from my DynamicArrayOfInt class in that an ArrayList object
always has a definite size, and it is illegal to refer to a position in the ArrayList that lies outside
its size. In this, an ArrayList is more like a regular array. However, the size of an ArrayList can
be increased at will. The ArrayList class defines many instance methods. I’ll describe some of
the most useful. Suppose that list is a variable of type ArrayList. Then we have:](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-351-320.jpg)
![336 CHAPTER 7. ARRAYS
• list.size() — This function returns the current size of the ArrayList. The only valid
positions in the list are numbers in the range 0 to list.size()-1. Note that the size can
be zero. A call to the default constructor new ArrayList() creates an ArrayList of size
zero.
• list.add(obj) — Adds an object onto the end of the list, increasing the size by 1. The
parameter, obj, can refer to an object of any type, or it can be null.
• list.get(N) — This function returns the value stored at position N in the ArrayList. N
must be an integer in the range 0 to list.size()-1. If N is outside this range, an error
of type IndexOutOfBoundsException occurs. Calling this function is similar to referring
to A[N] for an array, A, except that you can’t use list.get(N) on the left side of an
assignment statement.
• list.set(N, obj) — Assigns the object, obj, to position N in the ArrayList, replacing
the item previously stored at position N. The integer N must be in the range from 0 to
list.size()-1. A call to this function is equivalent to the command A[N] = obj for an
array A.
• list.remove(obj) — If the specified object occurs somewhere in the ArrayList, it is
removed from the list. Any items in the list that come after the removed item are moved
down one position. The size of the ArrayList decreases by 1. If obj occurs more than once
in the list, only the first copy is removed.
• list.remove(N) — For an integer, N, this removes the N-th item in the ArrayList. N must
be in the range 0 to list.size()-1. Any items in the list that come after the removed
item are moved down one position. The size of the ArrayList decreases by 1.
• list.indexOf(obj) — A function that searches for the object, obj, in the ArrayList. If
the object is found in the list, then the position number where it is found is returned. If
the object is not found, then -1 is returned.
For example, suppose again that players in a game are represented by objects of type Player.
The players currently in the game could be stored in an ArrayList named players. This variable
would be declared as
ArrayList players;
and initialized to refer to a new, empty ArrayList object with
players = new ArrayList();
If newPlayer is a variable that refers to a Player object, the new player would be added to the
ArrayList and to the game by saying
players.add(newPlayer);
and if player number i leaves the game, it is only necessary to say
players.remove(i);
Or, if player is a variable that refers to the Player that is to be removed, you could say
players.remove(player);
All this works very nicely. The only slight difficulty arises when you use the function
players.get(i) to get the value stored at position i in the ArrayList. The return type of
this function is Object. In this case the object that is returned by the function is actually of
type Player. In order to do anything useful with the returned value, it’s usually necessary to
type-cast it to type Player:](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-352-320.jpg)
![7.3. DYNAMIC ARRAYS AND ARRAYLISTS 339
7.3.4 Parameterized Types
The main difference between true generic programming and the ArrayList examples in the
previous subsection is the use of the type Object as the basic type for objects that are stored
in a list. This has at least two unfortunate consequences: First, it makes it necessary to use
type-casting in almost every case when an element is retrieved from that list. Second, since
any type of object can legally be added to the list, there is no way for the compiler to detect
an attempt to add the wrong type of object to the list; the error will be detected only at run
time when the object is retrieved from the list and the attempt to type-cast the object fails.
Compare this to arrays. An array of type BaseType[ ] can only hold objects of type BaseType.
An attempt to store an object of the wrong type in the array will be detected by the compiler,
and there is no need to type-cast items that are retrieved from the array back to type BaseType.
To address this problem, Java 5.0 introduced parameterized types. ArrayList is an ex-
ample: Instead of using the plain “ArrayList” type, it is possible to use ArrayList<BaseType>,
where BaseType is any object type, that is, the name of a class or of an interface. (BaseType
cannot be one of the primitive types.) ArrayList<BaseType> can be used to create lists that
can hold only objects of type BaseType. For example,
ArrayList<ColoredRect> rects;
declares a variable named rects of type ArrayList<ColoredRect>, and
rects = new ArrayList<ColoredRect>();
sets rects to refer to a newly created list that can only hold objects belonging to the class
ColoredRect (or to a subclass). The funny-looking name “ArrayList<ColoredRect>” is being
used here in exactly the same way as an ordinary class name—don’t let the “<ColoredRect>”
confuse you; it’s just part of the name of the type. When a statement such as rects.add(x);
occurs in the program, the compiler can check whether x is in fact of type ColoredRect. If not,
the compiler will report a syntax error. When an object is retrieve from the list, the compiler
knows that the object must be of type ColoredRect, so no type-cast is necessary. You can say
simply:
ColoredRect rect = rects.get(i)
You can even refer directly to an instance variable in the object, such as rects.get(i).color.
This makes using ArrayList<ColoredRect> very similar to using ColoredRect[ ] with the added
advantage that the list can grow to any size. Note that if a for-each loop is used to process the
items in rects, the type of the loop control variable can be ColoredRect, and no type-cast is
necessary. For example, when using ArrayList<ColoredRect> as the type for the list rects, the
code for drawing all the rectangles in the list could be rewritten as:
for ( ColoredRect rect : rects ) {
g.setColor( rect.color );
g.fillRect( rect.x, rect.y, rect.width, rect.height);
g.setColor( Color.BLACK );
g.drawRect( rect.x, rect.y, rect.width - 1, rect.height - 1);
}
You can use ArrayList<ColoredRect> anyplace where you could use a normal type: to declare
variables, as the type of a formal parameter in a subroutine, or as the return type of a subroutine.
You can even create a subclass of ArrayList<ColoredRect>! (Nevertheless, technically speaking,
ArrayList<ColoredRect> is not considered to be a separate class from ArrayList. An object of](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-355-320.jpg)
![344 CHAPTER 7. ARRAYS
* Searches the array A for the integer N. If N is not in the array,
* then -1 is returned. If N is in the array, then return value is
* the first integer i that satisfies A[i] == N.
*/
static int find(int[] A, int N) {
for (int index = 0; index < A.length; index++) {
if ( A[index] == N )
return index; // N has been found at this index!
}
// If we get this far, then N has not been found
// anywhere in the array. Return a value of -1.
return -1;
}
This method of searching an array by looking at each item in turn is called linear search.
If nothing is known about the order of the items in the array, then there is really no better
alternative algorithm. But if the elements in the array are known to be in increasing or decreas-
ing order, then a much faster search algorithm can be used. An array in which the elements are
in order is said to be sorted. Of course, it takes some work to sort an array, but if the array
is to be searched many times, then the work done in sorting it can really pay off.
Binary search is a method for searching for a given item in a sorted array. Although
the implementation is not trivial, the basic idea is simple: If you are searching for an item in
a sorted list, then it is possible to eliminate half of the items in the list by inspecting a single
item. For example, suppose that you are looking for the number 42 in a sorted array of 1000
integers. Let’s assume that the array is sorted into increasing order. Suppose you check item
number 500 in the array, and find that the item is 93. Since 42 is less than 93, and since the
elements in the array are in increasing order, we can conclude that if 42 occurs in the array
at all, then it must occur somewhere before location 500. All the locations numbered 500 or
above contain values that are greater than or equal to 93. These locations can be eliminated
as possible locations of the number 42.
The next obvious step is to check location 250. If the number at that location is, say, -21,
then you can eliminate locations before 250 and limit further search to locations between 251
and 499. The next test will limit the search to about 125 locations, and the one after that to
about 62. After just 10 steps, there is only one location left. This is a whole lot better than
looking through every element in the array. If there were a million items, it would still take
only 20 steps for binary search to search the array! (Mathematically, the number of steps is
approximately equal to the logarithm, in the base 2, of the number of items in the array.)
In order to make binary search into a Java subroutine that searches an array A for an item
N, we just have to keep track of the range of locations that could possibly contain N. At each
step, as we eliminate possibilities, we reduce the size of this range. The basic operation is to
look at the item in the middle of the range. If this item is greater than N, then the second
half of the range can be eliminated. If it is less than N, then the first half of the range can
be eliminated. If the number in the middle just happens to be N exactly, then the search is
finished. If the size of the range decreases to zero, then the number N does not occur in the
array. Here is a subroutine that returns the location of N in a sorted array A. If N cannot be
found in the array, then a value of -1 is returned instead:
/**](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-360-320.jpg)
![7.4. SEARCHING AND SORTING 345
* Searches the array A for the integer N.
* Precondition: A must be sorted into increasing order.
* Postcondition: If N is in the array, then the return value, i,
* satisfies A[i] == N. If N is not in the array, then the
* return value is -1.
*/
static int binarySearch(int[] A, int N) {
int lowestPossibleLoc = 0;
int highestPossibleLoc = A.length - 1;
while (highestPossibleLoc >= lowestPossibleLoc) {
int middle = (lowestPossibleLoc + highestPossibleLoc) / 2;
if (A[middle] == N) {
// N has been found at this index!
return middle;
}
else if (A[middle] > N) {
// eliminate locations >= middle
highestPossibleLoc = middle - 1;
}
else {
// eliminate locations <= middle
lowestPossibleLoc = middle + 1;
}
}
// At this point, highestPossibleLoc < LowestPossibleLoc,
// which means that N is known to be not in the array. Return
// a -1 to indicate that N could not be found in the array.
return -1;
}
7.4.2 Association Lists
One particularly common application of searching is with association lists. The standard
example of an association list is a dictionary. A dictionary associates definitions with words.
Given a word, you can use the dictionary to look up its definition. We can think of the dictionary
as being a list of pairs of the form (w,d), where w is a word and d is its definition. A general
association list is a list of pairs (k,v), where k is some “key” value, and v is a value associated
to that key. In general, we want to assume that no two pairs in the list have the same key.
There are two basic operations on association lists: Given a key, k, find the value v associated
with k, if any. And given a key, k, and a value v, add the pair (k,v) to the association list
(replacing the pair, if any, that had the same key value). The two operations are usually called
get and put.
Association lists are very widely used in computer science. For example, a compiler has
to keep track of the location in memory associated with each variable. It can do this with an
association list in which each key is a variable name and the associated value is the address of
that variable in memory. Another example would be a mailing list, if we think of it as associating
an address to each name on the list. As a related example, consider a phone directory that](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-361-320.jpg)
![346 CHAPTER 7. ARRAYS
associates a phone number to each name. The items in the list could be objects belonging to
the class:
class PhoneEntry {
String name;
String phoneNum;
}
The data for a phone directory consists of an array of type PhoneEntry[ ] and an integer
variable to keep track of how many entries are actually stored in the directory. The technique
of “dynamic arrays” (Subsection 7.3.2) can be used in order to avoid putting an arbitrary limit
on the number of entries that the phone directory can hold. Using an ArrayList would be another
possibility. A PhoneDirectory class should include instance methods that implement the “get”
and “put” operations. Here is one possible simple definition of the class:
/**
* A PhoneDirectory holds a list of names with a phone number for
* each name. It is possible to find the number associated with
* a given name, and to specify the phone number for a given name.
*/
public class PhoneDirectory {
/**
* An object of type PhoneEntry holds one name/number pair.
*/
private static class PhoneEntry {
String name; // The name.
String number; // The associated phone number.
}
private PhoneEntry[] data; // Array that holds the name/number pairs.
private int dataCount; // The number of pairs stored in the array.
/**
* Constructor creates an initially empty directory.
*/
public PhoneDirectory() {
data = new PhoneEntry[1];
dataCount = 0;
}
/**
* Looks for a name/number pair with a given name. If found, the index
* of the pair in the data array is returned. If no pair contains the
* given name, then the return value is -1.
*/
private int find( String name ) {
for (int i = 0; i < dataCount; i++) {
if (data[i].name.equals(name))
return i; // The name has been found in position i.
}
return -1; // The name does not exist in the array.
}
/**
* Finds the phone number, if any, for a given name.](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-362-320.jpg)
![7.4. SEARCHING AND SORTING 347
* @return The phone number associated with the name; if the name does
* not occur in the phone directory, then the return value is null.
*/
public String getNumber( String name ) {
int position = find(name);
if (position == -1)
return null; // There is no phone entry for the given name.
else
return data[position].number;
}
/**
* Associates a given name with a given phone number. If the name
* already exists in the phone directory, then the new number replaces
* the old one. Otherwise, a new name/number pair is added. The
* name and number should both be non-null. An IllegalArgumentException
* is thrown if this is not the case.
*/
public void putNumber( String name, String number ) {
if (name == null || number == null)
throw new IllegalArgumentException("name and number cannot be null");
int i = find(name);
if (i >= 0) {
// The name already exists, in position i in the array.
// Just replace the old number at that position with the new.
data[i].number = number;
}
else {
// Add a new name/number pair to the array. If the array is
// already full, first create a new, larger array.
if (dataCount == data.length) {
PhoneEntry[] newData = new PhoneEntry[ 2*data.length ];
System.arraycopy(newData,0,data,0,dataCount);
data = newData;
}
PhoneEntry newEntry = new PhoneEntry(); // Create a new pair.
newEntry.name = name;
newEntry.number = number;
data[dataCount] = newEntry; // Add the new pair to the array.
dataCount++;
}
}
} // end class PhoneDirectory
The class defines a private instance method, find(), that uses linear search to find the
position of a given name in the array of name/number pairs. The find() method is used
both in the getNumber() method and in the putNumber() method. Note in particular that
putNumber(name,number) has to check whether the name is in the phone directory. If so, it
just changes the number in the existing entry; if not, it has to create a new phone entry and
add it to the array.
This class could use a lot of improvement. For one thing, it would be nice to use binary
search instead of simple linear search in the getNumber method. However, we could only do
that if the list of PhoneEntries were sorted into alphabetical order according to name. In fact,](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-363-320.jpg)
![348 CHAPTER 7. ARRAYS
it’s really not all that hard to keep the list of entries in sorted order, as you’ll see in the next
subsection.
7.4.3 Insertion Sort
We’ve seen that there are good reasons for sorting arrays. There are many algorithms available
for doing so. One of the easiest to understand is the insertion sort algorithm. This method
is also applicable to the problem of keeping a list in sorted order as you add new items to the
list. Let’s consider that case first:
Suppose you have a sorted list and you want to add an item to that list. If you want to
make sure that the modified list is still sorted, then the item must be inserted into the right
location, with all the smaller items coming before it and all the bigger items after it. This will
mean moving each of the bigger items up one space to make room for the new item.
/*
* Precondition: itemsInArray is the number of items that are
* stored in A. These items must be in increasing order
* (A[0] <= A[1] <= ... <= A[itemsInArray-1]).
* The array size is at least one greater than itemsInArray.
* Postcondition: The number of items has increased by one,
* newItem has been added to the array, and all the items
* in the array are still in increasing order.
* Note: To complete the process of inserting an item in the
* array, the variable that counts the number of items
* in the array must be incremented, after calling this
* subroutine.
*/
static void insert(int[] A, int itemsInArray, int newItem) {
int loc = itemsInArray - 1; // Start at the end of the array.
/* Move items bigger than newItem up one space;
Stop when a smaller item is encountered or when the
beginning of the array (loc == 0) is reached. */
while (loc >= 0 && A[loc] > newItem) {
A[loc + 1] = A[loc]; // Bump item from A[loc] up to loc+1.
loc = loc - 1; // Go on to next location.
}
A[loc + 1] = newItem; // Put newItem in last vacated space.
}
Conceptually, this could be extended to a sorting method if we were to take all the items
out of an unsorted array, and then insert them back into the array one-by-one, keeping the list
in sorted order as we do so. Each insertion can be done using the insert routine given above.
In the actual algorithm, we don’t really take all the items from the array; we just remember
what part of the array has been sorted:
static void insertionSort(int[] A) {
// Sort the array A into increasing order.
int itemsSorted; // Number of items that have been sorted so far.
for (itemsSorted = 1; itemsSorted < A.length; itemsSorted++) {](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-364-320.jpg)
![7.4. SEARCHING AND SORTING 349
// Assume that items A[0], A[1], ... A[itemsSorted-1]
// have already been sorted. Insert A[itemsSorted]
// into the sorted part of the list.
int temp = A[itemsSorted]; // The item to be inserted.
int loc = itemsSorted - 1; // Start at end of list.
while (loc >= 0 && A[loc] > temp) {
A[loc + 1] = A[loc]; // Bump item from A[loc] up to loc+1.
loc = loc - 1; // Go on to next location.
}
A[loc + 1] = temp; // Put temp in last vacated space.
}
}
The following is an illustration of one stage in insertion sort. It shows what happens during
one execution of the for loop in the above method, when itemsSorted is 5:
S t a r t w i t h a p a r t i a l l y s o r t e d l i s t o f i t e m s :
S o r t e d I t e m s
I t e m s s t i l l t o b e s o r t e d
S o r t e d I t e m s
I t e m s s t i l l t o b e s o r t e d
T
e m p :
T
e m p :
C o p y n e x t u n s o r t e d i t e m i n t o
T
e m p ,
l e a v i n g a " h o l e " i n t h e a r r a y .
M
o v e i t e m s i n s o r t e d p a r t o f
a r r a y t o m a k e r o o m f o r
T
e m p .
N
o w , t h e s o r t e d p a r t o f t h e l i s t h a s
i n c r e a s e d i n s i z e b y o n e i t e m .
7.4.4 Selection Sort
Another typical sorting method uses the idea of finding the biggest item in the list and moving
it to the end—which is where it belongs if the list is to be in increasing order. Once the biggest
item is in its correct location, you can then apply the same idea to the remaining items. That is,
find the next-biggest item, and move it into the next-to-last space, and so forth. This algorithm
is called selection sort. It’s easy to write:](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-365-320.jpg)
![350 CHAPTER 7. ARRAYS
static void selectionSort(int[] A) {
// Sort A into increasing order, using selection sort
for (int lastPlace = A.length-1; lastPlace > 0; lastPlace--) {
// Find the largest item among A[0], A[1], ...,
// A[lastPlace], and move it into position lastPlace
// by swapping it with the number that is currently
// in position lastPlace.
int maxLoc = 0; // Location of largest item seen so far.
for (int j = 1; j <= lastPlace; j++) {
if (A[j] > A[maxLoc]) {
// Since A[j] is bigger than the maximum we’ve seen
// so far, j is the new location of the maximum value
// we’ve seen so far.
maxLoc = j;
}
}
int temp = A[maxLoc]; // Swap largest item with A[lastPlace].
A[maxLoc] = A[lastPlace];
A[lastPlace] = temp;
} // end of for loop
}
Insertion sort and selection sort are suitable for sorting fairly small arrays (up to a few hun-
dred elements, say). There are more complicated sorting algorithms that are much faster than
insertion sort and selection sort for large arrays. I’ll discuss one such algorithm in Chapter 9.
∗ ∗ ∗
A variation of selection sort is used in the Hand class that was introduced in Subsection 5.4.1.
(By the way, you are finally in a position to fully understand the source code for both the Hand
class and the Deck class from that section. See the source files Deck.java and Hand.java.)
In the Hand class, a hand of playing cards is represented by a Vector. This is older code,
which used Vector instead of ArrayList, and I have chosen not to modify it so that you would
see at least one example of using Vectors. See Subsection 7.3.5 for a discussion of Vectors.
The objects stored in the Vector are of type Card. A Card object contains instance methods
getSuit() and getValue() that can be used to determine the suit and value of the card. In
my sorting method, I actually create a new vector and move the cards one-by-one from the old
vector to the new vector. The cards are selected from the old vector in increasing order. In the
end, the new vector becomes the hand and the old vector is discarded. This is certainly not
the most efficient procedure! But hands of cards are so small that the inefficiency is negligible.
Here is the code for sorting cards by suit:
/**
* Sorts the cards in the hand so that cards of the same suit are
* grouped together, and within a suit the cards are sorted by value.
* Note that aces are considered to have the lowest value, 1.
*/
public void sortBySuit() {
Vector newHand = new Vector();
while (hand.size() > 0) {](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-366-320.jpg)
![7.4. SEARCHING AND SORTING 351
int pos = 0; // Position of minimal card found so far.
Card c = (Card)hand.elementAt(0); // The minimal card.
for (int i = 1; i < hand.size(); i++) {
Card c1 = (Card)hand.elementAt(i);
if ( c1.getSuit() < c.getSuit() ||
(c1.getSuit() == c.getSuit() && c1.getValue() < c.getValue()) ) {
pos = i;
c = c1;
}
}
hand.removeElementAt(pos);
newHand.addElement(c);
}
hand = newHand;
}
This example illustrates the fact that comparing items in a list is not usually as simple as
using the operator “<”. In this case, we consider one card to be less than another if the suit
of the first card is less than the suit of the second, and also if the suits are the same and the
value of the second card is less than the value of the first. The second part of this test ensures
that cards with the same suit will end up sorted by value.
Sorting a list of Strings raises a similar problem: the “<” operator is not defined for strings.
However, the String class does define a compareTo method. If str1 and str2 are of type String,
then
str1.compareTo(str2)
returns an int that is 0 when str1 is equal to str2, is less than 0 when str1 preceeds str2,
and is greater than 0 when str1 follows str2. The definition of “succeeds” and “follows” for
strings uses what is called lexicographic ordering, which is based on the Unicode values of
the characters in the strings. Lexicographic ordering is not the same as alphabetical ordering,
even for strings that consist entirely of letters (because in lexicographic ordering, all the upper
case letters come before all the lower case letters). However, for words consisting strictly of
the 26 lower case letters in the English alphabet, lexicographic and alphabetic ordering are the
same. Thus, if str1 and str2 are strings containing only letters from the English alphabet,
then the test
str1.toLowerCase().compareTo(str2.toLowerCase()) < 0
is true if and only if str1 comes before str2 in alphabetical order.
7.4.5 Unsorting
I can’t resist ending this section on sorting with a related problem that is much less common,
but is a bit more fun. That is the problem of putting the elements of an array into a random
order. The typical case of this problem is shuffling a deck of cards. A good algorithm for
shuffling is similar to selection sort, except that instead of moving the biggest item to the end
of the list, an item is selected at random and moved to the end of the list. Here is a subroutine
to shuffle an array of ints:
/**
* Postcondition: The items in A have been rearranged into a random order.
*/
static void shuffle(int[] A) {](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-367-320.jpg)
![352 CHAPTER 7. ARRAYS
for (int lastPlace = A.length-1; lastPlace > 0; lastPlace--) {
// Choose a random location from among 0,1,...,lastPlace.
int randLoc = (int)(Math.random()*(lastPlace+1));
// Swap items in locations randLoc and lastPlace.
int temp = A[randLoc];
A[randLoc] = A[lastPlace];
A[lastPlace] = temp;
}
}
7.5 Multi-dimensional Arrays
Any type can be used as the base type of an array. You can have an array of ints, an
array of Strings, an array of Objects, and so on. In particular, since an array type is a first-class
Java type, you can have an array of arrays. For example, an array of ints has type int[ ]. This
means that there is automatically another type, int[ ][ ], which represents an “array of arrays of
ints”. Such an array is said to be a two-dimensional array. Of course once you have the
type int[ ][ ], there is nothing to stop you from forming the type int[ ][ ][ ], which represents a
three-dimensional array—and so on. There is no limit on the number of dimensions that an
array type can have. However, arrays of dimension three or higher are fairly uncommon, and
I concentrate here mainly on two-dimensional arrays. The type BaseType[ ][ ] is usually read
“two-dimensional array of BaseType” or “BaseType array array”.
7.5.1 Creating Two-dimensional Arrays
The declaration statement “int[][] A;” declares a variable named A of type int[ ][ ]. This
variable can hold a reference to an object of type int[ ][ ]. The assignment statement “A = new
int[3][4];” creates a new two-dimensional array object and sets A to point to the newly cre-
ated object. As usual, the declaration and assignment could be combined in a single declaration
statement “int[][] A = new int[3][4];”. The newly created object is an array of arrays-
of-ints. The notation int[3][4] indicates that there are 3 arrays-of-ints in the array A, and
that there are 4 ints in each array-of-ints. However, trying to think in such terms can get a bit
confusing—as you might have already noticed. So it is customary to think of a two-dimensional
array of items as a rectangular grid or matrix of items. The notation “new int[3][4]” can
then be taken to describe a grid of ints with 3 rows and 4 columns. The following picture
might help:](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-368-320.jpg)
![7.5. MULTI-DIMENSIONAL ARRAYS 353
1 0 1 2 ! 1
7 ! 3 2 5
! 5 ! 2 2 ! 9
For the most part, you can ignore the reality and keep the picture of a grid in mind.
Sometimes, though, you will need to remember that each row in the grid is really an array in
itself. These arrays can be referred to as A[0], A[1], and A[2]. Each row is in fact a value of
type int[ ]. It could, for example, be passed to a subroutine that asks for a parameter of type
int[ ].
The notation A[1] refers to one of the rows of the array A. Since A[1] is itself an array of
ints, you can use another subscript to refer to one of the positions in that row. For example,
A[1][3] refers to item number 3 in row number 1. Keep in mind, of course, that both rows
and columns are numbered starting from zero. So, in the above example, A[1][3] is 5. More
generally, A[i][j] refers to the grid position in row number i and column number j. The 12
items in A are named as follows:
A[0][0] A[0][1] A[0][2] A[0][3]
A[1][0] A[1][1] A[1][2] A[1][3]
A[2][0] A[2][1] A[2][2] A[2][3]
A[i][j] is actually a variable of type int. You can assign integer values to it or use it in any
other context where an integer variable is allowed.
It might be worth noting that A.length gives the number of rows of A. To get the number
of columns in A, you have to ask how many ints there are in a row; this number would be
given by A[0].length, or equivalently by A[1].length or A[2].length. (There is actually
no rule that says that all the rows of an array must have the same length, and some advanced
applications of arrays use varying-sized rows. But if you use the new operator to create an array
in the manner described above, you’ll always get an array with equal-sized rows.)
Three-dimensional arrays are treated similarly. For example, a three-dimensional array of
ints could be created with the declaration statement “int[][][] B = new int[7][5][11];”.
It’s possible to visualize the value of B as a solid 7-by-5-by-11 block of cells. Each cell holds an
int and represents one position in the three-dimensional array. Individual positions in the array
can be referred to with variable names of the form B[i][j][k]. Higher-dimensional arrays](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-369-320.jpg)
![354 CHAPTER 7. ARRAYS
follow the same pattern, although for dimensions greater than three, there is no easy way to
visualize the structure of the array.
It’s possible to fill a multi-dimensional array with specified items at the time it is declared.
Recall that when an ordinary one-dimensional array variable is declared, it can be assigned
an “array initializer,” which is just a list of values enclosed between braces, { and }. Array
initializers can also be used when a multi-dimensional array is declared. An initializer for a
two-dimensional array consists of a list of one-dimensional array initializers, one for each row
in the two-dimensional array. For example, the array A shown in the picture above could be
created with:
int[][] A = { { 1, 0, 12, -1 },
{ 7, -3, 2, 5 },
{ -5, -2, 2, -9 }
};
If no initializer is provided for an array, then when the array is created it is automatically filled
with the appropriate value: zero for numbers, false for boolean, and null for objects.
7.5.2 Using Two-dimensional Arrays
Just as in the case of one-dimensional arrays, two-dimensional arrays are often processed using
for statements. To process all the items in a two-dimensional array, you have to use one for
statement nested inside another. If the array A is declared as
int[][] A = new int[3][4];
then you could store a zero into each location in A with:
for (int row = 0; row < 3; row++) {
for (int column = 0; column < 4; column++) {
A[row][column] = 0;
}
}
The first time the outer for loop executes (with row = 0), the inner for loop fills in the four
values in the first row of A, namely A[0][0] = 0, A[0][1] = 0, A[0][2] = 0, and A[0][3]
= 0. The next execution of the outer for loop fills in the second row of A. And the third and
final execution of the outer loop fills in the final row of A.
Similarly, you could add up all the items in A with:
int sum = 0;
for (int i = 0; i < 3; i++)
for (int j = 0; j < 4; j++)
sum = sum + A[i][j];
This could even be done with nested for-each loops. Keep in mind that the elements in A are
objects of type int[ ], while the elements in each row of A are of type int:
int sum = 0;
for ( int[] row : A ) { // For each row in A...
for ( int item : row ) // For each item in that row...
sum = sum + item; // Add item to the sum.
}](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-370-320.jpg)
![7.5. MULTI-DIMENSIONAL ARRAYS 355
To process a three-dimensional array, you would, of course, use triply nested for loops.
∗ ∗ ∗
A two-dimensional array can be used whenever the data that is being represented can be
arranged into rows and columns in a natural way. Often, the grid is built into the problem.
For example, a chess board is a grid with 8 rows and 8 columns. If a class named ChessPiece
is available to represent individual chess pieces, then the contents of a chess board could be
represented by a two-dimensional array:
ChessPiece[][] board = new ChessPiece[8][8];
Or consider the “mosaic” of colored rectangles used in an example in Subsection 4.6.2. The
mosaic is implemented by a class named MosaicCanvas.java. The data about the color of each
of the rectangles in the mosaic is stored in an instance variable named grid of type Color[ ][ ].
Each position in this grid is occupied by a value of type Color. There is one position in the grid
for each colored rectangle in the mosaic. The actual two-dimensional array is created by the
statement:
grid = new Color[ROWS][COLUMNS];
where ROWS is the number of rows of rectangles in the mosaic and COLUMNS is the number of
columns. The value of the Color variable grid[i][j] is the color of the rectangle in row number
i and column number j. When the color of that rectangle is changed to some color, c, the value
stored in grid[i][j] is changed with a statement of the form “grid[i][j] = c;”. When the
mosaic is redrawn, the values stored in the two-dimensional array are used to decide what color
to make each rectangle. Here is a simplified version of the code from the MosaicCanvas class
that draws all the colored rectangles in the grid. You can see how it uses the array:
int rowHeight = getHeight() / ROWS;
int colWidth = getWidth() / COLUMNS;
for (int row = 0; row < ROWS; row++) {
for (int col = 0; col < COLUMNS; col++) {
g.setColor( grid[row][col] ); // Get color from array.
g.fillRect( col*colWidth, row*rowHeight,
colWidth, rowHeight );
}
}
Sometimes two-dimensional arrays are used in problems in which the grid is not so visually
obvious. Consider a company that owns 25 stores. Suppose that the company has data about
the profit earned at each store for each month in the year 2006. If the stores are numbered
from 0 to 24, and if the twelve months from January ’06 through December ’06 are numbered
from 0 to 11, then the profit data could be stored in an array, profit, constructed as follows:
double[][] profit = new double[25][12];
profit[3][2] would be the amount of profit earned at store number 3 in March, and
more generally, profit[storeNum][monthNum] would be the amount of profit earned in store
number storeNum in month number monthNum. In this example, the one-dimensional array
profit[storeNum] has a very useful meaning: It is just the profit data for one particular store
for the whole year.
Let’s assume that the profit array has already been filled with data. This data can be
processed in a lot of interesting ways. For example, the total profit for the company—for the
whole year from all its stores—can be calculated by adding up all the entries in the array:](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-371-320.jpg)
![356 CHAPTER 7. ARRAYS
double totalProfit; // Company’s total profit in 2006.
totalProfit = 0;
for (int store = 0; store < 25; store++) {
for (int month = 0; month < 12; month++)
totalProfit += profit[store][month];
}
Sometimes it is necessary to process a single row or a single column of an array, not the
entire array. For example, to compute the total profit earned by the company in December,
that is, in month number 11, you could use the loop:
double decemberProfit = 0.0;
for (storeNum = 0; storeNum < 25; storeNum++)
decemberProfit += profit[storeNum][11];
Let’s extend this idea to create a one-dimensional array that contains the total profit for each
month of the year:
double[] monthlyProfit; // Holds profit for each month.
monthlyProfit = new double[12];
for (int month = 0; month < 12; month++) {
// compute the total profit from all stores in this month.
monthlyProfit[month] = 0.0;
for (int store = 0; store < 25; store++) {
// Add the profit from this store in this month
// into the total profit figure for the month.
monthlyProfit[month] += profit[store][month];
}
}
As a final example of processing the profit array, suppose that we wanted to know which
store generated the most profit over the course of the year. To do this, we have to add up the
monthly profits for each store. In array terms, this means that we want to find the sum of each
row in the array. As we do this, we need to keep track of which row produces the largest total.
double maxProfit; // Maximum profit earned by a store.
int bestStore; // The number of the store with the
// maximum profit.
double total = 0.0; // Total profit for one store.
// First compute the profit from store number 0.
for (int month = 0; month < 12; month++)
total += profit[0][month];
bestStore = 0; // Start by assuming that the best
maxProfit = total; // store is store number 0.
// Now, go through the other stores, and whenever we
// find one with a bigger profit than maxProfit, revise
// the assumptions about bestStore and maxProfit.
for (store = 1; store < 25; store++) {
// Compute this store’s profit for the year.
total = 0.0;](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-372-320.jpg)
![7.5. MULTI-DIMENSIONAL ARRAYS 357
for (month = 0; month < 12; month++)
total += profit[store][month];
// Compare this store’s profits with the highest
// profit we have seen among the preceding stores.
if (total > maxProfit) {
maxProfit = total; // Best profit seen so far!
bestStore = store; // It came from this store.
}
} // end for
// At this point, maxProfit is the best profit of any
// of the 25 stores, and bestStore is a store that
// generated that profit. (Note that there could also be
// other stores that generated exactly the same profit.)
7.5.3 Example: Checkers
For the rest of this section, we’ll look at a more substantial example. We look at a program that
lets two users play checkers against each other. A player moves by clicking on the piece to be
moved and then on the empty square to which it is to be moved. The squares that the current
player can legally click are hilited. The square containing a piece that has been selected to be
moved is surrounded by a white border. Other pieces that can legally be moved are surrounded
by a cyan-colored border. If a piece has been selected, each empty square that it can legally
move to is hilited with a green border. The game enforces the rule that if the current player can
jump one of the opponent’s pieces, then the player must jump. When a player’s piece becomes
a king, by reaching the opposite end of the board, a big white “K” is drawn on the piece. You
can try an applet version of the program in the on-line version of this section. Here is what it
looks like:
I will only cover a part of the programming of this applet. I encourage you to read the
complete source code, Checkers.java. At over 750 lines, this is a more substantial example
than anything you’ve seen before in this course, but it’s an excellent example of state-based,
event-driven programming.
The data about the pieces on the board are stored in a two-dimensional array. Because of
the complexity of the program, I wanted to divide it into several classes. In addition to the](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-373-320.jpg)
![358 CHAPTER 7. ARRAYS
main class, there are several nested classes. One of these classes is CheckersData, which handles
the data for the board. It is mainly this class that I want to talk about.
The CheckersData class has an instance variable named board of type int[][]. The value
of board is set to “new int[8][8]”, an 8-by-8 grid of integers. The values stored in the grid
are defined as constants representing the possible contents of a square on a checkerboard:
static final int
EMPTY = 0, // Value representing an empty square.
RED = 1, // A regular red piece.
RED KING = 2, // A red king.
BLACK = 3, // A regular black piece.
BLACK KING = 4; // A black king.
The constants RED and BLACK are also used in my program (or, perhaps, misused) to represent
the two players in the game. When a game is started, the values in the variable, board, are set
to represent the initial state of the board. The grid of values looks like
B L A C K E M P T Y B L A C K E M P T Y B L A C K E M P T Y B L A C K E M P T Y
0
B L A C K
E M P T Y B L A C K E M P T Y B L A C K E M P T Y B L A C K E M P T Y
1
B L A C K E M P T Y B L A C K E M P T Y B L A C K E M P T Y B L A C K E M P T Y
2
E M P T Y E M P T Y E M P T Y E M P T Y
3
E M P T Y E M P T Y E M P T Y E M P T Y
E M P T Y E M P T Y E M P T Y E M P T Y
4
E M P T Y E M P T Y E M P T Y E M P T Y
5 R
E D
6 R
E D E M P T Y E M P T Y E M P T Y E M P T Y
7
R
E D
R
E D
R
E D
E M P T Y E M P T Y E M P T Y E M P T Y
R
E D
R
E D
R
E D
0 1
2 3
4
5 6
7
R
E D
E M P T Y E M P T Y E M P T Y E M P T Y
R
E D
R
E D
R
E D
A black piece can only move “down” the grid. That is, the row number of the square it
moves to must be greater than the row number of the square it comes from. A red piece can
only move up the grid. Kings of either color, of course, can move in both directions.
One function of the CheckersData class is to take care of all the details of making moves
on the board. An instance method named makeMove() is provided to do this. When a player
moves a piece from one square to another, the values stored at two positions in the array are
changed. But that’s not all. If the move is a jump, then the piece that was jumped is removed
from the board. (The method checks whether the move is a jump by checking if the square to
which the piece is moving is two rows away from the square where it starts.) Furthermore, a
RED piece that moves to row 0 or a BLACK piece that moves to row 7 becomes a king. This is
good programming: the rest of the program doesn’t have to worry about any of these details.
It just calls this makeMove() method:
/**
* Make the move from (fromRow,fromCol) to (toRow,toCol). It is
* ASSUMED that this move is legal! If the move is a jump, the
* jumped piece is removed from the board. If a piece moves
* to the last row on the opponent’s side of the board, the
* piece becomes a king.
*/
void makeMove(int fromRow, int fromCol, int toRow, int toCol) {](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-374-320.jpg)
![7.5. MULTI-DIMENSIONAL ARRAYS 359
board[toRow][toCol] = board[fromRow][fromCol]; // Move the piece.
board[fromRow][fromCol] = EMPTY;
if (fromRow - toRow == 2 || fromRow - toRow == -2) {
// The move is a jump. Remove the jumped piece from the board.
int jumpRow = (fromRow + toRow) / 2; // Row of the jumped piece.
int jumpCol = (fromCol + toCol) / 2; // Column of the jumped piece.
board[jumpRow][jumpCol] = EMPTY;
}
if (toRow == 0 && board[toRow][toCol] == RED)
board[toRow][toCol] = RED KING; // Red piece becomes a king.
if (toRow == 7 && board[toRow][toCol] == BLACK)
board[toRow][toCol] = BLACK KING; // Black piece becomes a king.
} // end makeMove()
An even more important function of the CheckersData class is to find legal moves on the
board. In my program, a move in a Checkers game is represented by an object belonging to
the following class:
/**
* A CheckersMove object represents a move in the game of
* Checkers. It holds the row and column of the piece that is
* to be moved and the row and column of the square to which
* it is to be moved. (This class makes no guarantee that
* the move is legal.)
*/
private static class CheckersMove {
int fromRow, fromCol; // Position of piece to be moved.
int toRow, toCol; // Square it is to move to.
CheckersMove(int r1, int c1, int r2, int c2) {
// Constructor. Set the values of the instance variables.
fromRow = r1;
fromCol = c1;
toRow = r2;
toCol = c2;
}
boolean isJump() {
// Test whether this move is a jump. It is assumed that
// the move is legal. In a jump, the piece moves two
// rows. (In a regular move, it only moves one row.)
return (fromRow - toRow == 2 || fromRow - toRow == -2);
}
} // end class CheckersMove.
The CheckersData class has an instance method which finds all the legal moves that are
currently available for a specified player. This method is a function that returns an array
of type CheckersMove[ ]. The array contains all the legal moves, represented as CheckersMove
objects. The specification for this method reads](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-375-320.jpg)
![360 CHAPTER 7. ARRAYS
/**
* Return an array containing all the legal CheckersMoves
* for the specified player on the current board. If the player
* has no legal moves, null is returned. The value of player
* should be one of the constants RED or BLACK; if not, null
* is returned. If the returned value is non-null, it consists
* entirely of jump moves or entirely of regular moves, since
* if the player can jump, only jumps are legal moves.
*/
CheckersMove[] getLegalMoves(int player)
A brief pseudocode algorithm for the method is
Start with an empty list of moves
Find any legal jumps and add them to the list
if there are no jumps:
Find any other legal moves and add them to the list
if the list is empty:
return null
else:
return the list
Now, what is this “list”? We have to return the legal moves in an array. But since an array has
a fixed size, we can’t create the array until we know how many moves there are, and we don’t
know that until near the end of the method, after we’ve already made the list! A neat solution
is to use an ArrayList instead of an array to hold the moves as we find them. In fact, I use an
object defined by the parameterized type ArrayList<CheckersMove> so that the list is restricted
to holding objects of type CheckersMove. As we add moves to the list, it will grow just as large
as necessary. At the end of the method, we can create the array that we really want and copy
the data into it:
Let "moves" be an empty ArrayList<CheckerMove>
Find any legal jumps and add them to moves
if moves.size() is 0:
Find any other legal moves and add them to moves
if moves.size() is 0:
return null
else:
Let moveArray be an array of CheckersMoves of length moves.size()
Copy the contents of moves into moveArray
return moveArray
Now, how do we find the legal jumps or the legal moves? The information we need is in the
board array, but it takes some work to extract it. We have to look through all the positions
in the array and find the pieces that belong to the current player. For each piece, we have to
check each square that it could conceivably move to, and check whether that would be a legal
move. There are four squares to consider. For a jump, we want to look at squares that are two
rows and two columns away from the piece. Thus, the line in the algorithm that says “Find
any legal jumps and add them to moves” expands to:
For each row of the board:
For each column of the board:
if one of the player’s pieces is at this location:
if it is legal to jump to row + 2, column + 2
add this move to moves](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-376-320.jpg)
![7.5. MULTI-DIMENSIONAL ARRAYS 361
if it is legal to jump to row - 2, column + 2
add this move to moves
if it is legal to jump to row + 2, column - 2
add this move to moves
if it is legal to jump to row - 2, column - 2
add this move to moves
The line that says “Find any other legal moves and add them to moves” expands to some-
thing similar, except that we have to look at the four squares that are one column and one
row away from the piece. Testing whether a player can legally move from one given square to
another given square is itself non-trivial. The square the player is moving to must actually be
on the board, and it must be empty. Furthermore, regular red and black pieces can only move
in one direction. I wrote the following utility method to check whether a player can make a
given non-jump move:
/**
* This is called by the getLegalMoves() method to determine
* whether the player can legally move from (r1,c1) to (r2,c2).
* It is ASSUMED that (r1,c1) contains one of the player’s
* pieces and that (r2,c2) is a neighboring square.
*/
private boolean canMove(int player, int r1, int c1, int r2, int c2) {
if (r2 < 0 || r2 >= 8 || c2 < 0 || c2 >= 8)
return false; // (r2,c2) is off the board.
if (board[r2][c2] != EMPTY)
return false; // (r2,c2) already contains a piece.
if (player == RED) {
if (board[r1][c1] == RED && r2 > r1)
return false; // Regular red piece can only move down.
return true; // The move is legal.
}
else {
if (board[r1][c1] == BLACK && r2 < r1)
return false; // Regular black piece can only move up.
return true; // The move is legal.
}
} // end canMove()
This method is called by my getLegalMoves() method to check whether one of the possible
moves that it has found is actually legal. I have a similar method that is called to check whether
a jump is legal. In this case, I pass to the method the square containing the player’s piece,
the square that the player might move to, and the square between those two, which the player
would be jumping over. The square that is being jumped must contain one of the opponent’s
pieces. This method has the specification:
/**
* This is called by other methods to check whether
* the player can legally jump from (r1,c1) to (r3,c3).
* It is assumed that the player has a piece at (r1,c1), that
* (r3,c3) is a position that is 2 rows and 2 columns distant
* from (r1,c1) and that (r2,c2) is the square between (r1,c1)
* and (r3,c3).](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-377-320.jpg)
![362 CHAPTER 7. ARRAYS
*/
private boolean canJump(int player, int r1, int c1,
int r2, int c2, int r3, int c3) { . . .
Given all this, you should be in a position to understand the complete getLegalMoves()
method. It’s a nice way to finish off this chapter, since it combines several topics that we’ve
looked at: one-dimensional arrays, ArrayLists, and two-dimensional arrays:
CheckersMove[] getLegalMoves(int player) {
if (player != RED && player != BLACK)
return null;
int playerKing; // The constant for a King belonging to the player.
if (player == RED)
playerKing = RED KING;
else
playerKing = BLACK KING;
ArrayList<ChecherMove> moves = new ArrayList<CheckerMove>();
// Moves will be stored in this list.
/* First, check for any possible jumps. Look at each square on
the board. If that square contains one of the player’s pieces,
look at a possible jump in each of the four directions from that
square. If there is a legal jump in that direction, put it in
the moves ArrayList.
*/
for (int row = 0; row < 8; row++) {
for (int col = 0; col < 8; col++) {
if (board[row][col] == player || board[row][col] == playerKing) {
if (canJump(player, row, col, row+1, col+1, row+2, col+2))
moves.add(new CheckersMove(row, col, row+2, col+2));
if (canJump(player, row, col, row-1, col+1, row-2, col+2))
moves.add(new CheckersMove(row, col, row-2, col+2));
if (canJump(player, row, col, row+1, col-1, row+2, col-2))
moves.add(new CheckersMove(row, col, row+2, col-2));
if (canJump(player, row, col, row-1, col-1, row-2, col-2))
moves.add(new CheckersMove(row, col, row-2, col-2));
}
}
}
/* If any jump moves were found, then the user must jump, so we
don’t add any regular moves. However, if no jumps were found,
check for any legal regular moves. Look at each square on
the board. If that square contains one of the player’s pieces,
look at a possible move in each of the four directions from
that square. If there is a legal move in that direction,
put it in the moves ArrayList.
*/
if (moves.size() == 0) {
for (int row = 0; row < 8; row++) {
for (int col = 0; col < 8; col++) {
if (board[row][col] == player || board[row][col] == playerKing) {](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-378-320.jpg)
![7.5. MULTI-DIMENSIONAL ARRAYS 363
if (canMove(player,row,col,row+1,col+1))
moves.add(new CheckersMove(row,col,row+1,col+1));
if (canMove(player,row,col,row-1,col+1))
moves.add(new CheckersMove(row,col,row-1,col+1));
if (canMove(player,row,col,row+1,col-1))
moves.add(new CheckersMove(row,col,row+1,col-1));
if (canMove(player,row,col,row-1,col-1))
moves.add(new CheckersMove(row,col,row-1,col-1));
}
}
}
}
/* If no legal moves have been found, return null. Otherwise, create
an array just big enough to hold all the legal moves, copy the
legal moves from the ArrayList into the array, and return the array.
*/
if (moves.size() == 0)
return null;
else {
CheckersMove[] moveArray = new CheckersMove[moves.size()];
for (int i = 0; i < moves.size(); i++)
moveArray[i] = moves.get(i);
return moveArray;
}
} // end getLegalMoves](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-379-320.jpg)
![364 CHAPTER 7. ARRAYS
Exercises for Chapter 7
1. An example in Subsection 7.2.4 tried to answer the question, How many random people do
you have to select before you find a duplicate birthday? The source code for that program
can be found in the file BirthdayProblemDemo.java. Here are some related questions:
• How many random people do you have to select before you find three people who
share the same birthday? (That is, all three people were born on the same day in
the same month, but not necessarily in the same year.)
• Suppose you choose 365 people at random. How many different birthdays will they
have? (The number could theoretically be anywhere from 1 to 365).
• How many different people do you have to check before you’ve found at least one
person with a birthday on each of the 365 days of the year?
Write three programs to answer these questions. Each of your programs should sim-
ulate choosing people at random and checking their birthdays. (In each case, ignore the
possibility of leap years.)
2. Write a program that will read a sequence of positive real numbers entered by the user
and will print the same numbers in sorted order from smallest to largest. The user will
input a zero to mark the end of the input. Assume that at most 100 positive numbers will
be entered.
3. A polygon is a geometric figure made up of a sequence of connected line segments. The
points where the line segments meet are called the vertices of the polygon. The Graph-
ics class includes commands for drawing and filling polygons. For these commands, the
coordinates of the vertices of the polygon are stored in arrays. If g is a variable of type
Graphics then
• g.drawPolygon(xCoords, yCoords, pointCt) will draw the outline of the polygon
with vertices at the points (xCoords[0],yCoords[0]), (xCoords[1],yCoords[1]),
. . . , (xCoords[pointCt-1],yCoords[pointCt-1]). The third parameter, pointCt,
is an int that specifies the number of vertices of the polygon. Its value
should be 3 or greater. The first two parameters are arrays of type
int[]. Note that the polygon automatically includes a line from the last
point, (xCoords[pointCt-1],yCoords[pointCt-1]), back to the starting point
(xCoords[0],yCoords[0]).
• g.fillPolygon(xCoords, yCoords, pointCt) fills the interior of the polygon with
the current drawing color. The parameters have the same meaning as in the
drawPolygon() method. Note that it is OK for the sides of the polygon to cross
each other, but the interior of a polygon with self-intersections might not be exactly
what you expect.
Write a panel class that lets the user draw polygons, and use your panel as the content
pane in an applet (or standalone application). As the user clicks a sequence of points,
count them and store their x- and y-coordinates in two arrays. These points will be the
vertices of the polygon. Also, draw a line between each consecutive pair of points to give
the user some visual feedback. When the user clicks near the starting point, draw the](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-380-320.jpg)
![366 CHAPTER 7. ARRAYS
If ball is a variable of type MovingBall, then the following methods are available:
• ball.draw(g) — draw the ball in a graphics context. The parameter, g, must be of
type Graphics. (The drawing color in g will be changed to the color of the ball.)
• ball.travel() — change the (x,y)-coordinates of the ball by an amount equal to
its speed. The ball has a certain direction of motion, and the ball is moved in that
direction. Ordinarily, you will call this once for each frame of an animation, so the
speed is given in terms of “pixels per frame”. Calling this routine does not move
the ball on the screen. It just changes the values of some instance variables in the
object. The next time the object’s draw() method is called, the ball will be drawn
in the new position.
• ball.headTowards(x,y) — change the direction of motion of the ball so that it is
headed towards the point (x,y). This does not affect the speed.
These are the methods that you will need for this exercise. There are also methods for
setting various properties of the ball, such as ball.setColor(color) for changing the
color and ball.setRadius(radius) for changing its size. See the source code for more
information.
For this exercise, you should create an applet that shows an animation of balls bouncing
around on a black background. Use a Timer to drive the animation. (See Subsection 6.5.1.)
Use an array of type MovingBall[] to hold the data for the balls. In addition, your
program should listen for mouse and mouse motion events. When the user presses the
mouse or drags the mouse, call each of the ball’s headTowards() methods to make the
balls head towards the mouse’s location. My solution uses 50 balls and a time delay of 50
milliseconds for the timer.
5. The sample program RandomArtPanel.java from Subsection 6.5.1 shows a different ran-
dom “artwork” every four seconds. There are three types of “art”, one made from lines,
one from circles, and one from filled squares. However, the program does not save the data
for the picture that is shown on the screen. As a result, the picture can](https://image.slidesharecdn.com/javanotes5-220615015655-842dc0be/85/javanotes5-pdf-382-320.jpg)
javanotes5.pdf
- 1. Introduction to Programming Using Java Version 5.0, December 2006 (Version 5.0.2, with minor corrections, November 2007) David J. Eck Hobart and William Smith Colleges
- 2. ii c 1996–2007, David J. Eck David J. Eck (eck@hws.edu) Department of Mathematics and Computer Science Hobart and William Smith Colleges Geneva, NY 14456 This book can be distributed in unmodified form with no restrictions. Modified versions can be made and distributed provided they are distributed under the same license as the original. More specifically: This work is licensed under the Creative Commons Attribution-Share Alike 2.5 License. To view a copy of this license, visit http://creativecommons.org/licenses/by- sa/2.5/ or send a letter to Creative Commons, 543 Howard Street, 5th Floor, San Francisco, California, 94105, USA. The web site for this book is: http://math.hws.edu/javanotes
- 3. Contents Preface xiii 1 The Mental Landscape 1 1.1 Machine Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.2 Asynchronous Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 1.3 The Java Virtual Machine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 1.4 Building Blocks of Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 1.5 Object-oriented Programming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 1.6 The Modern User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 1.7 The Internet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Quiz on Chapter 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 2 Names and Things 19 2.1 The Basic Java Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 2.2 Variables and Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 2.2.1 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 2.2.2 Types and Literals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 2.2.3 Variables in Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 2.3 Objects and Subroutines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 2.3.1 Built-in Subroutines and Functions . . . . . . . . . . . . . . . . . . . . . . 29 2.3.2 Operations on Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 2.3.3 Introduction to Enums . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 2.4 Text Input and Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 2.4.1 A First Text Input Example . . . . . . . . . . . . . . . . . . . . . . . . . . 37 2.4.2 Text Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 2.4.3 TextIO Input Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 2.4.4 Formatted Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 2.4.5 Introduction to File I/O . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 2.5 Details of Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 2.5.1 Arithmetic Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 2.5.2 Increment and Decrement . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 2.5.3 Relational Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 2.5.4 Boolean Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 2.5.5 Conditional Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 2.5.6 Assignment Operators and Type-Casts . . . . . . . . . . . . . . . . . . . . 48 2.5.7 Type Conversion of Strings . . . . . . . . . . . . . . . . . . . . . . . . . . 50 2.5.8 Precedence Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 2.6 Programming Environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 iii
- 4. iv CONTENTS 2.6.1 Java Development Kit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 2.6.2 Command Line Environment . . . . . . . . . . . . . . . . . . . . . . . . . 52 2.6.3 IDEs and Eclipse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 2.6.4 The Problem of Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 Exercises for Chapter 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Quiz on Chapter 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 3 Control 61 3.1 Blocks, Loops, and Branches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 3.1.1 Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 3.1.2 The Basic While Loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 3.1.3 The Basic If Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 3.2 Algorithm Development . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 3.2.1 Pseudocode and Stepwise Refinement . . . . . . . . . . . . . . . . . . . . 66 3.2.2 The 3N+1 Problem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 3.2.3 Coding, Testing, Debugging . . . . . . . . . . . . . . . . . . . . . . . . . . 72 3.3 while and do..while . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 3.3.1 The while Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 3.3.2 The do..while Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 3.3.3 break and continue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 3.4 The for Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 3.4.1 For Loops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 3.4.2 Example: Counting Divisors . . . . . . . . . . . . . . . . . . . . . . . . . . 83 3.4.3 Nested for Loops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 3.4.4 Enums and for-each Loops . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 3.5 The if Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 3.5.1 The Dangling else Problem . . . . . . . . . . . . . . . . . . . . . . . . . . 89 3.5.2 The if...else if Construction . . . . . . . . . . . . . . . . . . . . . . . . . . 89 3.5.3 If Statement Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 3.5.4 The Empty Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 3.6 The switch Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 3.6.1 The Basic switch Statement . . . . . . . . . . . . . . . . . . . . . . . . . . 96 3.6.2 Menus and switch Statements . . . . . . . . . . . . . . . . . . . . . . . . . 97 3.6.3 Enums in switch Statements . . . . . . . . . . . . . . . . . . . . . . . . . 98 3.6.4 Definite Assignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 3.7 Exceptions and try..catch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 3.7.1 Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 3.7.2 try..catch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 3.7.3 Exceptions in TextIO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 3.8 GUI Programming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 Exercises for Chapter 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 Quiz on Chapter 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 4 Subroutines 117 4.1 Black Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 4.2 Static Subroutines and Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 4.2.1 Subroutine Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 4.2.2 Calling Subroutines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
- 5. CONTENTS v 4.2.3 Subroutines in Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 4.2.4 Member Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 4.3 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 4.3.1 Using Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 4.3.2 Formal and Actual Parameters . . . . . . . . . . . . . . . . . . . . . . . . 128 4.3.3 Overloading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 4.3.4 Subroutine Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 4.3.5 Throwing Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 4.3.6 Global and Local Variables . . . . . . . . . . . . . . . . . . . . . . . . . . 133 4.4 Return Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 4.4.1 The return statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 4.4.2 Function Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 4.4.3 3N+1 Revisited . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 4.5 APIs, Packages, and Javadoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 4.5.1 Toolboxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 4.5.2 Java’s Standard Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 4.5.3 Using Classes from Packages . . . . . . . . . . . . . . . . . . . . . . . . . 142 4.5.4 Javadoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 4.6 More on Program Design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146 4.6.1 Preconditions and Postconditions . . . . . . . . . . . . . . . . . . . . . . . 146 4.6.2 A Design Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 4.6.3 The Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 4.7 The Truth About Declarations . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 4.7.1 Initialization in Declarations . . . . . . . . . . . . . . . . . . . . . . . . . 154 4.7.2 Named Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 4.7.3 Naming and Scope Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 Exercises for Chapter 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 Quiz on Chapter 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 5 Objects and Classes 165 5.1 Objects and Instance Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 5.1.1 Objects, Classes, and Instances . . . . . . . . . . . . . . . . . . . . . . . . 166 5.1.2 Fundamentals of Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 5.1.3 Getters and Setters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172 5.2 Constructors and Object Initialization . . . . . . . . . . . . . . . . . . . . . . . . 173 5.2.1 Initializing Instance Variables . . . . . . . . . . . . . . . . . . . . . . . . . 173 5.2.2 Constructors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 5.2.3 Garbage Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 5.3 Programming with Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 5.3.1 Some Built-in Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 5.3.2 Wrapper Classes and Autoboxing . . . . . . . . . . . . . . . . . . . . . . . 181 5.3.3 The class “Object” . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 5.3.4 Object-oriented Analysis and Design . . . . . . . . . . . . . . . . . . . . . 183 5.4 Programming Example: Card, Hand, Deck . . . . . . . . . . . . . . . . . . . . . . 185 5.4.1 Designing the classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 5.4.2 The Card Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 5.4.3 Example: A Simple Card Game . . . . . . . . . . . . . . . . . . . . . . . . 191
- 6. vi CONTENTS 5.5 Inheritance and Polymorphism . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194 5.5.1 Extending Existing Classes . . . . . . . . . . . . . . . . . . . . . . . . . . 194 5.5.2 Inheritance and Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . 196 5.5.3 Example: Vehicles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197 5.5.4 Polymorphism . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 5.5.5 Abstract Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 5.6 this and super . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 5.6.1 The Special Variable this . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 5.6.2 The Special Variable super . . . . . . . . . . . . . . . . . . . . . . . . . . 206 5.6.3 Constructors in Subclasses . . . . . . . . . . . . . . . . . . . . . . . . . . 208 5.7 Interfaces, Nested Classes, and Other Details . . . . . . . . . . . . . . . . . . . . 209 5.7.1 Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209 5.7.2 Nested Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211 5.7.3 Anonymous Inner Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 5.7.4 Mixing Static and Non-static . . . . . . . . . . . . . . . . . . . . . . . . . 214 5.7.5 Static Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216 5.7.6 Enums as Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217 Exercises for Chapter 5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 Quiz on Chapter 5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 6 Introduction to GUI Programming 225 6.1 The Basic GUI Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225 6.1.1 JFrame and JPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227 6.1.2 Components and Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229 6.1.3 Events and Listeners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230 6.2 Applets and HTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231 6.2.1 JApplet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231 6.2.2 Reusing Your JPanels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 6.2.3 Basic HTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235 6.2.4 Applets on Web Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238 6.3 Graphics and Painting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240 6.3.1 Coordinates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 6.3.2 Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243 6.3.3 Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 6.3.4 Shapes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245 6.3.5 Graphics2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246 6.3.6 An Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247 6.4 Mouse Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251 6.4.1 Event Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252 6.4.2 MouseEvent and MouseListener . . . . . . . . . . . . . . . . . . . . . . . . 253 6.4.3 Mouse Coordinates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256 6.4.4 MouseMotionListeners and Dragging . . . . . . . . . . . . . . . . . . . . . 258 6.4.5 Anonymous Event Handlers . . . . . . . . . . . . . . . . . . . . . . . . . . 262 6.5 Timer and Keyboard Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264 6.5.1 Timers and Animation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264 6.5.2 Keyboard Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266 6.5.3 Focus Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
- 7. CONTENTS vii 6.5.4 State Machines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270 6.6 Basic Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273 6.6.1 JButton . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275 6.6.2 JLabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276 6.6.3 JCheckBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277 6.6.4 JTextField and JTextArea . . . . . . . . . . . . . . . . . . . . . . . . . . . 278 6.6.5 JComboBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279 6.6.6 JSlider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280 6.7 Basic Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282 6.7.1 Basic Layout Managers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283 6.7.2 Borders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285 6.7.3 SliderAndComboBoxDemo . . . . . . . . . . . . . . . . . . . . . . . . . . 287 6.7.4 A Simple Calculator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289 6.7.5 Using a null Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291 6.7.6 A Little Card Game . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293 6.8 Menus and Dialogs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296 6.8.1 Menus and Menubars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297 6.8.2 Dialogs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300 6.8.3 Fine Points of Frames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302 6.8.4 Creating Jar Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304 Exercises for Chapter 6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306 Quiz on Chapter 6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311 7 Arrays 313 7.1 Creating and Using Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313 7.1.1 Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314 7.1.2 Using Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314 7.1.3 Array Initialization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316 7.2 Programming With Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318 7.2.1 Arrays and for Loops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318 7.2.2 Arrays and for-each Loops . . . . . . . . . . . . . . . . . . . . . . . . . . . 320 7.2.3 Array Types in Subroutines . . . . . . . . . . . . . . . . . . . . . . . . . . 321 7.2.4 Random Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322 7.2.5 Arrays of Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324 7.2.6 Variable Arity Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327 7.3 Dynamic Arrays and ArrayLists . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329 7.3.1 Partially Full Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329 7.3.2 Dynamic Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332 7.3.3 ArrrayLists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335 7.3.4 Parameterized Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339 7.3.5 Vectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342 7.4 Searching and Sorting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343 7.4.1 Searching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343 7.4.2 Association Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345 7.4.3 Insertion Sort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348 7.4.4 Selection Sort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349 7.4.5 Unsorting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351
- 8. viii CONTENTS 7.5 Multi-dimensional Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352 7.5.1 Creating Two-dimensional Arrays . . . . . . . . . . . . . . . . . . . . . . 352 7.5.2 Using Two-dimensional Arrays . . . . . . . . . . . . . . . . . . . . . . . . 354 7.5.3 Example: Checkers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357 Exercises for Chapter 7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364 Quiz on Chapter 7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370 8 Correctness and Robustness 373 8.1 Introduction to Correctness and Robustness . . . . . . . . . . . . . . . . . . . . . 373 8.1.1 Horror Stories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374 8.1.2 Java to the Rescue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375 8.1.3 Problems Remain in Java . . . . . . . . . . . . . . . . . . . . . . . . . . . 377 8.2 Writing Correct Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378 8.2.1 Provably Correct Programs . . . . . . . . . . . . . . . . . . . . . . . . . . 378 8.2.2 Robust Handling of Input . . . . . . . . . . . . . . . . . . . . . . . . . . . 381 8.3 Exceptions and try..catch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385 8.3.1 Exceptions and Exception Classes . . . . . . . . . . . . . . . . . . . . . . 386 8.3.2 The try Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388 8.3.3 Throwing Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390 8.3.4 Mandatory Exception Handling . . . . . . . . . . . . . . . . . . . . . . . . 392 8.3.5 Programming with Exceptions . . . . . . . . . . . . . . . . . . . . . . . . 393 8.4 Assertions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396 8.5 Introduction to Threads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399 8.5.1 Creating and Running Threads . . . . . . . . . . . . . . . . . . . . . . . . 400 8.5.2 Operations on Threads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404 8.5.3 Mutual Exclusion with “synchronized” . . . . . . . . . . . . . . . . . . . . 405 8.5.4 Wait and Notify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408 8.5.5 Volatile Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412 8.6 Analysis of Algorithms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413 Exercises for Chapter 8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419 Quiz on Chapter 8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424 9 Linked Data Structures and Recursion 427 9.1 Recursion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427 9.1.1 Recursive Binary Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428 9.1.2 Towers of Hanoi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430 9.1.3 A Recursive Sorting Algorithm . . . . . . . . . . . . . . . . . . . . . . . . 432 9.1.4 Blob Counting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435 9.2 Linked Data Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439 9.2.1 Recursive Linking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439 9.2.2 Linked Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441 9.2.3 Basic Linked List Processing . . . . . . . . . . . . . . . . . . . . . . . . . 441 9.2.4 Inserting into a Linked List . . . . . . . . . . . . . . . . . . . . . . . . . . 445 9.2.5 Deleting from a Linked List . . . . . . . . . . . . . . . . . . . . . . . . . . 447 9.3 Stacks, Queues, and ADTs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448 9.3.1 Stacks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449 9.3.2 Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452 9.3.3 Postfix Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
- 9. CONTENTS ix 9.4 Binary Trees . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459 9.4.1 Tree Traversal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460 9.4.2 Binary Sort Trees . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462 9.4.3 Expression Trees . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467 9.5 A Simple Recursive Descent Parser . . . . . . . . . . . . . . . . . . . . . . . . . . 470 9.5.1 Backus-Naur Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470 9.5.2 Recursive Descent Parsing . . . . . . . . . . . . . . . . . . . . . . . . . . . 472 9.5.3 Building an Expression Tree . . . . . . . . . . . . . . . . . . . . . . . . . . 476 Exercises for Chapter 9 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479 Quiz on Chapter 9 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482 10 Generic Programming and Collection Classes 485 10.1 Generic Programming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485 10.1.1 Generic Programming in Smalltalk . . . . . . . . . . . . . . . . . . . . . . 486 10.1.2 Generic Programming in C++ . . . . . . . . . . . . . . . . . . . . . . . . 487 10.1.3 Generic Programming in Java . . . . . . . . . . . . . . . . . . . . . . . . . 488 10.1.4 The Java Collection Framework . . . . . . . . . . . . . . . . . . . . . . . . 489 10.1.5 Iterators and for-each Loops . . . . . . . . . . . . . . . . . . . . . . . . . . 491 10.1.6 Equality and Comparison . . . . . . . . . . . . . . . . . . . . . . . . . . . 492 10.1.7 Generics and Wrapper Classes . . . . . . . . . . . . . . . . . . . . . . . . 495 10.2 Lists and Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496 10.2.1 ArrayList and LinkedList . . . . . . . . . . . . . . . . . . . . . . . . . . . 496 10.2.2 Sorting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499 10.2.3 TreeSet and HashSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500 10.2.4 EnumSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503 10.3 Maps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504 10.3.1 The Map Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505 10.3.2 Views, SubSets, and SubMaps . . . . . . . . . . . . . . . . . . . . . . . . 506 10.3.3 Hash Tables and Hash Codes . . . . . . . . . . . . . . . . . . . . . . . . . 509 10.4 Programming with the Collection Framework . . . . . . . . . . . . . . . . . . . . 511 10.4.1 Symbol Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511 10.4.2 Sets Inside a Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512 10.4.3 Using a Comparator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515 10.4.4 Word Counting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517 10.5 Writing Generic Classes and Methods . . . . . . . . . . . . . . . . . . . . . . . . 519 10.5.1 Simple Generic Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520 10.5.2 Simple Generic Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521 10.5.3 Type Wildcards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523 10.5.4 Bounded Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527 Exercises for Chapter 10 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531 Quiz on Chapter 10 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535 11 Files and Networking 537 11.1 Streams, Readers, and Writers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537 11.1.1 Character and Byte Streams . . . . . . . . . . . . . . . . . . . . . . . . . 537 11.1.2 PrintWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539 11.1.3 Data Streams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540 11.1.4 Reading Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
- 10. x CONTENTS 11.1.5 The Scanner Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544 11.1.6 Serialized Object I/O . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545 11.2 Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546 11.2.1 Reading and Writing Files . . . . . . . . . . . . . . . . . . . . . . . . . . . 546 11.2.2 Files and Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549 11.2.3 File Dialog Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552 11.3 Programming With Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554 11.3.1 Copying a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555 11.3.2 Persistent Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557 11.3.3 Files in GUI Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559 11.3.4 Storing Objects in Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561 11.4 Networking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568 11.4.1 URLs and URLConnections . . . . . . . . . . . . . . . . . . . . . . . . . . 569 11.4.2 TCP/IP and Client/Server . . . . . . . . . . . . . . . . . . . . . . . . . . 571 11.4.3 Sockets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572 11.4.4 A Trivial Client/Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574 11.4.5 A Simple Network Chat . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578 11.5 Network Programming and Threads . . . . . . . . . . . . . . . . . . . . . . . . . 581 11.5.1 A Threaded GUI Chat Program. . . . . . . . . . . . . . . . . . . . . . . . 582 11.5.2 A Multithreaded Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585 11.5.3 Distributed Computing . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588 11.6 A Brief Introduction to XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596 11.6.1 Basic XML Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596 11.6.2 XMLEncoder and XMLDecoder . . . . . . . . . . . . . . . . . . . . . . . 598 11.6.3 Working With the DOM . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600 Exercises for Chapter 11 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606 Quiz on Chapter 11 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609 12 Advanced GUI Programming 611 12.1 Images and Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611 12.1.1 Images and BufferedImages . . . . . . . . . . . . . . . . . . . . . . . . . . 611 12.1.2 Working With Pixels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617 12.1.3 Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620 12.1.4 Cursors and Icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621 12.1.5 Image File I/O . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622 12.2 Fancier Graphics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624 12.2.1 Measuring Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625 12.2.2 Transparency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627 12.2.3 Antialiasing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629 12.2.4 Strokes and Paints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630 12.2.5 Transforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633 12.3 Actions and Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636 12.3.1 Action and AbstractAction . . . . . . . . . . . . . . . . . . . . . . . . . . 636 12.3.2 Icons on Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638 12.3.3 Radio Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639 12.3.4 Toolbars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 642 12.3.5 Keyboard Accelerators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643
- 11. CONTENTS xi 12.3.6 HTML on Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645 12.4 Complex Components and MVC . . . . . . . . . . . . . . . . . . . . . . . . . . . 646 12.4.1 Model-View-Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646 12.4.2 Lists and ListModels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647 12.4.3 Tables and TableModels . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650 12.4.4 Documents and Editors . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654 12.4.5 Custom Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655 12.5 Finishing Touches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660 12.5.1 The Mandelbrot Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660 12.5.2 Design of the Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662 12.5.3 Internationalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664 12.5.4 Events, Events, Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666 12.5.5 Custom Dialogs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668 12.5.6 Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669 Exercises for Chapter 12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671 Quiz on Chapter 12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673 Appendix: Source Files 675
- 12. xii CONTENTS
- 13. Preface Introduction to Programming Using Java is a free introductory computer programming textbook that uses Java as the language of instruction. It is suitable for use in an introductory programming course and for people who are trying to learn programming on their own. There are no prerequisites beyond a general familiarity with the ideas of computers and programs. There is enough material for a full year of college-level programming. Chapters 1 through 7 can be used as a textbook in a one-semester college-level course or in a year-long high school course. This version of the book covers “Java 5.0”, and many of the examples use features that were not present in earlier versions of Java. (Sometimes, you will see this version of Java referred to as Java 1.5 instead of Java 5.0.) Note that Java applets appear throughout the pages of the on-line version of this book. Many of those applets will be non-functional in Web browsers that do not support Java 5.0. The home web site for this book is http://math.hws.edu/javanotes/. The page at that address contains links for downloading a copy of the web site and for downloading a PDF version of the book. ∗ ∗ ∗ In style, this is a textbook rather than a tutorial. That is, it concentrates on explaining concepts rather than giving step-by-step how-to-do-it guides. I have tried to use a conversational writing style that might be closer to classroom lecture than to a typical textbook. You’ll find programming exercises at the end of most chapters, and you will find a detailed solution for each exercise, with the sort of discussion that I would give if I presented the solution in class. (Solutions to the exercises can be found in the on-line version only.) I strongly advise that you read the exercise solutions if you want to get the most out of this book. This is certainly not a Java reference book, and it is not even close to a comprehensive survey of all the features of Java. It is not written as a quick introduction to Java for people who already know another programming language. Instead, it is directed mainly towards people who are learning programming for the first time, and it is as much about general programming concepts as it is about Java in particular. I believe that Introduction to Programming using Java is fully competitive with the conventionally published, printed programming textbooks that are available on the market. (Well, all right, I’ll confess that I think it’s better.) There are several approaches to teaching Java. One approach uses graphical user interface programming from the very beginning. Some people believe that object oriented programming should also be emphasized from the very beginning. This is not the approach that I take. The approach that I favor starts with the more basic building blocks of programming and builds from there. After an introductory chapter, I cover procedural programming in Chapters 2, 3, and 4. Object-oriented programming is introduced in Chapter 5. Chapters 6 covers the closely related topic of event-oriented programming and graphical user interfaces. Arrays are covered in Chapter 7. Chapter 8 marks a turning point in the book, moving beyond the fundamental ideas xiii
- 14. xiv Preface of programming to cover more advanced topics. Chapter 8 is mostly about writing robust and correct programs, but it also has a section on parallel processing and threads. Chapters 9 and 10 cover recursion and data structures, including the Java Collection Framework. Chapter 11 is about files and networking. Finally, Chapter 12 returns to the topic of graphical user interface programming to cover some of Java’s more advanced capabilities. ∗ ∗ ∗ Major changes have been made in the fifth edition. Perhaps the most significant change is the use of parameterized types in the chapter on generic programming. Parameterized types— Java’s version of templates—were the most eagerly anticipated new feature in Java 5.0. Other new features in Java 5.0 are also covered. Enumerated types are introduced, although they are not covered in their full complexity. The “for-each” loop is covered and is used extensively. Formatted output is also used extensively, and the Scanner class is covered (though not until Chapter 11). Static import is covered briefly, as are variable arity methods. The non-standard TextIO class that I use for input in the first half of the book has been rewritten to support formatted output. I have also added some file I/O capabilities to this class to make it possible to cover some examples that use files early in the book. Javadoc comments are covered for the first time in this edition. Almost all code examples have been revised to use Javadoc-style comments. The coverage of graphical user interface programming has been reorganized, much of it has been rewritten, and new material has been added. In previous editions, I emphasized applets. Stand-alone GUI applications were covered at the end, almost as an afterthought. In the fifth edition, the emphasis on applets is gone, and almost all examples are presented as stand-alone applications. However, applet versions of each example are still presented on the web pages of the on-line version of the book. The chapter on advanced GUI programming has been moved to the end, and a significant amount of new material has been added, including coverage of some of the features of Graphics2D. Aside from the changes in content, the appearance of the book has been improved, especially the appearance of the PDF version. For the first time, the quality of the PDF approaches that of conventional textbooks. ∗ ∗ ∗ The latest complete edition of Introduction to Programming using Java is always available on line at http://math.hws.edu/javanotes/. The first version of the book was written in 1996, and there have been several editions since then. All editions are archived at the following Web addresses: • First edition: http://math.hws.edu/eck/cs124/javanotes1/ (Covers Java 1.0.) • Second edition: http://math.hws.edu/eck/cs124/javanotes2/ (Covers Java 1.1.) • Third edition: http://math.hws.edu/eck/cs124/javanotes3/ (Covers Java 1.1.) • Fourth edition: http://math.hws.edu/eck/cs124/javanotes4/ (Covers Java 1.4.) • Fifth edition: http://math.hws.edu/eck/cs124/javanotes5/ (Covers Java 5.0.) Introduction to Programming using Java is free, but it is not in the public domain. As of Version 5.0, it is published under the terms of the Creative Commons Attribution-Share Alike 2.5 License. To view a copy of this license, visit http://creativecommons.org/licenses/by- sa/2.5/ or send a letter to Creative Commons, 543 Howard Street, 5th Floor, San Francisco, California, 94105, USA. This license allows redistribution and modification under certain terms. For example, you can:
- 15. Preface xv • Post an unmodified copy of the on-line version on your own Web site (including the parts that list the author and state the license under which it is distributed!). • Give away or sell printed, unmodified copies of this book, as long as they meet the re- quirements of the license. • Make modified copies of the complete book or parts of it and post them on the web or otherwise distribute them, provided that attribution to the author is given, the modifica- tions are clearly noted, and the modified copies are distributed under the same license as the original. This includes translations to other languages. While it is not actually required by the license, I do appreciate hearing from people who are using or distributing my work. ∗ ∗ ∗ A technical note on production: The on-line and PDF versions of this book are created from a single source, which is written largely in XML. To produce the PDF version, the XML is processed into a form that can be used by the TeX typesetting program. In addition to XML files, the source includes DTDs, XSLT transformations, Java source code files, image files, a TeX macro file, and a couple of scripts that are used in processing. I have not made the source materials available for download, since they are not in a clean enough form to be publishable, and because it would require a fair amount of expertise to make any use of them. However, they are not meant to be secret, and I am willing to make them available on request. ∗ ∗ ∗ Professor David J. Eck Department of Mathematics and Computer Science Hobart and William Smith Colleges Geneva, New York 14456, USA Email: eck@hws.edu WWW: http://math.hws.edu/eck/
- 16. xvi Preface
- 17. Chapter 1 Overview: The Mental Landscape When you begin a journey, it’s a good idea to have a mental map of the terrain you’ll be passing through. The same is true for an intellectual journey, such as learning to write computer programs. In this case, you’ll need to know the basics of what computers are and how they work. You’ll want to have some idea of what a computer program is and how one is created. Since you will be writing programs in the Java programming language, you’ll want to know something about that language in particular and about the modern, networked computing environment for which Java is designed. As you read this chapter, don’t worry if you can’t understand everything in detail. (In fact, it would be impossible for you to learn all the details from the brief expositions in this chapter.) Concentrate on learning enough about the big ideas to orient yourself, in preparation for the rest of the book. Most of what is covered in this chapter will be covered in much greater detail later in the book. 1.1 The Fetch and Execute Cycle: Machine Language A computer is a complex system consisting of many different components. But at the heart—or the brain, if you want—of the computer is a single component that does the actual computing. This is the Central Processing Unit, or CPU. In a modern desktop computer, the CPU is a single “chip” on the order of one square inch in size. The job of the CPU is to execute programs. A program is simply a list of unambiguous instructions meant to be followed mechanically by a computer. A computer is built to carry out instructions that are written in a very simple type of language called machine language. Each type of computer has its own machine language, and the computer can directly execute a program only if the program is expressed in that language. (It can execute programs written in other languages if they are first translated into machine language.) When the CPU executes a program, that program is stored in the computer’s main mem- ory (also called the RAM or random access memory). In addition to the program, memory can also hold data that is being used or processed by the program. Main memory consists of a sequence of locations. These locations are numbered, and the sequence number of a location is called its address. An address provides a way of picking out one particular piece of informa- tion from among the millions stored in memory. When the CPU needs to access the program instruction or data in a particular location, it sends the address of that information as a sig- nal to the memory; the memory responds by sending back the data contained in the specified 1
- 18. 2 CHAPTER 1. THE MENTAL LANDSCAPE location. The CPU can also store information in memory by specifying the information to be stored and the address of the location where it is to be stored. On the level of machine language, the operation of the CPU is fairly straightforward (al- though it is very complicated in detail). The CPU executes a program that is stored as a sequence of machine language instructions in main memory. It does this by repeatedly reading, or fetching, an instruction from memory and then carrying out, or executing, that instruc- tion. This process—fetch an instruction, execute it, fetch another instruction, execute it, and so on forever—is called the fetch-and-execute cycle. With one exception, which will be covered in the next section, this is all that the CPU ever does. The details of the fetch-and-execute cycle are not terribly important, but there are a few basic things you should know. The CPU contains a few internal registers, which are small memory units capable of holding a single number or machine language instruction. The CPU uses one of these registers—the program counter, or PC—to keep track of where it is in the program it is executing. The PC stores the address of the next instruction that the CPU should execute. At the beginning of each fetch-and-execute cycle, the CPU checks the PC to see which instruction it should fetch. During the course of the fetch-and-execute cycle, the number in the PC is updated to indicate the instruction that is to be executed in the next cycle. (Usually, but not always, this is just the instruction that sequentially follows the current instruction in the program.) ∗ ∗ ∗ A computer executes machine language programs mechanically—that is without under- standing them or thinking about them—simply because of the way it is physically put together. This is not an easy concept. A computer is a machine built of millions of tiny switches called transistors, which have the property that they can be wired together in such a way that an output from one switch can turn another switch on or off. As a computer computes, these switches turn each other on or off in a pattern determined both by the way they are wired together and by the program that the computer is executing. Machine language instructions are expressed as binary numbers. A binary number is made up of just two possible digits, zero and one. So, a machine language instruction is just a sequence of zeros and ones. Each particular sequence encodes some particular instruction. The data that the computer manipulates is also encoded as binary numbers. A computer can work directly with binary numbers because switches can readily represent such numbers: Turn the switch on to represent a one; turn it off to represent a zero. Machine language instructions are stored in memory as patterns of switches turned on or off. When a machine language instruction is loaded into the CPU, all that happens is that certain switches are turned on or off in the pattern that encodes that particular instruction. The CPU is built to respond to this pattern by executing the instruction it encodes; it does this simply because of the way all the other switches in the CPU are wired together. So, you should understand this much about how computers work: Main memory holds machine language programs and data. These are encoded as binary numbers. The CPU fetches machine language instructions from memory one after another and executes them. It does this mechanically, without thinking about or understanding what it does—and therefore the program it executes must be perfect, complete in all details, and unambiguous because the CPU can do nothing but execute it exactly as written. Here is a schematic view of this first-stage understanding of the computer:
- 19. 1.2. ASYNCHRONOUS EVENTS 3 Data to memory Data from memory Address for reading/writing data 1011100001 Program counter: CPU Memory (Location 0) (Location 1) (Location 2) (Location 3) (Location 10) 00101110 11010011 01010011 00010000 10111111 10100110 11101001 00000111 10100110 00010001 00111110 1.2 Asynchronous Events: Polling Loops and Interrupts The CPU spends almost all of its time fetching instructions from memory and executing them. However, the CPU and main memory are only two out of many components in a real computer system. A complete system contains other devices such as: • A hard disk for storing programs and data files. (Note that main memory holds only a comparatively small amount of information, and holds it only as long as the power is turned on. A hard disk is necessary for permanent storage of larger amounts of information, but programs have to be loaded from disk into main memory before they can actually be executed.) • A keyboard and mouse for user input. • A monitor and printer which can be used to display the computer’s output. • A modem that allows the computer to communicate with other computers over telephone lines. • A network interface that allows the computer to communicate with other computers that are connected to it on a network. • A scanner that converts images into coded binary numbers that can be stored and manipulated on the computer. The list of devices is entirely open ended, and computer systems are built so that they can easily be expanded by adding new devices. Somehow the CPU has to communicate with and control all these devices. The CPU can only do this by executing machine language instructions (which is all it can do, period). The way this works is that for each device in a system, there is a device driver, which consists of software that the CPU executes when it has to deal with the device. Installing a new device on a system generally has two steps: plugging the device physically into the computer, and installing the device driver software. Without the device driver, the actual physical device would be useless, since the CPU would not be able to communicate with it.
- 20. 4 CHAPTER 1. THE MENTAL LANDSCAPE ∗ ∗ ∗ A computer system consisting of many devices is typically organized by connecting those devices to one or more busses. A bus is a set of wires that carry various sorts of information between the devices connected to those wires. The wires carry data, addresses, and control signals. An address directs the data to a particular device and perhaps to a particular register or location within that device. Control signals can be used, for example, by one device to alert another that data is available for it on the data bus. A fairly simple computer system might be organized like this: Input/ Output Controller Data bus Address bus Control bus CPU Empty Slot for future Expansion Keyboard Network Interface ... ... Network Cable Video Controller and Monitor Memory Now, devices such as keyboard, mouse, and network interface can produce input that needs to be processed by the CPU. How does the CPU know that the data is there? One simple idea, which turns out to be not very satisfactory, is for the CPU to keep checking for incoming data over and over. Whenever it finds data, it processes it. This method is called polling, since the CPU polls the input devices continually to see whether they have any input data to report. Unfortunately, although polling is very simple, it is also very inefficient. The CPU can waste an awful lot of time just waiting for input. To avoid this inefficiency, interrupts are often used instead of polling. An interrupt is a signal sent by another device to the CPU. The CPU responds to an interrupt signal by putting aside whatever it is doing in order to respond to the interrupt. Once it has handled the interrupt, it returns to what it was doing before the interrupt occurred. For example, when you press a key on your computer keyboard, a keyboard interrupt is sent to the CPU. The CPU responds to this signal by interrupting what it is doing, reading the key that you pressed, processing it, and then returning to the task it was performing before you pressed the key. Again, you should understand that this is a purely mechanical process: A device signals an interrupt simply by turning on a wire. The CPU is built so that when that wire is turned on, the CPU saves enough information about what it is currently doing so that it can return to the same state later. This information consists of the contents of important internal registers such as the program counter. Then the CPU jumps to some predetermined memory location and begins executing the instructions stored there. Those instructions make up an interrupt handler that does the processing necessary to respond to the interrupt. (This interrupt handler is part of the device driver software for the device that signalled the interrupt.) At the end of
- 21. 1.2. ASYNCHRONOUS EVENTS 5 the interrupt handler is an instruction that tells the CPU to jump back to what it was doing; it does that by restoring its previously saved state. Interrupts allow the CPU to deal with asynchronous events. In the regular fetch-and- execute cycle, things happen in a predetermined order; everything that happens is “synchro- nized” with everything else. Interrupts make it possible for the CPU to deal efficiently with events that happen “asynchronously,” that is, at unpredictable times. As another example of how interrupts are used, consider what happens when the CPU needs to access data that is stored on the hard disk. The CPU can access data directly only if it is in main memory. Data on the disk has to be copied into memory before it can be accessed. Unfortunately, on the scale of speed at which the CPU operates, the disk drive is extremely slow. When the CPU needs data from the disk, it sends a signal to the disk drive telling it to locate the data and get it ready. (This signal is sent synchronously, under the control of a regular program.) Then, instead of just waiting the long and unpredictalble amount of time that the disk drive will take to do this, the CPU goes on with some other task. When the disk drive has the data ready, it sends an interrupt signal to the CPU. The interrupt handler can then read the requested data. ∗ ∗ ∗ Now, you might have noticed that all this only makes sense if the CPU actually has several tasks to perform. If it has nothing better to do, it might as well spend its time polling for input or waiting for disk drive operations to complete. All modern computers use multitasking to perform several tasks at once. Some computers can be used by several people at once. Since the CPU is so fast, it can quickly switch its attention from one user to another, devoting a fraction of a second to each user in turn. This application of multitasking is called timesharing. But a modern personal computer with just a single user also uses multitasking. For example, the user might be typing a paper while a clock is continuously displaying the time and a file is being downloaded over the network. Each of the individual tasks that the CPU is working on is called a thread. (Or a process; there are technical differences between threads and processes, but they are not important here.) At any given time, only one thread can actually be executed by a CPU. The CPU will continue running the same thread until one of several things happens: • The thread might voluntarily yield control, to give other threads a chance to run. • The thread might have to wait for some asynchronous event to occur. For example, the thread might request some data from the disk drive, or it might wait for the user to press a key. While it is waiting, the thread is said to be blocked, and other threads have a chance to run. When the event occurs, an interrupt will “wake up” the thread so that it can continue running. • The thread might use up its allotted slice of time and be suspended to allow other threads to run. Not all computers can “forcibly” suspend a thread in this way; those that can are said to use preemptive multitasking. To do preemptive multitasking, a computer needs a special timer device that generates an interrupt at regular intervals, such as 100 times per second. When a timer interrupt occurs, the CPU has a chance to switch from one thread to another, whether the thread that is currently running likes it or not. Ordinary users, and indeed ordinary programmers, have no need to deal with interrupts and interrupt handlers. They can concentrate on the different tasks or threads that they want the computer to perform; the details of how the computer manages to get all those tasks done are not important to them. In fact, most users, and many programmers, can ignore threads and
- 22. 6 CHAPTER 1. THE MENTAL LANDSCAPE multitasking altogether. However, threads have become increasingly important as computers have become more powerful and as they have begun to make more use of multitasking. Indeed, threads are built into the Java programming language as a fundamental programming concept. Just as important in Java and in modern programming in general is the basic concept of asynchronous events. While programmers don’t actually deal with interrupts directly, they do often find themselves writing event handlers, which, like interrupt handlers, are called asynchronously when specified events occur. Such “event-driven programming” has a very different feel from the more traditional straight-through, synchronous programming. We will begin with the more traditional type of programming, which is still used for programming individual tasks, but we will return to threads and events later in the text. ∗ ∗ ∗ By the way, the software that does all the interrupt handling and the communication with the user and with hardware devices is called the operating system. The operating system is the basic, essential software without which a computer would not be able to function. Other programs, such as word processors and World Wide Web browsers, are dependent upon the operating system. Common operating systems include Linux, DOS, Windows 2000, Windows XP, and the Macintosh OS. 1.3 The Java Virtual Machine Machine language consists of very simple instructions that can be executed directly by the CPU of a computer. Almost all programs, though, are written in high-level programming languages such as Java, Pascal, or C++. A program written in a high-level language cannot be run directly on any computer. First, it has to be translated into machine language. This translation can be done by a program called a compiler. A compiler takes a high-level-language program and translates it into an executable machine-language program. Once the translation is done, the machine-language program can be run any number of times, but of course it can only be run on one type of computer (since each type of computer has its own individual machine language). If the program is to run on another type of computer it has to be re-translated, using a different compiler, into the appropriate machine language. There is an alternative to compiling a high-level language program. Instead of using a compiler, which translates the program all at once, you can use an interpreter, which translates it instruction-by-instruction, as necessary. An interpreter is a program that acts much like a CPU, with a kind of fetch-and-execute cycle. In order to execute a program, the interpreter runs in a loop in which it repeatedly reads one instruction from the program, decides what is necessary to carry out that instruction, and then performs the appropriate machine-language commands to do so. One use of interpreters is to execute high-level language programs. For example, the pro- gramming language Lisp is usually executed by an interpreter rather than a compiler. However, interpreters have another purpose: they can let you use a machine-language program meant for one type of computer on a completely different type of computer. For example, there is a pro- gram called “Virtual PC” that runs on Macintosh computers. Virtual PC is an interpreter that executes machine-language programs written for IBM-PC-clone computers. If you run Virtual PC on your Macintosh, you can run any PC program, including programs written for Windows. (Unfortunately, a PC program will run much more slowly than it would on an actual IBM clone. The problem is that Virtual PC executes several Macintosh machine-language instructions for
- 23. 1.3. THE JAVA VIRTUAL MACHINE 7 each PC machine-language instruction in the program it is interpreting. Compiled programs are inherently faster than interpreted programs.) ∗ ∗ ∗ The designers of Java chose to use a combination of compilation and interpretation. Pro- grams written in Java are compiled into machine language, but it is a machine language for a computer that doesn’t really exist. This so-called “virtual” computer is known as the Java virtual machine. The machine language for the Java virtual machine is called Java byte- code. There is no reason why Java bytecode could not be used as the machine language of a real computer, rather than a virtual computer. However, one of the main selling points of Java is that it can actually be used on any computer. All that the computer needs is an interpreter for Java bytecode. Such an interpreter simulates the Java virtual machine in the same way that Virtual PC simulates a PC computer. Of course, a different Jave bytecode interpreter is needed for each type of computer, but once a computer has a Java bytecode interpreter, it can run any Java bytecode program. And the same Java bytecode program can be run on any computer that has such an interpreter. This is one of the essential features of Java: the same compiled program can be run on many different types of computers. J a v a P r o g r a m C o m p i l e r J a v a B y t e c o d e P r o g r a m J a v a I n t e r p r e t e r f o r M a c O S J a v a I n t e r p r e t e r f o r W i n d o w s J a v a I n t e r p r e t e r f o r L i n u x Why, you might wonder, use the intermediate Java bytecode at all? Why not just distribute the original Java program and let each person compile it into the machine language of whatever computer they want to run it on? There are many reasons. First of all, a compiler has to understand Java, a complex high-level language. The compiler is itself a complex program. A Java bytecode interpreter, on the other hand, is a fairly small, simple program. This makes it easy to write a bytecode interpreter for a new type of computer; once that is done, that computer can run any compiled Java program. It would be much harder to write a Java compiler for the same computer. Furthermore, many Java programs are meant to be downloaded over a network. This leads to obvious security concerns: you don’t want to download and run a program that will damage your computer or your files. The bytecode interpreter acts as a buffer between you and the program you download. You are really running the interpreter, which runs the downloaded program indirectly. The interpreter can protect you from potentially dangerous actions on the part of that program. I should note that there is no necessary connection between Java and Java bytecode. A pro- gram written in Java could certainly be compiled into the machine language of a real computer. And programs written in other languages could be compiled into Java bytecode. However, it is the combination of Java and Java bytecode that is platform-independent, secure, and network- compatible while allowing you to program in a modern high-level object-oriented language.
- 24. 8 CHAPTER 1. THE MENTAL LANDSCAPE ∗ ∗ ∗ I should also note that the really hard part of platform-independence is providing a “Graph- ical User Interface”—with windows, buttons, etc.—that will work on all the platforms that support Java. You’ll see more about this problem in Section 1.6. 1.4 Fundamental Building Blocks of Programs There are two basic aspects of programming: data and instructions. To work with data, you need to understand variables and types; to work with instructions, you need to understand control structures and subroutines. You’ll spend a large part of the course becoming familiar with these concepts. A variable is just a memory location (or several locations treated as a unit) that has been given a name so that it can be easily referred to and used in a program. The programmer only has to worry about the name; it is the compiler’s responsibility to keep track of the memory location. The programmer does need to keep in mind that the name refers to a kind of “box” in memory that can hold data, even if the programmer doesn’t have to know where in memory that box is located. In Java and most other languages, a variable has a type that indicates what sort of data it can hold. One type of variable might hold integers—whole numbers such as 3, -7, and 0— while another holds floating point numbers—numbers with decimal points such as 3.14, -2.7, or 17.0. (Yes, the computer does make a distinction between the integer 17 and the floating- point number 17.0; they actually look quite different inside the computer.) There could also be types for individual characters (’A’, ’;’, etc.), strings (“Hello”, “A string can include many characters”, etc.), and less common types such as dates, colors, sounds, or any other type of data that a program might need to store. Programming languages always have commands for getting data into and out of variables and for doing computations with data. For example, the following “assignment statement,” which might appear in a Java program, tells the computer to take the number stored in the variable named “principal”, multiply that number by 0.07, and then store the result in the variable named “interest”: interest = principal * 0.07; There are also “input commands” for getting data from the user or from files on the computer’s disks and “output commands” for sending data in the other direction. These basic commands—for moving data from place to place and for performing computations—are the building blocks for all programs. These building blocks are combined into complex programs using control structures and subroutines. ∗ ∗ ∗ A program is a sequence of instructions. In the ordinary “flow of control,” the computer executes the instructions in the sequence in which they appear, one after the other. However, this is obviously very limited: the computer would soon run out of instructions to execute. Control structures are special instructions that can change the flow of control. There are two basic types of control structure: loops, which allow a sequence of instructions to be repeated over and over, and branches, which allow the computer to decide between two or more different courses of action by testing conditions that occur as the program is running. For example, it might be that if the value of the variable “principal” is greater than 10000, then the “interest” should be computed by multiplying the principal by 0.05; if not, then the
- 25. 1.5. OBJECT-ORIENTED PROGRAMMING 9 interest should be computed by multiplying the principal by 0.04. A program needs some way of expressing this type of decision. In Java, it could be expressed using the following “if statement”: if (principal > 10000) interest = principal * 0.05; else interest = principal * 0.04; (Don’t worry about the details for now. Just remember that the computer can test a condition and decide what to do next on the basis of that test.) Loops are used when the same task has to be performed more than once. For example, if you want to print out a mailing label for each name on a mailing list, you might say, “Get the first name and address and print the label; get the second name and address and print the label; get the third name and address and print the label—” But this quickly becomes ridiculous—and might not work at all if you don’t know in advance how many names there are. What you would like to say is something like “While there are more names to process, get the next name and address, and print the label.” A loop can be used in a program to express such repetition. ∗ ∗ ∗ Large programs are so complex that it would be almost impossible to write them if there were not some way to break them up into manageable “chunks.” Subroutines provide one way to do this. A subroutine consists of the instructions for performing some task, grouped together as a unit and given a name. That name can then be used as a substitute for the whole set of instructions. For example, suppose that one of the tasks that your program needs to perform is to draw a house on the screen. You can take the necessary instructions, make them into a subroutine, and give that subroutine some appropriate name—say, “drawHouse()”. Then anyplace in your program where you need to draw a house, you can do so with the single command: drawHouse(); This will have the same effect as repeating all the house-drawing instructions in each place. The advantage here is not just that you save typing. Organizing your program into sub- routines also helps you organize your thinking and your program design effort. While writing the house-drawing subroutine, you can concentrate on the problem of drawing a house without worrying for the moment about the rest of the program. And once the subroutine is written, you can forget about the details of drawing houses—that problem is solved, since you have a subroutine to do it for you. A subroutine becomes just like a built-in part of the language which you can use without thinking about the details of what goes on “inside” the subroutine. ∗ ∗ ∗ Variables, types, loops, branches, and subroutines are the basis of what might be called “traditional programming.” However, as programs become larger, additional structure is needed to help deal with their complexity. One of the most effective tools that has been found is object- oriented programming, which is discussed in the next section. 1.5 Objects and Object-oriented Programming Programs must be designed. No one can just sit down at the computer and compose a program of any complexity. The discipline called software engineering is concerned with
- 26. 10 CHAPTER 1. THE MENTAL LANDSCAPE the construction of correct, working, well-written programs. The software engineer tends to use accepted and proven methods for analyzing the problem to be solved and for designing a program to solve that problem. During the 1970s and into the 80s, the primary software engineering methodology was structured programming. The structured programming approach to program design was based on the following advice: To solve a large problem, break the problem into several pieces and work on each piece separately; to solve each piece, treat it as a new problem which can itself be broken down into smaller problems; eventually, you will work your way down to problems that can be solved directly, without further decomposition. This approach is called top-down programming. There is nothing wrong with top-down programming. It is a valuable and often-used ap- proach to problem-solving. However, it is incomplete. For one thing, it deals almost entirely with producing the instructions necessary to solve a problem. But as time went on, people realized that the design of the data structures for a program was as least as important as the design of subroutines and control structures. Top-down programming doesn’t give adequate consideration to the data that the program manipulates. Another problem with strict top-down programming is that it makes it difficult to reuse work done for other projects. By starting with a particular problem and subdividing it into convenient pieces, top-down programming tends to produce a design that is unique to that problem. It is unlikely that you will be able to take a large chunk of programming from another program and fit it into your project, at least not without extensive modification. Producing high-quality programs is difficult and expensive, so programmers and the people who employ them are always eager to reuse past work. ∗ ∗ ∗ So, in practice, top-down design is often combined with bottom-up design. In bottom-up design, the approach is to start “at the bottom,” with problems that you already know how to solve (and for which you might already have a reusable software component at hand). From there, you can work upwards towards a solution to the overall problem. The reusable components should be as “modular” as possible. A module is a component of a larger system that interacts with the rest of the system in a simple, well-defined, straightforward manner. The idea is that a module can be “plugged into” a system. The details of what goes on inside the module are not important to the system as a whole, as long as the module fulfills its assigned role correctly. This is called information hiding, and it is one of the most important principles of software engineering. One common format for software modules is to contain some data, along with some sub- routines for manipulating that data. For example, a mailing-list module might contain a list of names and addresses along with a subroutine for adding a new name, a subroutine for printing mailing labels, and so forth. In such modules, the data itself is often hidden inside the module; a program that uses the module can then manipulate the data only indirectly, by calling the subroutines provided by the module. This protects the data, since it can only be manipulated in known, well-defined ways. And it makes it easier for programs to use the module, since they don’t have to worry about the details of how the data is represented. Information about the representation of the data is hidden. Modules that could support this kind of information-hiding became common in program- ming languages in the early 1980s. Since then, a more advanced form of the same idea has more or less taken over software engineering. This latest approach is called object-oriented programming, often abbreviated as OOP.
- 27. 1.5. OBJECT-ORIENTED PROGRAMMING 11 The central concept of object-oriented programming is the object, which is a kind of module containing data and subroutines. The point-of-view in OOP is that an object is a kind of self- sufficient entity that has an internal state (the data it contains) and that can respond to messages (calls to its subroutines). A mailing list object, for example, has a state consisting of a list of names and addresses. If you send it a message telling it to add a name, it will respond by modifying its state to reflect the change. If you send it a message telling it to print itself, it will respond by printing out its list of names and addresses. The OOP approach to software engineering is to start by identifying the objects involved in a problem and the messages that those objects should respond to. The program that results is a collection of objects, each with its own data and its own set of responsibilities. The objects interact by sending messages to each other. There is not much “top-down” in such a program, and people used to more traditional programs can have a hard time getting used to OOP. However, people who use OOP would claim that object-oriented programs tend to be better models of the way the world itself works, and that they are therefore easier to write, easier to understand, and more likely to be correct. ∗ ∗ ∗ You should think of objects as “knowing” how to respond to certain messages. Different objects might respond to the same message in different ways. For example, a “print” message would produce very different results, depending on the object it is sent to. This property of objects—that different objects can respond to the same message in different ways—is called polymorphism. It is common for objects to bear a kind of “family resemblance” to one another. Objects that contain the same type of data and that respond to the same messages in the same way belong to the same class. (In actual programming, the class is primary; that is, a class is created and then one or more objects are created using that class as a template.) But objects can be similar without being in exactly the same class. For example, consider a drawing program that lets the user draw lines, rectangles, ovals, polygons, and curves on the screen. In the program, each visible object on the screen could be represented by a software object in the program. There would be five classes of objects in the program, one for each type of visible object that can be drawn. All the lines would belong to one class, all the rectangles to another class, and so on. These classes are obviously related; all of them represent “drawable objects.” They would, for example, all presumably be able to respond to a “draw yourself” message. Another level of grouping, based on the data needed to represent each type of object, is less obvious, but would be very useful in a program: We can group polygons and curves together as “multipoint objects,” while lines, rectangles, and ovals are “two-point objects.” (A line is determined by its endpoints, a rectangle by two of its corners, and an oval by two corners of the rectangle that contains it.) We could diagram these relationships as follows:
- 28. 12 CHAPTER 1. THE MENTAL LANDSCAPE D r a w a b l e O b j e c t M u l t i p o i n t O b j e c t T w o P o i n t O b j e c t P o l y g o n C u r v e L i n e R e c t a n g l e O v a l DrawableObject, MultipointObject, and TwoPointObject would be classes in the program. MultipointObject and TwoPointObject would be subclasses of DrawableObject. The class Line would be a subclass of TwoPointObject and (indirectly) of DrawableObject. A subclass of a class is said to inherit the properties of that class. The subclass can add to its inheritance and it can even “override” part of that inheritance (by defining a different response to some method). Nevertheless, lines, rectangles, and so on are drawable objects, and the class DrawableObject expresses this relationship. Inheritance is a powerful means for organizing a program. It is also related to the problem of reusing software components. A class is the ultimate reusable component. Not only can it be reused directly if it fits exactly into a program you are trying to write, but if it just almost fits, you can still reuse it by defining a subclass and making only the small changes necessary to adapt it exactly to your needs. So, OOP is meant to be both a superior program-development tool and a partial solution to the software reuse problem. Objects, classes, and object-oriented programming will be important themes throughout the rest of this text. 1.6 The Modern User Interface When computers were first introduced, ordinary people—including most programmers— couldn’t get near them. They were locked up in rooms with white-coated attendants who would take your programs and data, feed them to the computer, and return the computer’s response some time later. When timesharing—where the computer switches its attention rapidly from one person to another—was invented in the 1960s, it became possible for several people to interact directly with the computer at the same time. On a timesharing system, users sit at “terminals” where they type commands to the computer, and the computer types back its re- sponse. Early personal computers also used typed commands and responses, except that there was only one person involved at a time. This type of interaction between a user and a computer is called a command-line interface. Today, of course, most people interact with computers in a completely different way. They use a Graphical User Interface, or GUI. The computer draws interface components on the screen. The components include things like windows, scroll bars, menus, buttons, and icons. Usually, a mouse is used to manipulate such components. Assuming that you have not just been teleported in from the 1970s, you are no doubt already familiar with the basics of graphical user interfaces! A lot of GUI interface components have become fairly standard. That is, they have similar appearance and behavior on many different computer platforms including Macintosh, Windows,
- 29. 1.6. THE MODERN USER INTERFACE 13 and Linux. Java programs, which are supposed to run on many different platforms without modification to the program, can use all the standard GUI components. They might vary a little in appearance from platform to platform, but their functionality should be identical on any computer on which the program runs. Shown below is an image of a very simple Java program—actually an “applet”, since it is meant to appear on a Web page—that shows a few standard GUI interface components. There are four components that the user can interact with: a button, a checkbox, a text field, and a pop-up menu. These components are labeled. There are a few other components in the applet. The labels themselves are components (even though you can’t interact with them). The right half of the applet is a text area component, which can display multiple lines of text, and a scrollbar component appears alongside the text area when the number of lines of text becomes larger than will fit in the text area. And in fact, in Java terminology, the whole applet is itself considered to be a “component.” Now, Java actually has two complete sets of GUI components. One of these, the AWT or Abstract Windowing Toolkit, was available in the original version of Java. The other, which is known as Swing, is included in Java version 1.2 or later, and is used in preference to the AWT in most modern Java programs. The applet that is shown above uses components that are part of Swing. If your Web browser uses an old version of Java, you might get an error when the browser tries to load the applet. Remember that most of the applets in this textbook require Java 5.0 (or higher). When a user interacts with the GUI components in this applet, an “event” is generated. For example, clicking a push button generates an event, and pressing return while typing in a text field generates an event. Each time an event is generated, a message is sent to the applet telling it that the event has occurred, and the applet responds according to its program. In fact, the program consists mainly of “event handlers” that tell the applet how to respond to various types of events. In this example, the applet has been programmed to respond to each event by displaying a message in the text area. The use of the term “message” here is deliberate. Messages, as you saw in the previous sec- tion, are sent to objects. In fact, Java GUI components are implemented as objects. Java includes many predefined classes that represent various types of GUI components. Some of these classes are subclasses of others. Here is a diagram showing some of Swing’s GUI classes and their relationships:
- 30. 14 CHAPTER 1. THE MENTAL LANDSCAPE J C o m p o n e n t J L a b e l J A b s t r a c t B u t t o n J C o m b o B o x J T e x t C o m p o n e n t J B u t t o n J T o g g l e B u t t o n J C h e c k B o x J R a d i o B u t t o n J S c r o l l b a r J T e x t F i e l d J T e x t A r e a Don’t worry about the details for now, but try to get some feel about how object-oriented programming and inheritance are used here. Note that all the GUI classes are subclasses, directly or indirectly, of a class called JComponent, which represents general properties that are shared by all Swing components. Two of the direct subclasses of JComponent themselves have subclasses. The classes JTextArea and JTextField, which have certain behaviors in common, are grouped together as subclasses of JTextComponent. Similarly JButton and JToggleButton are subclasses of JAbstractButton, which represents properties common to both buttons and checkboxes. (JComboBox, by the way, is the Swing class that represents pop-up menus.) Just from this brief discussion, perhaps you can see how GUI programming can make effec- tive use of object-oriented design. In fact, GUI’s, with their “visible objects,” are probably a major factor contributing to the popularity of OOP. Programming with GUI components and events is one of the most interesting aspects of Java. However, we will spend several chapters on the basics before returning to this topic in Chapter 6. 1.7 The Internet and the World-Wide Web Computers can be connected together on networks. A computer on a network can communicate with other computers on the same network by exchanging data and files or by sending and receiving messages. Computers on a network can even work together on a large computation. Today, millions of computers throughout the world are connected to a single huge network called the Internet. New computers are being connected to the Internet every day. Computers can join the Internet by using a modem to establish a connection through telephone lines. Broadband connections to the Internet, such as DSL and cable modems, are increasingly common. They allow faster data transmission than is possible through telephone modems. There are elaborate protocols for communication over the Internet. A protocol is simply a detailed specification of how communication is to proceed. For two computers to communicate at all, they must both be using the same protocols. The most basic protocols on the Internet are the Internet Protocol (IP), which specifies how data is to be physically transmitted from one computer to another, and the Transmission Control Protocol (TCP), which ensures that data sent using IP is received in its entirety and without error. These two protocols, which are referred to collectively as TCP/IP, provide a foundation for communication. Other protocols
- 31. 1.7. THE INTERNET 15 use TCP/IP to send specific types of information such as web pages, electronic mail, and data files. All communication over the Internet is in the form of packets. A packet consists of some data being sent from one computer to another, along with addressing information that indicates where on the Internet that data is supposed to go. Think of a packet as an envelope with an address on the outside and a message on the inside. (The message is the data.) The packet also includes a “return address,” that is, the address of the sender. A packet can hold only a limited amount of data; longer messages must be divided among several packets, which are then sent individually over the net and reassembled at their destination. Every computer on the Internet has an IP address, a number that identifies it uniquely among all the computers on the net. The IP address is used for addressing packets. A computer can only send data to another computer on the Internet if it knows that computer’s IP address. Since people prefer to use names rather than numbers, most computers are also identified by names, called domain names. For example, the main computer of the Mathematics Depart- ment at Hobart and William Smith Colleges has the domain name math.hws.edu. (Domain names are just for convenience; your computer still needs to know IP addresses before it can communicate. There are computers on the Internet whose job it is to translate domain names to IP addresses. When you use a domain name, your computer sends a message to a domain name server to find out the corresponding IP address. Then, your computer uses the IP address, rather than the domain name, to communicate with the other computer.) The Internet provides a number of services to the computers connected to it (and, of course, to the users of those computers). These services use TCP/IP to send various types of data over the net. Among the most popular services are instant messaging, file sharing, electronic mail, and the World-Wide Web. Each service has its own protocols, which are used to control transmission of data over the network. Each service also has some sort of user interface, which allows the user to view, send, and receive data through the service. For example, the email service uses a protocol known as SMTP (Simple Mail Transfer Protocol) to transfer email messages from one computer to another. Other protocols, such as POP and IMAP, are used to fetch messages from an email account so that the recipient can read them. A person who uses email, however, doesn’t need to understand or even know about these protocols. Instead, they are used behind the scenes by the programs that the person uses to send and receive email messages. These programs provide an easy-to-use user interface to the underlying network protocols. The World-Wide Web is perhaps the most exciting of network services. The World-Wide Web allows you to request pages of information that are stored on computers all over the Internet. A Web page can contain links to other pages on the same computer from which it was obtained or to other computers anywhere in the world. A computer that stores such pages of information is called a web server. The user interface to the Web is the type of program known as a web browser. Common web browsers include Internet Explorer and Firefox. You use a Web browser to request a page of information. The browser will send a request for that page to the computer on which the page is stored, and when a response is received from that computer, the web browser displays it to you in a neatly formatted form. A web browser is just a user interface to the Web. Behind the scenes, the web browser uses a protocol called HTTP (HyperText Transfer Protocol) to send each page request and to receive the response from the web server. ∗ ∗ ∗ Now just what, you might be thinking, does all this have to do with Java? In fact, Java
- 32. 16 CHAPTER 1. THE MENTAL LANDSCAPE is intimately associated with the Internet and the World-Wide Web. As you have seen in the previous section, special Java programs called applets are meant to be transmitted over the Internet and displayed on Web pages. A Web server transmits a Java applet just as it would transmit any other type of information. A Web browser that understands Java—that is, that includes an interpreter for the Java virtual machine—can then run the applet right on the Web page. Since applets are programs, they can do almost anything, including complex interaction with the user. With Java, a Web page becomes more than just a passive display of information. It becomes anything that programmers can imagine and implement. But applets are only one aspect of Java’s relationship with the Internet, and not the major one. In fact, as both Java and the Internet have matured, applets have become less important. At the same time, however, Java has increasingly been used to write complex, stand-alone applications that do not depend on a web browser. Many of these programs are network- related. For example many of the largest and most complex web sites use web server software that is written in Java. Java includes excellent support for network protocols, and its platform independence makes it possible to write network programs that work on many different types of computer. Its association with the Internet is not Java’s only advantage. But many good programming languages have been invented only to be soon forgotten. Java has had the good luck to ride on the coattails of the Internet’s immense and increasing popularity.
- 33. Quiz 17 Quiz on Chapter 1 1. One of the components of a computer is its CPU. What is a CPU and what role does it play in a computer? 2. Explain what is meant by an “asynchronous event.” Give some examples. 3. What is the difference between a “compiler” and an “interpreter”? 4. Explain the difference between high-level languages and machine language. 5. If you have the source code for a Java program, and you want to run that program, you will need both a compiler and an interpreter. What does the Java compiler do, and what does the Java interpreter do? 6. What is a subroutine? 7. Java is an object-oriented programming language. What is an object? 8. What is a variable? (There are four different ideas associated with variables in Java. Try to mention all four aspects in your answer. Hint: One of the aspects is the variable’s name.) 9. Java is a “platform-independent language.” What does this mean? 10. What is the “Internet”? Give some examples of how it is used. (What kind of services does it provide?)
- 34. 18 CHAPTER 1. THE MENTAL LANDSCAPE
- 35. Chapter 2 Programming in the Small I: Names and Things On a basic level (the level of machine language), a computer can perform only very simple operations. A computer performs complex tasks by stringing together large numbers of such operations. Such tasks must be “scripted” in complete and perfect detail by programs. Creating complex programs will never be really easy, but the difficulty can be handled to some extent by giving the program a clear overall structure. The design of the overall structure of a program is what I call “programming in the large.” Programming in the small, which is sometimes called coding, would then refer to filling in the details of that design. The details are the explicit, step-by-step instructions for performing fairly small-scale tasks. When you do coding, you are working fairly “close to the machine,” with some of the same concepts that you might use in machine language: memory locations, arithmetic operations, loops and branches. In a high-level language such as Java, you get to work with these concepts on a level several steps above machine language. However, you still have to worry about getting all the details exactly right. This chapter and the next examine the facilities for programming in the small in the Java programming language. Don’t be misled by the term “programming in the small” into thinking that this material is easy or unimportant. This material is an essential foundation for all types of programming. If you don’t understand it, you can’t write programs, no matter how good you get at designing their large-scale structure. 2.1 The Basic Java Application A program is a sequence of instructions that a computer can execute to perform some task. A simple enough idea, but for the computer to make any use of the instructions, they must be written in a form that the computer can use. This means that programs have to be written in programming languages. Programming languages differ from ordinary human languages in being completely unambiguous and very strict about what is and is not allowed in a program. The rules that determine what is allowed are called the syntax of the language. Syntax rules specify the basic vocabulary of the language and how programs can be constructed using things like loops, branches, and subroutines. A syntactically correct program is one that can be successfully compiled or interpreted; programs that have syntax errors will be rejected (hopefully with a useful error message that will help you fix the problem). So, to be a successful programmer, you have to develop a detailed knowledge of the syntax 19
- 36. 20 CHAPTER 2. NAMES AND THINGS of the programming language that you are using. However, syntax is only part of the story. It’s not enough to write a program that will run—you want a program that will run and produce the correct result! That is, the meaning of the program has to be right. The meaning of a program is referred to as its semantics. A semantically correct program is one that does what you want it to. Furthermore, a program can be syntactically and semantically correct but still be a pretty bad program. Using the language correctly is not the same as using it well. For example, a good program has “style.” It is written in a way that will make it easy for people to read and to understand. It follows conventions that will be familiar to other programmers. And it has an overall design that will make sense to human readers. The computer is completely oblivious to such things, but to a human reader, they are paramount. These aspects of programming are sometimes referred to as pragmatics. When I introduce a new language feature, I will explain the syntax, the semantics, and some of the pragmatics of that feature. You should memorize the syntax; that’s the easy part. Then you should get a feeling for the semantics by following the examples given, making sure that you understand how they work, and maybe writing short programs of your own to test your understanding. And you should try to appreciate and absorb the pragmatics—this means learning how to use the language feature well, with style that will earn you the admiration of other programmers. Of course, even when you’ve become familiar with all the individual features of the language, that doesn’t make you a programmer. You still have to learn how to construct complex programs to solve particular problems. For that, you’ll need both experience and taste. You’ll find hints about software development throughout this textbook. ∗ ∗ ∗ We begin our exploration of Java with the problem that has become traditional for such beginnings: to write a program that displays the message “Hello World!”. This might seem like a trivial problem, but getting a computer to do this is really a big first step in learning a new programming language (especially if it’s your first programming language). It means that you understand the basic process of: 1. getting the program text into the computer, 2. compiling the program, and 3. running the compiled program. The first time through, each of these steps will probably take you a few tries to get right. I won’t go into the details here of how you do each of these steps; it depends on the particular computer and Java programming environment that you are using. See Section 2.6 for informa- tion about creating and running Java programs in specific programming environments. But in general, you will type the program using some sort of text editor and save the program in a file. Then, you will use some command to try to compile the file. You’ll either get a message that the program contains syntax errors, or you’ll get a compiled version of the program. In the case of Java, the program is compiled into Java bytecode, not into machine language. Fi- nally, you can run the compiled program by giving some appropriate command. For Java, you will actually use an interpreter to execute the Java bytecode. Your programming environment might automate some of the steps for you, but you can be sure that the same three steps are being done in the background. Here is a Java program to display the message “Hello World!”. Don’t expect to understand what’s going on here just yet—some of it you won’t really understand until a few chapters from
- 37. 2.1. THE BASIC JAVA APPLICATION 21 now: // A program to display the message // "Hello World!" on standard output public class HelloWorld { public static void main(String[] args) { System.out.println("Hello World!"); } } // end of class HelloWorld The command that actually displays the message is: System.out.println("Hello World!"); This command is an example of a subroutine call statement. It uses a “built-in subroutine” named System.out.println to do the actual work. Recall that a subroutine consists of the instructions for performing some task, chunked together and given a name. That name can be used to “call” the subroutine whenever that task needs to be performed. A built-in subroutine is one that is already defined as part of the language and therefore automatically available for use in any program. When you run this program, the message “Hello World!” (without the quotes) will be displayed on standard output. Unfortunately, I can’t say exactly what that means! Java is meant to run on many different platforms, and standard output will mean different things on different platforms. However, you can expect the message to show up in some convenient place. (If you use a command-line interface, like that in Sun Microsystem’s Java Development Kit, you type in a command to tell the computer to run the program. The computer will type the output from the program, Hello World!, on the next line.) You must be curious about all the other stuff in the above program. Part of it consists of comments. Comments in a program are entirely ignored by the computer; they are there for human readers only. This doesn’t mean that they are unimportant. Programs are meant to be read by people as well as by computers, and without comments, a program can be very difficult to understand. Java has two types of comments. The first type, used in the above program, begins with // and extends to the end of a line. The computer ignores the // and everything that follows it on the same line. Java has another style of comment that can extend over many lines. That type of comment begins with /* and ends with */. Everything else in the program is required by the rules of Java syntax. All programming in Java is done inside “classes.” The first line in the above program (not counting the comments) says that this is a class named HelloWorld. “HelloWorld,” the name of the class, also serves as the name of the program. Not every class is a program. In order to define a program, a class must include a subroutine named main, with a definition that takes the form: public static void main(String[] args) { hstatementsi } When you tell the Java interpreter to run the program, the interpreter calls the main() subroutine, and the statements that it contains are executed. These statements make up the script that tells the computer exactly what to do when the program is executed. The main() routine can call subroutines that are defined in the same class or even in other classes, but it is the main() routine that determines how and in what order the other subroutines are used.
- 38. 22 CHAPTER 2. NAMES AND THINGS The word “public” in the first line of main() means that this routine can be called from out- side the program. This is essential because the main() routine is called by the Java interpreter, which is something external to the program itself. The remainder of the first line of the routine is harder to explain at the moment; for now, just think of it as part of the required syntax. The definition of the subroutine—that is, the instructions that say what it does—consists of the sequence of “statements” enclosed between braces, { and }. Here, I’ve used hstatementsi as a placeholder for the actual statements that make up the program. Throughout this textbook, I will always use a similar format: anything that you see in hthis style of texti (italic in angle brackets) is a placeholder that describes something you need to type when you write an actual program. As noted above, a subroutine can’t exist by itself. It has to be part of a “class”. A program is defined by a public class that takes the form: public class hprogram-namei { hoptional-variable-declarations-and-subroutinesi public static void main(String[] args) { hstatementsi } hoptional-variable-declarations-and-subroutinesi } The name on the first line is the name of the program, as well as the name of the class. If the name of the class is HelloWorld, then the class must be saved in a file called HelloWorld.java. When this file is compiled, another file named HelloWorld.class will be produced. This class file, HelloWorld.class, contains the Java bytecode that is executed by a Java interpreter. HelloWorld.java is called the source code for the program. To execute the program, you only need the compiled class file, not the source code. The layout of the program on the page, such as the use of blank lines and indentation, is not part of the syntax or semantics of the language. The computer doesn’t care about layout— you could run the entire program together on one line as far as it is concerned. However, layout is important to human readers, and there are certain style guidelines for layout that are followed by most programmers. These style guidelines are part of the pragmatics of the Java programming language. Also note that according to the above syntax specification, a program can contain other subroutines besides main(), as well as things called “variable declarations.” You’ll learn more about these later, but not until Chapter 4. 2.2 Variables and the Primitive Types Names are fundamental to programming. In programs, names are used to refer to many different sorts of things. In order to use those things, a programmer must understand the rules for giving names to things and the rules for using the names to work with those things. That is, the programmer must understand the syntax and the semantics of names. According to the syntax rules of Java, a name is a sequence of one or more characters. It must begin with a letter or underscore and must consist entirely of letters, digits, and underscores. (“Underscore” refers to the character ’ ’.) For example, here are some legal names: N n rate x15 quite a long name HelloWorld
- 39. 2.2. VARIABLES AND TYPES 23 No spaces are allowed in identifiers; HelloWorld is a legal identifier, but “Hello World” is not. Upper case and lower case letters are considered to be different, so that HelloWorld, helloworld, HELLOWORLD, and hElloWorLD are all distinct names. Certain names are reserved for special uses in Java, and cannot be used by the programmer for other purposes. These reserved words include: class, public, static, if, else, while, and several dozen other words. Java is actually pretty liberal about what counts as a letter or a digit. Java uses the Unicode character set, which includes thousands of characters from many different languages and different alphabets, and many of these characters count as letters or digits. However, I will be sticking to what can be typed on a regular English keyboard. The pragmatics of naming includes style guidelines about how to choose names for things. For example, it is customary for names of classes to begin with upper case letters, while names of variables and of subroutines begin with lower case letters; you can avoid a lot of confusion by following the same convention in your own programs. Most Java programmers do not use underscores in names, although some do use them at the beginning of the names of certain kinds of variables. When a name is made up of several words, such as HelloWorld or interestRate, it is customary to capitalize each word, except possibly the first; this is sometimes referred to as camel case, since the upper case letters in the middle of a name are supposed to look something like the humps on a camel’s back. Finally, I’ll note that things are often referred to by compound names which consist of several ordinary names separated by periods. (Compound names are also called qualified names.) You’ve already seen an example: System.out.println. The idea here is that things in Java can contain other things. A compound name is a kind of path to an item through one or more levels of containment. The name System.out.println indicates that something called “System” contains something called “out” which in turn contains something called “println”. Non-compound names are called simple identifiers. I’ll use the term identifier to refer to any name—simple or compound—that can be used to refer to something in Java. (Note that the reserved words are not identifiers, since they can’t be used as names for things.) 2.2.1 Variables Programs manipulate data that are stored in memory. In machine language, data can only be referred to by giving the numerical address of the location in memory where it is stored. In a high-level language such as Java, names are used instead of numbers to refer to data. It is the job of the computer to keep track of where in memory the data is actually stored; the programmer only has to remember the name. A name used in this way—to refer to data stored in memory—is called a variable. Variables are actually rather subtle. Properly speaking, a variable is not a name for the data itself but for a location in memory that can hold data. You should think of a variable as a container or box where you can store data that you will need to use later. The variable refers directly to the box and only indirectly to the data in the box. Since the data in the box can change, a variable can refer to different data values at different times during the execution of the program, but it always refers to the same box. Confusion can arise, especially for beginning programmers, because when a variable is used in a program in certain ways, it refers to the container, but when it is used in other ways, it refers to the data in the container. You’ll see examples of both cases below. (In this way, a variable is something like the title, “The President of the United States.” This title can refer to different people at different times, but it always refers to the same office.
- 40. 24 CHAPTER 2. NAMES AND THINGS If I say “the President went fishing,” I mean that George W. Bush went fishing. But if I say “Hillary Clinton wants to be President” I mean that she wants to fill the office, not that she wants to be George Bush.) In Java, the only way to get data into a variable—that is, into the box that the variable names—is with an assignment statement. An assignment statement takes the form: hvariablei = hexpressioni; where hexpressioni represents anything that refers to or computes a data value. When the computer comes to an assignment statement in the course of executing a program, it evaluates the expression and puts the resulting data value into the variable. For example, consider the simple assignment statement rate = 0.07; The hvariablei in this assignment statement is rate, and the hexpressioni is the number 0.07. The computer executes this assignment statement by putting the number 0.07 in the variable rate, replacing whatever was there before. Now, consider the following more complicated assignment statement, which might come later in the same program: interest = rate * principal; Here, the value of the expression “rate * principal” is being assigned to the variable interest. In the expression, the * is a “multiplication operator” that tells the computer to multiply rate times principal. The names rate and principal are themselves variables, and it is really the values stored in those variables that are to be multiplied. We see that when a variable is used in an expression, it is the value stored in the variable that matters; in this case, the variable seems to refer to the data in the box, rather than to the box itself. When the computer executes this assignment statement, it takes the value of rate, multiplies it by the value of principal, and stores the answer in the box referred to by interest. When a variable is used on the left-hand side of an assignment statement, it refers to the box that is named by the variable. (Note, by the way, that an assignment statement is a command that is executed by the computer at a certain time. It is not a statement of fact. For example, suppose a program includes the statement “rate = 0.07;”. If the statement “interest = rate * principal;” is executed later in the program, can we say that the principal is multiplied by 0.07? No! The value of rate might have been changed in the meantime by another statement. The meaning of an assignment statement is completely different from the meaning of an equation in mathematics, even though both use the symbol “=”.) 2.2.2 Types and Literals A variable in Java is designed to hold only one particular type of data; it can legally hold that type of data and no other. The compiler will consider it to be a syntax error if you try to violate this rule. We say that Java is a strongly typed language because it enforces this rule. There are eight so-called primitive types built into Java. The primitive types are named byte, short, int, long, float, double, char, and boolean. The first four types hold integers (whole numbers such as 17, -38477, and 0). The four integer types are distinguished by the ranges of integers they can hold. The float and double types hold real numbers (such as 3.6 and -145.99). Again, the two real types are distinguished by their range and accuracy. A variable of type char holds a single character from the Unicode character set. And a variable of type boolean holds one of the two logical values true or false.
- 41. 2.2. VARIABLES AND TYPES 25 Any data value stored in the computer’s memory must be represented as a binary number, that is as a string of zeros and ones. A single zero or one is called a bit. A string of eight bits is called a byte. Memory is usually measured in terms of bytes. Not surprisingly, the byte data type refers to a single byte of memory. A variable of type byte holds a string of eight bits, which can represent any of the integers between -128 and 127, inclusive. (There are 256 integers in that range; eight bits can represent 256—two raised to the power eight—different values.) As for the other integer types, • short corresponds to two bytes (16 bits). Variables of type short have values in the range -32768 to 32767. • int corresponds to four bytes (32 bits). Variables of type int have values in the range -2147483648 to 2147483647. • long corresponds to eight bytes (64 bits). Variables of type long have values in the range -9223372036854775808 to 9223372036854775807. You don’t have to remember these numbers, but they do give you some idea of the size of integers that you can work with. Usually, you should just stick to the int data type, which is good enough for most purposes. The float data type is represented in four bytes of memory, using a standard method for encoding real numbers. The maximum value for a float is about 10 raised to the power 38. A float can have about 7 significant digits. (So that 32.3989231134 and 32.3989234399 would both have to be rounded off to about 32.398923 in order to be stored in a variable of type float.) A double takes up 8 bytes, can range up to about 10 to the power 308, and has about 15 significant digits. Ordinarily, you should stick to the double type for real values. A variable of type char occupies two bytes in memory. The value of a char variable is a single character such as A, *, x, or a space character. The value can also be a special character such a tab or a carriage return or one of the many Unicode characters that come from different languages. When a character is typed into a program, it must be surrounded by single quotes; for example: ’A’, ’*’, or ’x’. Without the quotes, A would be an identifier and * would be a multiplication operator. The quotes are not part of the value and are not stored in the variable; they are just a convention for naming a particular character constant in a program. A name for a constant value is called a literal. A literal is what you have to type in a program to represent a value. ’A’ and ’*’ are literals of type char, representing the character values A and *. Certain special characters have special literals that use a backslash, , as an “escape character”. In particular, a tab is represented as ’t’, a carriage return as ’r’, a linefeed as ’n’, the single quote character as ’’’, and the backslash itself as ’’. Note that even though you type two characters between the quotes in ’t’, the value represented by this literal is a single tab character. Numeric literals are a little more complicated than you might expect. Of course, there are the obvious literals such as 317 and 17.42. But there are other possibilities for expressing numbers in a Java program. First of all, real numbers can be represented in an exponential form such as 1.3e12 or 12.3737e-108. The “e12” and “e-108” represent powers of 10, so that 1.3e12 means 1.3 times 1012 and 12.3737e-108 means 12.3737 times 10−108. This format can be used to express very large and very small numbers. Any numerical literal that contains a decimal point or exponential is a literal of type double. To make a literal of type float, you have to append an “F” or “f” to the end of the number. For example, “1.2F” stands for 1.2 considered as a value of type float. (Occasionally, you need to know this because the rules of Java say that you can’t assign a value of type double to a variable of type float, so you might be
- 42. 26 CHAPTER 2. NAMES AND THINGS confronted with a ridiculous-seeming error message if you try to do something like “x = 1.2;” when x is a variable of type float. You have to say “x = 1.2F;". This is one reason why I advise sticking to type double for real numbers.) Even for integer literals, there are some complications. Ordinary integers such as 177777 and -32 are literals of type byte, short, or int, depending on their size. You can make a literal of type long by adding “L” as a suffix. For example: 17L or 728476874368L. As another complication, Java allows octal (base-8) and hexadecimal (base-16) literals. I don’t want to cover base-8 and base-16 in detail, but in case you run into them in other people’s programs, it’s worth knowing a few things: Octal numbers use only the digits 0 through 7. In Java, a numeric literal that begins with a 0 is interpreted as an octal number; for example, the literal 045 represents the number 37, not the number 45. Hexadecimal numbers use 16 digits, the usual digits 0 through 9 and the letters A, B, C, D, E, and F. Upper case and lower case letters can be used interchangeably in this context. The letters represent the numbers 10 through 15. In Java, a hexadecimal literal begins with 0x or 0X, as in 0x45 or 0xFF7A. Hexadecimal numbers are also used in character literals to represent arbitrary Unicode characters. A Unicode literal consists of u followed by four hexadecimal digits. For example, the character literal ’u00E9’ represents the Unicode character that is an “e” with an acute accent. For the type boolean, there are precisely two literals: true and false. These literals are typed just as I’ve written them here, without quotes, but they represent values, not variables. Boolean values occur most often as the values of conditional expressions. For example, rate > 0.05 is a boolean-valued expression that evaluates to true if the value of the variable rate is greater than 0.05, and to false if the value of rate is not greater than 0.05. As you’ll see in Chapter 3, boolean-valued expressions are used extensively in control structures. Of course, boolean values can also be assigned to variables of type boolean. Java has other types in addition to the primitive types, but all the other types represent objects rather than “primitive” data values. For the most part, we are not concerned with objects for the time being. However, there is one predefined object type that is very important: the type String. A String is a sequence of characters. You’ve already seen a string literal: "Hello World!". The double quotes are part of the literal; they have to be typed in the program. However, they are not part of the actual string value, which consists of just the characters between the quotes. Within a string, special characters can be represented using the backslash notation. Within this context, the double quote is itself a special character. For example, to represent the string value I said, "Are you listening!" with a linefeed at the end, you would have to type the string literal: "I said, "Are you listening!"n" You can also use t, r, , and unicode sequences such as u00E9 to represent other special characters in string literals. Because strings are objects, their behavior in programs is peculiar in some respects (to someone who is not used to objects). I’ll have more to say about them in the next section.
- 43. 2.2. VARIABLES AND TYPES 27 2.2.3 Variables in Programs A variable can be used in a program only if it has first been declared. A variable declaration statement is used to declare one or more variables and to give them names. When the computer executes a variable declaration, it sets aside memory for the variable and associates the variable’s name with that memory. A simple variable declaration takes the form: htype-namei hvariable-name-or-namesi; The hvariable-name-or-namesi can be a single variable name or a list of variable names separated by commas. (We’ll see later that variable declaration statements can actually be somewhat more complicated than this.) Good programming style is to declare only one variable in a declaration statement, unless the variables are closely related in some way. For example: int numberOfStudents; String name; double x, y; boolean isFinished; char firstInitial, middleInitial, lastInitial; It is also good style to include a comment with each variable declaration to explain its purpose in the program, or to give other information that might be useful to a human reader. For example: double principal; // Amount of money invested. double interestRate; // Rate as a decimal, not percentage. In this chapter, we will only use variables declared inside the main() subroutine of a pro- gram. Variables declared inside a subroutine are called local variables for that subroutine. They exist only inside the subroutine, while it is running, and are completely inaccessible from outside. Variable declarations can occur anywhere inside the subroutine, as long as each variable is declared before it is used in any expression. Some people like to declare all the variables at the beginning of the subroutine. Others like to wait to declare a variable until it is needed. My preference: Declare important variables at the beginning of the subroutine, and use a comment to explain the purpose of each variable. Declare “utility variables” which are not important to the overall logic of the subroutine at the point in the subroutine where they are first used. Here is a simple program using some variables and assignment statements: /** * This class implements a simple program that * will compute the amount of interest that is * earned on $17,000 invested at an interest * rate of 0.07 for one year. The interest and * the value of the investment after one year are * printed to standard output. */ public class Interest { public static void main(String[] args) { /* Declare the variables. */ double principal; // The value of the investment. double rate; // The annual interest rate. double interest; // Interest earned in one year.
- 44. 28 CHAPTER 2. NAMES AND THINGS /* Do the computations. */ principal = 17000; rate = 0.07; interest = principal * rate; // Compute the interest. principal = principal + interest; // Compute value of investment after one year, with interest. // (Note: The new value replaces the old value of principal.) /* Output the results. */ System.out.print("The interest earned is $"); System.out.println(interest); System.out.print("The value of the investment after one year is $"); System.out.println(principal); } // end of main() } // end of class Interest This program uses several subroutine call statements to display information to the user of the program. Two different subroutines are used: System.out.print and System.out.println. The difference between these is that System.out.println adds a linefeed after the end of the information that it displays, while System.out.print does not. Thus, the value of interest, which is displayed by the subroutine call “System.out.println(interest);”, follows on the same line after the string displayed by the previous System.out.print statement. Note that the value to be displayed by System.out.print or System.out.println is provided in paren- theses after the subroutine name. This value is called a parameter to the subroutine. A parameter provides a subroutine with information it needs to perform its task. In a subroutine call statement, any parameters are listed in parentheses after the subroutine name. Not all subroutines have parameters. If there are no parameters in a subroutine call statement, the subroutine name must be followed by an empty pair of parentheses. All the sample programs for this textbook are available in separate source code files in the on-line version of this text at http://math.hws.edu/javanotes/source. They are also included in the downloadable archives of the web site. The source code for the Interest program, for example, can be found in the file Interest.java. 2.3 Strings, Objects, Enums, and Subroutines The previous section introduced the eight primitive data types and the type String. There is a fundamental difference between the primitive types and the String type: Values of type String are objects. While we will not study objects in detail until Chapter 5, it will be useful for you to know a little about them and about a closely related topic: classes. This is not just because strings are useful but because objects and classes are essential to understanding another important programming concept, subroutines. Another reason for considering classes and objects at this point is so that we can introduce enums. An enum is a data type that can be created by a Java programmer to represent a small collection of possible values. Technically, an enum is a class and its possible values are objects. Enums will be our first example of adding a new type to the Java language. We will look at them later in this section.
- 45. 2.3. OBJECTS AND SUBROUTINES 29 2.3.1 Built-in Subroutines and Functions Recall that a subroutine is a set of program instructions that have been chunked together and given a name. In Chapter 4, you’ll learn how to write your own subroutines, but you can get a lot done in a program just by calling subroutines that have already been written for you. In Java, every subroutine is contained in a class or in an object. Some classes that are standard parts of the Java language contain predefined subroutines that you can use. A value of type String, which is an object, contains subroutines that can be used to manipulate that string. These subroutines are “built into” the Java language. You can call all these subroutines without understanding how they were written or how they work. Indeed, that’s the whole point of subroutines: A subroutine is a “black box” which can be used without knowing what goes on inside. Classes in Java have two very different functions. First of all, a class can group together variables and subroutines that are contained in that class. These variables and subroutines are called static members of the class. You’ve seen one example: In a class that defines a program, the main() routine is a static member of the class. The parts of a class definition that define static members are marked with the reserved word “static”, just like the main() routine of a program. However, classes have a second function. They are used to describe objects. In this role, the class of an object specifies what subroutines and variables are contained in that object. The class is a type—in the technical sense of a specification of a certain type of data value—and the object is a value of that type. For example, String is actually the name of a class that is included as a standard part of the Java language. String is also a type, and literal strings such as "Hello World" represent values of type String. So, every subroutine is contained either in a class or in an object. Classes contain subrou- tines called static member subroutines. Classes also describe objects and the subroutines that are contained in those objects. This dual use can be confusing, and in practice most classes are designed to perform pri- marily or exclusively in only one of the two possible roles. For example, although the String class does contain a few rarely-used static member subroutines, it exists mainly to specify a large number of subroutines that are contained in objects of type String. Another standard class, named Math, exists entirely to group together a number of static member subroutines that compute various common mathematical functions. ∗ ∗ ∗ To begin to get a handle on all of this complexity, let’s look at the subroutine System.out.print as an example. As you have seen earlier in this chapter, this subroutine is used to display information to the user. For example, System.out.print("Hello World") displays the message, Hello World. System is one of Java’s standard classes. One of the static member variables in this class is named out. Since this variable is contained in the class System, its full name—which you have to use to refer to it in your programs—is System.out. The variable System.out refers to an object, and that object in turn contains a subroutine named print. The compound identifier System.out.print refers to the subroutine print in the object out in the class System. (As an aside, I will note that the object referred to by System.out is an object of the class PrintStream. PrintStream is another class that is a standard part of Java. Any object of type PrintStream is a destination to which information can be printed; any object of type PrintStream has a print subroutine that can be used to send information to that destination. The object System.out is just one possible destination, and System.out.print is the subrou-
- 46. 30 CHAPTER 2. NAMES AND THINGS tine that sends information to that particular destination. Other objects of type PrintStream might send information to other destinations such as files or across a network to other com- puters. This is object-oriented programming: Many different things which have something in common—they can all be used as destinations for information—can all be used in the same way—through a print subroutine. The PrintStream class expresses the commonalities among all these objects.) Since class names and variable names are used in similar ways, it might be hard to tell which is which. Remember that all the built-in, predefined names in Java follow the rule that class names begin with an upper case letter while variable names begin with a lower case letter. While this is not a formal syntax rule, I recommend that you follow it in your own programming. Subroutine names should also begin with lower case letters. There is no possibility of confusing a variable with a subroutine, since a subroutine name in a program is always followed by a left parenthesis. (As one final general note, you should be aware that subroutines in Java are often referred to as methods. Generally, the term “method” means a subroutine that is contained in a class or in an object. Since this is true of every subroutine in Java, every subroutine in Java is a method. The same is not true for other programming languages. Nevertheless, the term “method” is mostly used in the context of object-oriented programming, and until we start doing real object-oriented programming in Chapter 5, I will prefer to use the more general term, “subroutine.”) ∗ ∗ ∗ Classes can contain static member subroutines, as well as static member variables. For example, the System class contains a subroutine named exit. In a program, of course, this subroutine must be referred to as System.exit. Calling this subroutine will terminate the program. You could use it if you had some reason to terminate the program before the end of the main routine. For historical reasons, this subroutine takes an integer as a parameter, so the subroutine call statement might look like “System.exit(0);” or “System.exit(1);”. (The parameter tells the computer why the program was terminated. A parameter value of 0 indicates that the program ended normally. Any other value indicates that the program was terminated because an error was detected. But in practice, the value of the parameter is usually ignored.) Every subroutine performs some specific task. For some subroutines, that task is to compute or retrieve some data value. Subroutines of this type are called functions. We say that a function returns a value. The returned value must then be used somehow in the program. You are familiar with the mathematical function that computes the square root of a num- ber. Java has a corresponding function called Math.sqrt. This function is a static member subroutine of the class named Math. If x is any numerical value, then Math.sqrt(x) computes and returns the square root of that value. Since Math.sqrt(x) represents a value, it doesn’t make sense to put it on a line by itself in a subroutine call statement such as Math.sqrt(x); // This doesn’t make sense! What, after all, would the computer do with the value computed by the function in this case? You have to tell the computer to do something with the value. You might tell the computer to display it: System.out.print( Math.sqrt(x) ); // Display the square root of x. or you might use an assignment statement to tell the computer to store that value in a variable:
- 47. 2.3. OBJECTS AND SUBROUTINES 31 lengthOfSide = Math.sqrt(x); The function call Math.sqrt(x) represents a value of type double, and it can be used anyplace where a numeric literal of type double could be used. The Math class contains many static member functions. Here is a list of some of the more important of them: • Math.abs(x), which computes the absolute value of x. • The usual trigonometric functions, Math.sin(x), Math.cos(x), and Math.tan(x). (For all the trigonometric functions, angles are measured in radians, not degrees.) • The inverse trigonometric functions arcsin, arccos, and arctan, which are written as: Math.asin(x), Math.acos(x), and Math.atan(x). The return value is expressed in radi- ans, not degrees. • The exponential function Math.exp(x) for computing the number e raised to the power x, and the natural logarithm function Math.log(x) for computing the logarithm of x in the base e. • Math.pow(x,y) for computing x raised to the power y. • Math.floor(x), which rounds x down to the nearest integer value that is less than or equal to x. Even though the return value is mathematically an integer, it is returned as a value of type double, rather than of type int as you might expect. For example, Math.floor(3.76) is 3.0. The function Math.round(x) returns the integer that is closest to x. • Math.random(), which returns a randomly chosen double in the range 0.0 <= Math.random() < 1.0. (The computer actually calculates so-called “pseudorandom” numbers, which are not truly random but are random enough for most purposes.) For these functions, the type of the parameter—the x or y inside the parentheses—can be any value of any numeric type. For most of the functions, the value returned by the function is of type double no matter what the type of the parameter. However, for Math.abs(x), the value returned will be the same type as x; if x is of type int, then so is Math.abs(x). So, for example, while Math.sqrt(9) is the double value 3.0, Math.abs(9) is the int value 9. Note that Math.random() does not have any parameter. You still need the parentheses, even though there’s nothing between them. The parentheses let the computer know that this is a sub- routine rather than a variable. Another example of a subroutine that has no parameters is the function System.currentTimeMillis(), from the System class. When this function is executed, it retrieves the current time, expressed as the number of milliseconds that have passed since a standardized base time (the start of the year 1970 in Greenwich Mean Time, if you care). One millisecond is one-thousandth of a second. The return value of System.currentTimeMillis() is of type long. This function can be used to measure the time that it takes the computer to perform a task. Just record the time at which the task is begun and the time at which it is finished and take the difference. Here is a sample program that performs a few mathematical tasks and reports the time that it takes for the program to run. On some computers, the time reported might be zero, because it is too small to measure in milliseconds. Even if it’s not zero, you can be sure that most of the time reported by the computer was spent doing output or working on tasks other than the program, since the calculations performed in this program occupy only a tiny fraction of a second of a computer’s time.
- 48. 32 CHAPTER 2. NAMES AND THINGS /** * This program performs some mathematical computations and displays * the results. It then reports the number of seconds that the * computer spent on this task. */ public class TimedComputation { public static void main(String[] args) { long startTime; // Starting time of program, in milliseconds. long endTime; // Time when computations are done, in milliseconds. double time; // Time difference, in seconds. startTime = System.currentTimeMillis(); double width, height, hypotenuse; // sides of a triangle width = 42.0; height = 17.0; hypotenuse = Math.sqrt( width*width + height*height ); System.out.print("A triangle with sides 42 and 17 has hypotenuse "); System.out.println(hypotenuse); System.out.println("nMathematically, sin(x)*sin(x) + " + "cos(x)*cos(x) - 1 should be 0."); System.out.println("Let’s check this for x = 1:"); System.out.print(" sin(1)*sin(1) + cos(1)*cos(1) - 1 is "); System.out.println( Math.sin(1)*Math.sin(1) + Math.cos(1)*Math.cos(1) - 1 ); System.out.println("(There can be round-off errors when" + " computing with real numbers!)"); System.out.print("nHere is a random number: "); System.out.println( Math.random() ); endTime = System.currentTimeMillis(); time = (endTime - startTime) / 1000.0; System.out.print("nRun time in seconds was: "); System.out.println(time); } // end main() } // end class TimedComputation 2.3.2 Operations on Strings A value of type String is an object. That object contains data, namely the sequence of characters that make up the string. It also contains subroutines. All of these subroutines are in fact functions. For example, every string object contains a function named length that computes the number of characters in that string. Suppose that advice is a variable that refers to a String. For example, advice might have been declared and assigned a value as follows: String advice; advice = "Seize the day!";
- 49. 2.3. OBJECTS AND SUBROUTINES 33 Then advice.length() is a function call that returns the number of characters in the string “Seize the day!”. In this case, the return value would be 14. In general, for any string variable str, the value of str.length() is an int equal to the number of characters in the string that is the value of str. Note that this function has no parameter; the particular string whose length is being computed is the value of str. The length subroutine is defined by the class String, and it can be used with any value of type String. It can even be used with String literals, which are, after all, just constant values of type String. For example, you could have a program count the characters in “Hello World” for you by saying System.out.print("The number of characters in "); System.out.println("the string "Hello World" is "); System.out.println( "Hello World".length() ); The String class defines a lot of functions. Here are some that you might find useful. Assume that s1 and s2 refer to values of type String: • s1.equals(s2) is a function that returns a boolean value. It returns true if s1 consists of exactly the same sequence of characters as s2, and returns false otherwise. • s1.equalsIgnoreCase(s2) is another boolean-valued function that checks whether s1 is the same string as s2, but this function considers upper and lower case letters to be equivalent. Thus, if s1 is “cat”, then s1.equals("Cat") is false, while s1.equalsIgnoreCase("Cat") is true. • s1.length(), as mentioned above, is an integer-valued function that gives the number of characters in s1. • s1.charAt(N), where N is an integer, returns a value of type char. It returns the N- th character in the string. Positions are numbered starting with 0, so s1.charAt(0) is actually the first character, s1.charAt(1) is the second, and so on. The final position is s1.length() - 1. For example, the value of "cat".charAt(1) is ’a’. An error occurs if the value of the parameter is less than zero or greater than s1.length() - 1. • s1.substring(N,M), where N and M are integers, returns a value of type String. The returned value consists of the characters in s1 in positions N, N+1,. . . , M-1. Note that the character in position M is not included. The returned value is called a substring of s1. • s1.indexOf(s2) returns an integer. If s2 occurs as a substring of s1, then the returned value is the starting position of that substring. Otherwise, the returned value is -1. You can also use s1.indexOf(ch) to search for a particular character, ch, in s1. To find the first occurrence of x at or after position N, you can use s1.indexOf(x,N). • s1.compareTo(s2) is an integer-valued function that compares the two strings. If the strings are equal, the value returned is zero. If s1 is less than s2, the value returned is a number less than zero, and if s1 is greater than s2, the value returned is some number greater than zero. (If both of the strings consist entirely of lower case letters, then “less than” and “greater than” refer to alphabetical order. Otherwise, the ordering is more complicated.) • s1.toUpperCase() is a String-valued function that returns a new string that is equal to s1, except that any lower case letters in s1 have been converted to upper case. For example, "Cat".toUpperCase() is the string "CAT". There is also a function s1.toLowerCase(). • s1.trim() is a String-valued function that returns a new string that is equal to s1 except that any non-printing characters such as spaces and tabs have been trimmed from the
- 50. 34 CHAPTER 2. NAMES AND THINGS beginning and from the end of the string. Thus, if s1 has the value "fred ", then s1.trim() is the string "fred". For the functions s1.toUpperCase(), s1.toLowerCase(), and s1.trim(), note that the value of s1 is not modified. Instead a new string is created and returned as the value of the function. The returned value could be used, for example, in an assignment statement such as “smallLetters = s1.toLowerCase();”. To change the value of s1, you could use an assignment “s1 = s1.toLowerCase();”. ∗ ∗ ∗ Here is another extremely useful fact about strings: You can use the plus operator, +, to concatenate two strings. The concatenation of two strings is a new string consisting of all the characters of the first string followed by all the characters of the second string. For example, "Hello" + "World" evaluates to "HelloWorld". (Gotta watch those spaces, of course—if you want a space in the concatenated string, it has to be somewhere in the input data, as in "Hello " + "World".) Let’s suppose that name is a variable of type String and that it already refers to the name of the person using the program. Then, the program could greet the user by executing the statement: System.out.println("Hello, " + name + ". Pleased to meet you!"); Even more surprising is that you can actually concatenate values of any type onto a String using the + operator. The value is converted to a string, just as it would be if you printed it to the standard output, and then it is concatenated onto the string. For example, the expression "Number" + 42 evaluates to the string "Number42". And the statements System.out.print("After "); System.out.print(years); System.out.print(" years, the value is "); System.out.print(principal); can be replaced by the single statement: System.out.print("After " + years + " years, the value is " + principal); Obviously, this is very convenient. It would have shortened some of the examples presented earlier in this chapter. 2.3.3 Introduction to Enums Java comes with eight built-in primitive types and a large set of types that are defined by classes, such as String. But even this large collection of types is not sufficient to cover all the possible situations that a programmer might have to deal with. So, an essential part of Java, just like almost any other programming language, is the ability to create new types. For the most part, this is done by defining new classes; you will learn how to do that in Chapter 5. But we will look here at one particular case: the ability to define enums (short for enumerated types). Enums are a recent addition to Java. They were only added in Version 5.0. Many programming languages have something similar, and many people believe that enums should have been part of Java from the beginning. Technically, an enum is considered to be a special kind of class, but that is not important for now. In this section, we will look at enums in a simplified form. In practice, most uses of enums will only need the simplified form that is presented here.
- 51. 2.3. OBJECTS AND SUBROUTINES 35 An enum is a type that has a fixed list of possible values, which is specified when the enum is created. In some ways, an enum is similar to the boolean data type, which has true and false as its only possible values. However, boolean is a primitive type, while an enum is not. The definition of an enum types has the (simplified) form: enum henum-type-namei { hlist-of-enum-valuesi } This definition cannot be inside a subroutine. You can place it outside the main() routine of the program. The henum-type-namei can be any simple identifier. This identifier becomes the name of the enum type, in the same way that “boolean” is the name of the boolean type and “String” is the name of the String type. Each value in the hlist-of-enum-valuesi must be a simple identifier, and the identifiers in the list are separated by commas. For example, here is the definition of an enum type named Season whose values are the names of the four seasons of the year: enum Season { SPRING, SUMMER, FALL, WINTER } By convention, enum values are given names that are made up of upper case letters, but that is a style guideline and not a syntax rule. Enum values are not variables. Each value is a constant that always has the same value. In fact, the possible values of an enum type are usually referred to as enum constants. Note that the enum constants of type Season are considered to be “contained in” Season, which means—following the convention that compound identifiers are used for things that are contained in other things—the names that you actually use in your program to refer to them are Season.SPRING, Season.SUMMER, Season.FALL, and Season.WINTER. Once an enum type has been created, it can be used to declare variables in exactly the same ways that other types are used. For example, you can declare a variable named vacation of type Season with the statement: Season vacation; After declaring the variable, you can assign a value to it using an assignment statement. The value on the right-hand side of the assignment can be one of the enum constants of type Season. Remember to use the full name of the constant, including “Season”! For example: vacation = Season.SUMMER; You can print out an enum value with an output statement such as System.out.print(vacation). The output value will be the name of the enum constant (without the “Season.”). In this case, the output would be “SUMMER”. Because an enum is technically a class, the enum values are technically objects. As ob- jects, they can contain subroutines. One of the subroutines in every enum value is named ordinal(). When used with an enum value, it returns the ordinal number of the value in the list of values of the enum. The ordinal number simply tells the position of the value in the list. That is, Season.SPRING.ordinal() is the int value 0, Season.SUMMER.ordinal() is 1, Season.FALL.ordinal() is 2, and Season.WINTER.ordinal() is 3. (You will see over and over again that computer scientists like to start counting at zero!) You can, of course, use the ordinal() method with a variable of type Season, such as vacation.ordinal() in our example. Right now, it might not seem to you that enums are all that useful. As you work though the rest of the book, you should be convinced that they are. For now, you should at least appreciate them as the first example of an important concept: creating new types. Here is a little example that shows enums being used in a complete program:
- 52. 36 CHAPTER 2. NAMES AND THINGS public class EnumDemo { // Define two enum types -- remember that the definitions // go OUTSIDE The main() routine! enum Day { SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY } enum Month { JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP, OCT, NOV, DEC } public static void main(String[] args) { Day tgif; // Declare a variable of type Day. Month libra; // Declare a variable of type Month. tgif = Day.FRIDAY; // Assign a value of type Day to tgif. libra = Month.OCT; // Assign a value of type Month to libra. System.out.print("My sign is libra, since I was born in "); System.out.println(libra); // Output value will be: OCT System.out.print("That’s the "); System.out.print( libra.ordinal() ); System.out.println("-th month of the year."); System.out.println(" (Counting from 0, of course!)"); System.out.print("Isn’t it nice to get to "); System.out.println(tgif); // Output value will be: FRIDAY System.out.println( tgif + " is the " + tgif.ordinal() + "-th day of the week."); // You can concatenate enum values onto Strings! } } 2.4 Text Input and Output For some unfathomable reason, Java has never made it easy to read data typed in by the user of a program. You’ve already seen that output can be displayed to the user using the subroutine System.out.print. This subroutine is part of a pre-defined object called System.out. The purpose of this object is precisely to display output to the user. There is a corresponding object called System.in that exists to read data input by the user, but it provides only very primitive input facilities, and it requires some advanced Java programming skills to use it effectively. Java 5.0 finally makes input a little easier with a new Scanner class. However, it requires some knowledge of object-oriented programming to use this class, so it’s not appropriate for use here at the beginning of this course. (Furthermore, in my opinion, Scanner still does not get things quite right.) There is some excuse for this lack of concern with input, since Java is meant mainly to write programs for Graphical User Interfaces, and those programs have their own style of input/output, which is implemented in Java. However, basic support is needed for input/output in old-fashioned non-GUI programs. Fortunately, it is possible to extend Java by creating new classes that provide subroutines that are not available in the standard part of the language. As soon as a new class is available, the subroutines that it contains can be used in exactly the same way as built-in routines.
- 53. 2.4. TEXT INPUT AND OUTPUT 37 Along these lines, I’ve written a class called TextIO that defines subroutines for reading values typed by the user of a non-GUI program. The subroutines in this class make it possible to get input from the standard input object, System.in, without knowing about the advanced aspects of Java that are needed to use Scanner or to use System.in directly. TextIO also contains a set of output subroutines. The output subroutines are similar to those provided in System.out, but they provide a few additional features. You can use whichever set of output subroutines you prefer, and you can even mix them in the same program. To use the TextIO class, you must make sure that the class is available to your program. What this means depends on the Java programming environment that you are using. In general, you just have to add the source code file, TextIO.java, to the same directory that contains your main program. See Section 2.6 for more information about how to use TextIO. 2.4.1 A First Text Input Example The input routines in the TextIO class are static member functions. (Static member functions were introduced in the previous section.) Let’s suppose that you want your program to read an integer typed in by the user. The TextIO class contains a static member function named getlnInt that you can use for this purpose. Since this function is contained in the TextIO class, you have to refer to it in your program as TextIO.getlnInt. The function has no parameters, so a complete call to the function takes the form “TextIO.getlnInt()”. This function call represents the int value typed by the user, and you have to do something with the returned value, such as assign it to a variable. For example, if userInput is a variable of type int (created with a declaration statement “int userInput;”), then you could use the assignment statement userInput = TextIO.getlnInt(); When the computer executes this statement, it will wait for the user to type in an integer value. The value typed will be returned by the function, and it will be stored in the variable, userInput. Here is a complete program that uses TextIO.getlnInt to read a number typed by the user and then prints out the square of the number that the user types: /** * A program that reads an integer that is typed in by the * user and computes and prints the square of that integer. */ public class PrintSquare { public static void main(String[] args) { int userInput; // The number input by the user. int square; // The userInput, multiplied by itself. System.out.print("Please type a number: "); userInput = TextIO.getlnInt(); square = userInput * userInput; System.out.print("The square of that number is "); System.out.println(square); } // end of main() } //end of class PrintSquare
- 54. 38 CHAPTER 2. NAMES AND THINGS When you run this program, it will display the message “Please type a number:” and will pause until you type a response, including a carriage return after the number. 2.4.2 Text Output The TextIO class contains static member subroutines TextIO.put and TextIO.putln that can be used in the same way as System.out.print and System.out.println. For example, al- though there is no particular advantage in doing so in this case, you could replace the two lines System.out.print("The square of that number is "); System.out.println(square); with TextIO.put("The square of that number is "); TextIO.putln(square); For the next few chapters, I will use TextIO for input in all my examples, and I will often use it for output. Keep in mind that TextIO can only be used in a program if it is available to that program. It is not built into Java in the way that the System class is. Let’s look a little more closely at the built-in output subroutines System.out.print and System.out.println. Each of these subroutines can be used with one parameter, where the parameter can be a value of any of the primitive types byte, short, int, long, float, double, char, or boolean. The parameter can also be a String, a value belonging to an enum type, or indeed any object. That is, you can say “System.out.print(x);” or “System.out.println(x);”, where x is any expression whose value is of any type whatsoever. The expression can be a con- stant, a variable, or even something more complicated such as 2*distance*time. Now, in fact, the System class actually includes several different subroutines to handle different parameter types. There is one System.out.print for printing values of type double, one for values of type int, another for values that are objects, and so on. These subroutines can have the same name since the computer can tell which one you mean in a given subroutine call statement, depending on the type of parameter that you supply. Having several subroutines of the same name that differ in the types of their parameters is called overloading. Many programming languages do not permit overloading, but it is common in Java programs. The difference between System.out.print and System.out.println is that the println version outputs a carriage return after it outputs the specified parameter value. There is a version of System.out.println that has no parameters. This version simply outputs a carriage return, and nothing else. A subroutine call statement for this version of the program looks like “System.out.println();”, with empty parentheses. Note that “System.out.println(x);” is exactly equivalent to “System.out.print(x); System.out.println();”; the carriage return comes after the value of x. (There is no version of System.out.print without parameters. Do you see why?) As mentioned above, the TextIO subroutines TextIO.put and TextIO.putln can be used as replacements for System.out.print and System.out.println. The TextIO functions work in exactly the same way as the System functions, except that, as we will see below, TextIO can also be used to write to other destinations.
- 55. 2.4. TEXT INPUT AND OUTPUT 39 2.4.3 TextIO Input Functions The TextIO class is a little more versatile at doing output than is System.out. However, it’s input for which we really need it. With TextIO, input is done using functions. For example, TextIO.getlnInt(), which was discussed above, makes the user type in a value of type int and returns that input value so that you can use it in your program. TextIO includes several functions for reading different types of input values. Here are examples of the ones that you are most likely to use: j = TextIO.getlnInt(); // Reads a value of type int. y = TextIO.getlnDouble(); // Reads a value of type double. a = TextIO.getlnBoolean(); // Reads a value of type boolean. c = TextIO.getlnChar(); // Reads a value of type char. w = TextIO.getlnWord(); // Reads one "word" as a value of type String. s = TextIO.getln(); // Reads an entire input line as a String. For these statements to be legal, the variables on the left side of each assignment statement must already be declared and must be of the same type as that returned by the function on the right side. Note carefully that these functions do not have parameters. The values that they return come from outside the program, typed in by the user as the program is running. To “capture” that data so that you can use it in your program, you have to assign the return value of the function to a variable. You will then be able to refer to the user’s input value by using the name of the variable. When you call one of these functions, you are guaranteed that it will return a legal value of the correct type. If the user types in an illegal value as input—for example, if you ask for an int and the user types in a non-numeric character or a number that is outside the legal range of values that can be stored in in a variable of type int—then the computer will ask the user to re-enter the value, and your program never sees the first, illegal value that the user entered. For TextIO.getlnBoolean(), the user is allowed to type in any of the following: true, false, t, f, yes, no, y, n, 1, or 0. Furthermore, they can use either upper or lower case letters. In any case, the user’s input is interpreted as a true/false value. It’s convenient to use TextIO.getlnBoolean() to read the user’s response to a Yes/No question. You’ll notice that there are two input functions that return Strings. The first, getlnWord(), returns a string consisting of non-blank characters only. When it is called, it skips over any spaces and carriage returns typed in by the user. Then it reads non-blank characters until it gets to the next space or carriage return. It returns a String consisting of all the non-blank characters that it has read. The second input function, getln(), simply returns a string consisting of all the characters typed in by the user, including spaces, up to the next carriage return. It gets an entire line of input text. The carriage return itself is not returned as part of the input string, but it is read and discarded by the computer. Note that the String returned by this function might be the empty string, "", which contains no characters at all. You will get this return value if the user simply presses return, without typing anything else first. All the other input functions listed—getlnInt(), getlnDouble(), getlnBoolean(), and getlnChar()—behave like getWord() in that they will skip past any blanks and carriage returns in the input before reading a value. Furthermore, if the user types extra characters on the line after the input value, all the extra characters will be discarded, along with the carriage return at the end of the line. If the program executes another input function, the user will have to type in another line of input. It might not sound like a good idea to discard any of the user’s input, but it turns out to be the safest thing to do in most programs. Sometimes, however, you do want to read more
- 56. 40 CHAPTER 2. NAMES AND THINGS than one value from the same line of input. TextIO provides the following alternative input functions to allow you to do this: j = TextIO.getInt(); // Reads a value of type int. y = TextIO.getDouble(); // Reads a value of type double. a = TextIO.getBoolean(); // Reads a value of type boolean. c = TextIO.getChar(); // Reads a value of type char. w = TextIO.getWord(); // Reads one "word" as a value of type String. The names of these functions start with “get” instead of “getln”. “Getln” is short for “get line” and should remind you that the functions whose names begin with “getln” will get an entire line of data. A function without the “ln” will read an input value in the same way, but will then save the rest of the input line in a chunk of internal memory called the input buffer. The next time the computer wants to read an input value, it will look in the input buffer before prompting the user for input. This allows the computer to read several values from one line of the user’s input. Strictly speaking, the computer actually reads only from the input buffer. The first time the program tries to read input from the user, the computer will wait while the user types in an entire line of input. TextIO stores that line in the input buffer until the data on the line has been read or discarded (by one of the “getln” functions). The user only gets to type when the buffer is empty. Clearly, the semantics of input is much more complicated than the semantics of output! Fortunately, for the majority of applications, it’s pretty straightforward in practice. You only need to follow the details if you want to do something fancy. In particular, I strongly advise you to use the “getln” versions of the input routines, rather than the “get” versions, unless you really want to read several items from the same line of input, precisely because the semantics of the “getln” versions is much simpler. Note, by the way, that although the TextIO input functions will skip past blank spaces and carriage returns while looking for input, they will not skip past other characters. For example, if you try to read two ints and the user types “2,3”, the computer will read the first number correctly, but when it tries to read the second number, it will see the comma. It will regard this as an error and will force the user to retype the number. If you want to input several numbers from one line, you should make sure that the user knows to separate them with spaces, not commas. Alternatively, if you want to require a comma between the numbers, use getChar() to read the comma before reading the second number. There is another character input function, TextIO.getAnyChar(), which does not skip past blanks or carriage returns. It simply reads and returns the next character typed by the user, even if it’s a blank or carriage return. If the user typed a carriage return, then the char returned by getAnyChar() is the special linefeed character ’n’. There is also a function, TextIO.peek(), that lets you look ahead at the next character in the input without actually reading it. After you “peek” at the next character, it will still be there when you read the next item from input. This allows you to look ahead and see what’s coming up in the input, so that you can take different actions depending on what’s there. The TextIO class provides a number of other functions. To learn more about them, you can look at the comments in the source code file, TextIO.java. (You might be wondering why there are only two output routines, print and println, which can output data values of any type, while there is a separate input routine for each data type. As noted above, in reality there are many print and println routines, one for each data type. The computer can tell them apart based on the type of the parameter that you provide. However, the input routines don’t have parameters, so the different input routines can only be
- 57. 2.4. TEXT INPUT AND OUTPUT 41 distinguished by having different names.) ∗ ∗ ∗ Using TextIO for input and output, we can now improve the program from Section 2.2 for computing the value of an investment. We can have the user type in the initial value of the investment and the interest rate. The result is a much more useful program—for one thing, it makes sense to run it more than once! /** * This class implements a simple program that will compute * the amount of interest that is earned on an investment over * a period of one year. The initial amount of the investment * and the interest rate are input by the user. The value of * the investment at the end of the year is output. The * rate must be input as a decimal, not a percentage (for * example, 0.05 rather than 5). */ public class Interest2 { public static void main(String[] args) { double principal; // The value of the investment. double rate; // The annual interest rate. double interest; // The interest earned during the year. TextIO.put("Enter the initial investment: "); principal = TextIO.getlnDouble(); TextIO.put("Enter the annual interest rate (decimal, not percentage!): "); rate = TextIO.getlnDouble(); interest = principal * rate; // Compute this year’s interest. principal = principal + interest; // Add it to principal. TextIO.put("The value of the investment after one year is $"); TextIO.putln(principal); } // end of main() } // end of class Interest2 2.4.4 Formatted Output If you ran the preceding Interest2 example, you might have noticed that the answer is not always written in the format that is usually used for dollar amounts. In general, dollar amounts are written with two digits after the decimal point. But the program’s output can be a number like 1050.0 or 43.575. It would be better if these numbers were printed as 1050.00 and 43.58. Java 5.0 introduced a formatted output capability that makes it much easier than it used to be to control the format of output numbers. A lot of formatting options are available. I will cover just a few of the simplest and most commonly used possibilities here. You can use the function System.out.printf to produce formatted output. (The name “printf,” which stands for “print formatted,” is copied from the C and C++ programming languages, which have always have a similar formatting capability). System.out.printf takes two or more parameters. The first parameter is a String that specifies the format of the output. This parameter is called the format string. The remaining parameters specify the values that
- 58. 42 CHAPTER 2. NAMES AND THINGS are to be output. Here is a statement that will print a number in the proper format for a dollar amount, where amount is a variable of type double: System.out.printf( "%1.2f", amount ); TextIO can also do formatted output. The function TextIO.putf has the same functionality as System.out.printf. Using TextIO, the above example would be: TextIO.printf("%1.2",amount); and you could say TextIO.putln("%1.2f",principal); instead of TextIO.putln(principal); in the Interest2 program to get the output in the right format. The output format of a value is specified by a format specifier. The format string (in the simple cases that I cover here) contains one format specifier for each of the values that is to be output. Some typical format specifiers are %d, %12d, %10s, %1.2f, %15.8e and %1.8g. Every format specifier begins with a percent sign (%) and ends with a letter, possibly with some extra formatting information in between. The letter specifies the type of output that is to be produced. For example, in %d and %12d, the “d” specifies that an integer is to be written. The “12” in %12d specifies the minimum number of spaces that should be used for the output. If the integer that is being output takes up fewer than 12 spaces, extra blank spaces are added in front of the integer to bring the total up to 12. We say that the output is “right-justified in a field of length 12.” The value is not forced into 12 spaces; if the value has more than 12 digits, all the digits will be printed, with no extra spaces. The specifier %d means the same as %1d; that is an integer will be printed using just as many spaces as necessary. (The “d,” by the way, stands for “decimal” (base-10) numbers. You can use an “x” to output an integer value in hexadecimal form.) The letter “s” at the end of a format specifier can be used with any type of value. It means that the value should be output in its default format, just as it would be in unformatted output. A number, such as the “10” in %10s can be added to specify the (minimum) number of characters. The “s” stands for “string,” meaning that the value is converted into a String value in the usual way. The format specifiers for values of type double are even more complicated. An “f”, as in %1.2f, is used to output a number in “floating-point” form, that is with digits after the decimal point. In %1.2f, the “2” specifies the number of digits to use after the decimal point. The “1” specifies the (minimum) number of characters to output, which effectively means that just as many characters as are necessary should be used. Similarly, %12.3f would specify a floating-point format with 3 digits after the decimal point, right-justified in a field of length 12. Very large and very small numbers should be written in exponential format, such as 6.00221415e23, representing “6.00221415 times 10 raised to the power 23.” A format speci- fier such as %15.8e specifies an output in exponential form, with the “8” telling how many digits to use after the decimal point. If you use “g” instead of “e”, the output will be in floating-point form for small values and in exponential form for large values. In %1.8g, the 8 gives the total number of digits in the answer, including both the digits before the decimal point and the digits after the decimal point. In addition to format specifiers, the format string in a printf statement can include other characters. These extra characters are just copied to the output. This can be a convenient way to insert values into the middle of an output string. For example, if x and y are variables of type int, you could say System.out.printf("The product of %d and %d is %d", x, y, x*y); When this statement is executed, the value of x is substituted for the first %d in the string, the
- 59. 2.4. TEXT INPUT AND OUTPUT 43 value of y for the second %d, and the value of the expression x*y for the third, so the output would be something like “The product of 17 and 42 is 714” (quotation marks not included in output!). 2.4.5 Introduction to File I/O System.out sends its output to the output destination known as “standard output.” But stan- dard output is just one possible output destination. For example, data can be written to a file that is stored on the user’s hard drive. The advantage to this, of course, is that the data is saved in the file even after the program ends, and the user can print the file, email it to someone else, edit it with another program, and so on. TextIO has the ability to write data to files and to read data from files. When you write output using the put, putln, or putf method in TextIO, the output is sent to the current output destination. By default, the current output destination is standard output. However, TextIO has some subroutines that can be used to change the current output destination. To write to a file named “result.txt”, for example, you would use the statement: TextIO.writeFile("result.txt"); After this statement is executed, any output from TextIO output statements will be sent to the file named “result.txt” instead of to standard output. The file should be created in the same directory that contains the program. Note that if a file with the same name already exists, its previous contents will be erased! In many cases, you want to let the user select the file that will be used for output. The statement TextIO.writeUserSelectedFile(); will open a typical graphical-user-interface file selection dialog where the user can specify the output file. If you want to go back to sending output to standard output, you can say TextIO.writeStandardOutput(); You can also specify the input source for TextIO’s various “get” functions. The default input source is standard input. You can use the statement TextIO.readFile("data.txt") to read from a file named “data.txt” instead, or you can let the user select the input file by saying TextIO.readUserSelectedFile(), and you can go back to reading from standard input with TextIO.readStandardInput(). When your program is reading from standard input, the user gets a chance to correct any errors in the input. This is not possible when the program is reading from a file. If illegal data is found when a program tries to read from a file, an error occurs that will crash the program. (Later, we will see that is is possible to “catch” such errors and recover from them.) Errors can also occur, though more rarely, when writing to files. A complete understanding of file input/output in Java requires a knowledge of object ori- ented programming. We will return to the topic later, in Chapter 11. The file I/O capabilities in TextIO are rather primitive by comparison. Nevertheless, they are sufficient for many appli- cations, and they will allow you to get some experience with files sooner rather than later. As a simple example, here is a program that asks the user some questions and outputs the user’s responses to a file named “profile.txt”: public class CreateProfile { public static void main(String[] args) {
- 60. 44 CHAPTER 2. NAMES AND THINGS String name; // The user’s name. String email; // The user’s email address. double salary; // the user’s yearly salary. String favColor; // The user’s favorite color. TextIO.putln("Good Afternoon! This program will create"); TextIO.putln("your profile file, if you will just answer"); TextIO.putln("a few simple questions."); TextIO.putln(); /* Gather responses from the user. */ TextIO.put("What is your name? "); name = TextIO.getln(); TextIO.put("What is your email address? "); email = TextIO.getln(); TextIO.put("What is your yearly income? "); salary = TextIO.getlnDouble(); TextIO.put("What is your favorite color? "); favColor = TextIO.getln(); /* Write the user’s information to the file named profile.txt. */ TextIO.writeFile("profile.txt"); // subsequent output goes to the file TextIO.putln("Name: " + name); TextIO.putln("Email: " + email); TextIO.putln("Favorite Color: " + favColor); TextIO.putf( "Yearly Income: %1.2fn", salary); // The "/n" in the previous line is a carriage return. /* Print a final message to standard output. */ TextIO.writeStandardOutput(); TextIO.putln("Thank you. Your profile has been written to profile.txt."); } } 2.5 Details of Expressions This section takes a closer look at expressions. Recall that an expression is a piece of program code that represents or computes a value. An expression can be a literal, a variable, a function call, or several of these things combined with operators such as + and >. The value of an expression can be assigned to a variable, used as a parameter in a subroutine call, or combined with other values into a more complicated expression. (The value can even, in some cases, be ignored, if that’s what you want to do; this is more common than you might think.) Expressions are an essential part of programming. So far, these notes have dealt only informally with expressions. This section tells you the more-or-less complete story (leaving out some of the less commonly used operators). The basic building blocks of expressions are literals (such as 674, 3.14, true, and ’X’), variables, and function calls. Recall that a function is a subroutine that returns a value. You’ve already seen some examples of functions, such as the input routines from the TextIO class and the mathematical functions from the Math class.
- 61. 2.5. DETAILS OF EXPRESSIONS 45 The Math class also contains a couple of mathematical constants that are useful in math- ematical expressions: Math.PI represents π (the ratio of the circumference of a circle to its diameter), and Math.E represents e (the base of the natural logarithms). These “constants” are actually member variables in Math of type double. They are only approximations for the mathematical constants, which would require an infinite number of digits to specify exactly. Literals, variables, and function calls are simple expressions. More complex expressions can be built up by using operators to combine simpler expressions. Operators include + for adding two numbers, > for comparing two values, and so on. When several operators appear in an expression, there is a question of precedence, which determines how the operators are grouped for evaluation. For example, in the expression “A + B * C”, B*C is computed first and then the result is added to A. We say that multiplication (*) has higher precedence than addition (+). If the default precedence is not what you want, you can use parentheses to explicitly specify the grouping you want. For example, you could use “(A + B) * C” if you want to add A to B first and then multiply the result by C. The rest of this section gives details of operators in Java. The number of operators in Java is quite large, and I will not cover them all here. Most of the important ones are here; a few will be covered in later chapters as they become relevant. 2.5.1 Arithmetic Operators Arithmetic operators include addition, subtraction, multiplication, and division. They are indicated by +, -, *, and /. These operations can be used on values of any numeric type: byte, short, int, long, float, or double. When the computer actually calculates one of these operations, the two values that it combines must be of the same type. If your program tells the computer to combine two values of different types, the computer will convert one of the values from one type to another. For example, to compute 37.4 + 10, the computer will convert the integer 10 to a real number 10.0 and will then compute 37.4 + 10.0. This is called a type conversion. Ordinarily, you don’t have to worry about type conversion in expressions, because the computer does it automatically. When two numerical values are combined (after doing type conversion on one of them, if necessary), the answer will be of the same type. If you multiply two ints, you get an int; if you multiply two doubles, you get a double. This is what you would expect, but you have to be very careful when you use the division operator /. When you divide two integers, the answer will always be an integer; if the quotient has a fractional part, it is discarded. For example, the value of 7/2 is 3, not 3.5. If N is an integer variable, then N/100 is an integer, and 1/N is equal to zero for any N greater than one! This fact is a common source of programming errors. You can force the computer to compute a real number as the answer by making one of the operands real: For example, when the computer evaluates 1.0/N, it first converts N to a real number in order to match the type of 1.0, so you get a real number as the answer. Java also has an operator for computing the remainder when one integer is divided by another. This operator is indicated by %. If A and B are integers, then A % B represents the remainder when A is divided by B. (However, for negative operands, % is not quite the same as the usual mathematical “modulus” operator, since if one of A or B is negative, then the value of A % B will be negative.) For example, 7 % 2 is 1, while 34577 % 100 is 77, and 50 % 8 is 2. A common use of % is to test whether a given integer is even or odd. N is even if N % 2 is zero, and it is odd if N % 2 is 1. More generally, you can check whether an integer N is evenly divisible by an integer M by checking whether N % M is zero. Finally, you might need the unary minus operator, which takes the negative of a number.
- 62. 46 CHAPTER 2. NAMES AND THINGS For example, -X has the same value as (-1)*X. For completeness, Java also has a unary plus operator, as in +X, even though it doesn’t really do anything. By the way, recall that the + operator can also be used to concatenate a value of any type onto a String. This is another example of type conversion. In Java, any type can be automatically converted into type String. 2.5.2 Increment and Decrement You’ll find that adding 1 to a variable is an extremely common operation in programming. Subtracting 1 from a variable is also pretty common. You might perform the operation of adding 1 to a variable with assignment statements such as: counter = counter + 1; goalsScored = goalsScored + 1; The effect of the assignment statement x = x + 1 is to take the old value of the variable x, compute the result of adding 1 to that value, and store the answer as the new value of x. The same operation can be accomplished by writing x++ (or, if you prefer, ++x). This actually changes the value of x, so that it has the same effect as writing “x = x + 1”. The two statements above could be written counter++; goalsScored++; Similarly, you could write x-- (or --x) to subtract 1 from x. That is, x-- performs the same computation as x = x - 1. Adding 1 to a variable is called incrementing that variable, and subtracting 1 is called decrementing. The operators ++ and -- are called the increment operator and the decrement operator, respectively. These operators can be used on variables belonging to any of the numerical types and also on variables of type char. Usually, the operators ++ or -- are used in statements like “x++;” or “x--;”. These state- ments are commands to change the value of x. However, it is also legal to use x++, ++x, x--, or --x as expressions, or as parts of larger expressions. That is, you can write things like: y = x++; y = ++x; TextIO.putln(--x); z = (++x) * (y--); The statement “y = x++;” has the effects of adding 1 to the value of x and, in addition, assigning some value to y. The value assigned to y is the value of the expression x++, which is defined to be the old value of x, before the 1 is added. Thus, if the value of x is 6, the statement “y = x++;” will change the value of x to 7, but it will change the value of y to 6 since the value assigned to y is the old value of x. On the other hand, the value of ++x is defined to be the new value of x, after the 1 is added. So if x is 6, then the statement “y = ++x;” changes the values of both x and y to 7. The decrement operator, --, works in a similar way. This can be confusing. My advice is: Don’t be confused. Use ++ and -- only in stand-alone statements, not in expressions. I will follow this advice in all the examples in these notes. 2.5.3 Relational Operators Java has boolean variables and boolean-valued expressions that can be used to express con- ditions that can be either true or false. One way to form a boolean-valued expression is
- 63. 2.5. DETAILS OF EXPRESSIONS 47 to compare two values using a relational operator. Relational operators are used to test whether two values are equal, whether one value is greater than another, and so forth. The relational operators in Java are: ==, !=, <, >, <=, and >=. The meanings of these operators are: A == B Is A "equal to" B? A != B Is A "not equal to" B? A < B Is A "less than" B? A > B Is A "greater than" B? A <= B Is A "less than or equal to" B? A >= B Is A "greater than or equal to" B? These operators can be used to compare values of any of the numeric types. They can also be used to compare values of type char. For characters, < and > are defined according the numeric Unicode values of the characters. (This might not always be what you want. It is not the same as alphabetical order because all the upper case letters come before all the lower case letters.) When using boolean expressions, you should remember that as far as the computer is con- cerned, there is nothing special about boolean values. In the next chapter, you will see how to use them in loop and branch statements. But you can also assign boolean-valued expressions to boolean variables, just as you can assign numeric values to numeric variables. By the way, the operators == and != can be used to compare boolean values. This is occasionally useful. For example, can you figure out what this does: boolean sameSign; sameSign = ((x > 0) == (y > 0)); One thing that you cannot do with the relational operators <, >, <=, and <= is to use them to compare values of type String. You can legally use == and != to compare Strings, but because of peculiarities in the way objects behave, they might not give the results you want. (The == operator checks whether two objects are stored in the same memory location, rather than whether they contain the same value. Occasionally, for some objects, you do want to make such a check—but rarely for strings. I’ll get back to this in a later chapter.) Instead, you should use the subroutines equals(), equalsIgnoreCase(), and compareTo(), which were described in Section 2.3, to compare two Strings. 2.5.4 Boolean Operators In English, complicated conditions can be formed using the words “and”, “or”, and “not.” For example, “If there is a test and you did not study for it. . . ”. “And”, “or”, and “not” are boolean operators, and they exist in Java as well as in English. In Java, the boolean operator “and” is represented by &&. The && operator is used to combine two boolean values. The result is also a boolean value. The result is true if both of the combined values are true, and the result is false if either of the combined values is false. For example, “(x == 0) && (y == 0)” is true if and only if both x is equal to 0 and y is equal to 0. The boolean operator “or” is represented by ||. (That’s supposed to be two of the vertical line characters, |.) The expression “A || B” is true if either A is true or B is true, or if both are true. “A || B” is false only if both A and B are false. The operators && and || are said to be short-circuited versions of the boolean operators. This means that the second operand of && or || is not necessarily evaluated. Consider the test (x != 0) && (y/x > 1)
- 64. 48 CHAPTER 2. NAMES AND THINGS Suppose that the value of x is in fact zero. In that case, the division y/x is undefined math- matically. However, the computer will never perform the division, since when the computer evaluates (x != 0), it finds that the result is false, and so it knows that ((x != 0) && any- thing) has to be false. Therefore, it doesn’t bother to evaluate the second operand, (y/x > 1). The evaluation has been short-circuited and the division by zero is avoided. Without the short- circuiting, there would have been a division by zero. (This may seem like a technicality, and it is. But at times, it will make your programming life a little easier.) The boolean operator “not” is a unary operator. In Java, it is indicated by ! and is written in front of its single operand. For example, if test is a boolean variable, then test = ! test; will reverse the value of test, changing it from true to false, or from false to true. 2.5.5 Conditional Operator Any good programming language has some nifty little features that aren’t really necessary but that let you feel cool when you use them. Java has the conditional operator. It’s a ternary operator—that is, it has three operands—and it comes in two pieces, ? and :, that have to be used together. It takes the form hboolean-expressioni ? hexpression1i : hexpression2i The computer tests the value of hboolean-expressioni. If the value is true, it evaluates hexpression1i; otherwise, it evaluates hexpression2i. For example: next = (N % 2 == 0) ? (N/2) : (3*N+1); will assign the value N/2 to next if N is even (that is, if N % 2 == 0 is true), and it will assign the value (3*N+1) to next if N is odd. (The parentheses in this example are not required, but they do make the expression easier to read.) 2.5.6 Assignment Operators and Type-Casts You are already familiar with the assignment statement, which uses the symbol “=” to assign the value of an expression to a variable. In fact, = is really an operator in the sense that an assignment can itself be used as an expression or as part of a more complex expression. The value of an assignment such as A=B is the same as the value that is assigned to A. So, if you want to assign the value of B to A and test at the same time whether that value is zero, you could say: if ( (A=B) == 0 )... Usually, I would say, don’t do things like that! In general, the type of the expression on the right-hand side of an assignment statement must be the same as the type of the variable on the left-hand side. However, in some cases, the computer will automatically convert the value computed by the expression to match the type of the variable. Consider the list of numeric types: byte, short, int, long, float, double. A value of a type that occurs earlier in this list can be converted automatically to a value that occurs later. For example: int A; double X; short B;
- 65. 2.5. DETAILS OF EXPRESSIONS 49 A = 17; X = A; // OK; A is converted to a double B = A; // illegal; no automatic conversion // from int to short The idea is that conversion should only be done automatically when it can be done without changing the semantics of the value. Any int can be converted to a double with the same numeric value. However, there are int values that lie outside the legal range of shorts. There is simply no way to represent the int 100000 as a short, for example, since the largest value of type short is 32767. In some cases, you might want to force a conversion that wouldn’t be done automatically. For this, you can use what is called a type cast. A type cast is indicated by putting a type name, in parentheses, in front of the value you want to convert. For example, int A; short B; A = 17; B = (short)A; // OK; A is explicitly type cast // to a value of type short You can do type casts from any numeric type to any other numeric type. However, you should note that you might change the numeric value of a number by type-casting it. For example, (short)100000 is -31072. (The -31072 is obtained by taking the 4-byte int 100000 and throwing away two of those bytes to obtain a short—you’ve lost the real information that was in those two bytes.) As another example of type casts, consider the problem of getting a random integer between 1 and 6. The function Math.random() gives a real number between 0.0 and 0.9999. . . , and so 6*Math.random() is between 0.0 and 5.999. . . . The type-cast operator, (int), can be used to convert this to an integer: (int)(6*Math.random()). A real number is cast to an integer by discarding the fractional part. Thus, (int)(6*Math.random()) is one of the integers 0, 1, 2, 3, 4, and 5. To get a number between 1 and 6, we can add 1: “(int)(6*Math.random()) + 1”. You can also type-cast between the type char and the numeric types. The numeric value of a char is its Unicode code number. For example, (char)97 is ’a’, and (int)’+’ is 43. (However, a type conversion from char to int is automatic and does not have to be indicated with an explicit type cast.) Java has several variations on the assignment operator, which exist to save typing. For example, “A += B” is defined to be the same as “A = A + B”. Every operator in Java that applies to two operands gives rise to a similar assignment operator. For example: x -= y; // same as: x = x - y; x *= y; // same as: x = x * y; x /= y; // same as: x = x / y; x %= y; // same as: x = x % y; (for integers x and y) q &&= p; // same as: q = q && p; (for booleans q and p) The combined assignment operator += even works with strings. Recall that when the + operator is used with a string as one of the operands, it represents concatenation. Since str += x is equivalent to str = str + x, when += is used with a string on the left-hand side, it appends the value on the right-hand side onto the string. For example, if str has the value “tire”, then the statement str += ’d’; changes the value of str to “tired”.
- 66. 50 CHAPTER 2. NAMES AND THINGS 2.5.7 Type Conversion of Strings In addition to automatic type conversions and explicit type casts, there are some other cases where you might want to convert a value of one type into a value of a different type. One common example is the conversion of a String value into some other type, such as converting the string "10" into the int value 10 or the string "17.42e-2" into the double value 0.1742. In Java, these conversions are handled by built-in functions. There is a standard class named Integer that contains several subroutines and variables related to the int data type. (Recall that since int is not a class, int itself can’t contain any subroutines or variables.) In particular, if str is any expression of type String, then Integer.parseInt(str) is a function call that attempts to convert the value of str into a value of type int. For example, the value of Integer.parseInt("10") is the int value 10. If the parameter to Integer.parseInt does not represent a legal int value, then an error occurs. Similarly, the standard class named Double includes a function Double.parseDouble that tries to convert a parameter of type String into a value of type double. For example, the value of the function call Double.parseDouble("3.14") is the double value 3.14. (Of course, in practice, the parameter used in Double.parseDouble or Integer.parseInt would be a variable or expression rather than a constant string.) Type conversion functions also exist for converting strings into enumerated type values. (Enumerated types, or enums, were introduced in Subsection 2.3.3.) For any enum type, a predefined function named valueOf is automatically defined for that type. This is a function that takes a string as parameter and tries to convert it to a value belonging to the enum. The valueOf function is part of the enum type, so the name of the enum is part of the full name of the function. For example, if an enum Suit is defined as enum Suit { SPADE, DIAMOND, CLUB, HEART } then the name of the type conversion function would be Suit.valueOf. The value of the function call Suit.valueOf("CLUB") would be the enumerated type value Suit.CLUB. For the conversion to succeed, the string must exactly match the simple name of one of the enumerated type constants (without the “Suit.” in front). 2.5.8 Precedence Rules If you use several operators in one expression, and if you don’t use parentheses to explicitly indicate the order of evaluation, then you have to worry about the precedence rules that deter- mine the order of evaluation. (Advice: don’t confuse yourself or the reader of your program; use parentheses liberally.) Here is a listing of the operators discussed in this section, listed in order from highest precedence (evaluated first) to lowest precedence (evaluated last): Unary operators: ++, --, !, unary - and +, type-cast Multiplication and division: *, /, % Addition and subtraction: +, - Relational operators: <, >, <=, >= Equality and inequality: ==, != Boolean and: && Boolean or: || Conditional operator: ?: Assignment operators: =, +=, -=, *=, /=, %=
- 67. 2.6. PROGRAMMING ENVIRONMENTS 51 Operators on the same line have the same precedence. When operators of the same precedence are strung together in the absence of parentheses, unary operators and assignment operators are evaluated right-to-left, while the remaining operators are evaluated left-to-right. For example, A*B/C means (A*B)/C, while A=B=C means A=(B=C). (Can you see how the expression A=B=C might be useful, given that the value of B=C as an expression is the same as the value that is assigned to B?) 2.6 Programming Environments Although the Java language is highly standardized, the procedures for creating, compil- ing, and editing Java programs vary widely from one programming environment to another. There are two basic approaches: a command line environment, where the user types com- mands and the computer responds, and an integrated development environment (IDE), where the user uses the keyboard and mouse to interact with a graphical user interface. While there is just one common command line environment for Java programming, there is a wide variety of IDEs. I cannot give complete or definitive information on Java programming environments in this section, but I will try to give enough information to let you compile and run the examples from this textbook, at least in a command line environment. There are many IDEs, and I can’t cover them all here. I will concentrate on Eclipse, one of the most popular IDEs for Java programming, but some of the information that is presented will apply to other IDEs as well. One thing to keep in mind is that you do not have to pay any money to do Java programming (aside from buying a computer, of course). Everything that you need can be downloaded for free on the Internet. 2.6.1 Java Development Kit The basic development system for Java programming is usually referred to as the JDK (Java Development Kit). It is a part of J2SE, the Java 2 Platform Standard Edition. This book requires J2SE version 5.0 (or higher). Confusingly, the JDK that is part of J2SE version 5.0 is sometimes referred to as JDK 1.5 instead of 5.0. Note that J2SE comes in two versions, a Development Kit version and a Runtime version. The Runtime can be used to run Java programs and to view Java applets in Web pages, but it does not allow you to compile your own Java programs. The Development Kit includes the Runtime and adds to it the JDK which lets you compile programs. You need a JDK for use with this textbook. Java was developed by Sun Microsystems, Inc., which makes its JDK for Windows and Linux available for free download at its Java Web site, java.sun.com. If you have a Windows computer, it might have come with a Java Runtime, but you might still need to download the JDK. Some versions of Linux come with the JDK either installed by default or on the installation media. If you need to download and install the JDK, be sure to get JDK 5.0 (or higher). As of June, 2006, the download page for JDK 5.0 can be found at http://java.sun.com/j2se/1.5.0/download.jsp. Mac OS comes with Java. The version included with Mac OS 10.4 is 1.4.2, the version previous to Java 5.0. However, JDK Version 5.0 is available for Mac OS 10.4 on Apple’s Web site and can also be installed through the standard Mac OS Software Update application. If a JDK is installed on your computer, you can use the command line environment to compile and run Java programs. Some IDEs depend on the JDK, so even if you plan to use an IDE for programming, you might still need a JDK.
- 68. 52 CHAPTER 2. NAMES AND THINGS 2.6.2 Command Line Environment Many modern computer users find the command line environment to be pretty alien and unin- tuitive. It is certainly very different from the graphical user interfaces that most people are used to. However, it takes only a little practice to learn the basics of the command line environment and to become productive using it. To use a command line programming environment, you will have to open a window where you can type in commands. In Windows, you can open such a command window by running the program named cmd. One way to run cmd is to use the “Run Program” feature in the Start menu, and enter “cmd” as the name of the program. In Mac OS, you want to run the Terminal program, which can be be found in the Utilities folder inside the Applications folder. In Linux, there are several possibilities, including Konsole, gterm, and xterm. No matter what type of computer you are using, when you open a command window, it will display a prompt of some sort. Type in a command at the prompt and press return. The computer will carry out the command, displaying any output in the command window, and will then redisplay the prompt so that you can type another command. One of the central concepts in the command line environment is the current directory which contains the files to which commands that you type apply. (The words “directory” and “folder” mean the same thing.) Often, the name of the current directory is part of the command prompt. You can get a list of the files in the current directory by typing in the command dir (on Windows) or ls (on Linux and Mac OS). When the window first opens, the current directory is your home directory, where all your files are stored. You can change the current directory using the cd command with the name of the directory that you want to use. For example, to change into your Desktop directory, type in the command cd Desktop and press return. You should create a directory (that is, a folder) to hold your Java work. For example, create a directory named javawork in your home directory. You can do this using your computer’s GUI; another way to do it is to open a command window and enter the command mkdir javawork. When you want to work on programming, open a command window and enter the command cd javawork to change into your work directory. Of course, you can have more than one working directory for your Java work; you can organize your files any way you like. ∗ ∗ ∗ The most basic commands for using Java on the command line are javac and java; javac is used to compile Java source code, and java is used to run Java stand-alone applications. If a JDK is correctly installed on your computer, it should recognize these commands when you type them in on the command line. Try typing the commands java -version and javac -version which should tell you which version of Java is installed. If you get a message such as “Command not found,” then Java is not correctly installed. If the “java” command works, but “javac” does not, it means that a Java Runtime is installed rather than a Development Kit. To test the javac command, place a copy of TextIO.java into your working directory. (If you downloaded the Web site of this book, you can find it in the directory named source; you can use your computer’s GUI to copy-and-paste this file into your working directory. Alternatively, you can navigate to TextIO.java on the book’s Web site and use the “Save As” command in your Web browser to save a copy of the file into your working directory.) Type the command: javac TextIO.java This will compile TextIO.java and will create a bytecode file named TextIO.class in the same directory. Note that if the command succeeds, you will not get any response from the computer; it will just redisplay the command prompt to tell you it’s ready for another command.
- 69. 2.6. PROGRAMMING ENVIRONMENTS 53 To test the java command, copy sample program Interest2.java from this book’s source directory into your working directory. First, compile the program with the command javac Interest2.java Remember that for this to succeed, TextIO must already be in the same directory. Then you can execute the program using the command java Interest2 Be careful to use just the name of the program, Interest2, not the name of the Java source code file or the name of the compiled class file. When you give this command, the program will run. You will be asked to enter some information, and you will respond by typing your answers into the command window, pressing return at the end of the line. When the program ends, you will see the command prompt, and you can enter another command. You can follow the same procedure to run all of the examples in the early sections of this book. When you start work with applets, you will need a different command to execute the applets. That command will be introduced later in the book. ∗ ∗ ∗ To create your own programs, you will need a text editor. A text editor is a computer program that allows you to create and save documents that contain plain text. It is important that the documents be saved as plain text, that is without any special encoding or formatting information. Word processor documents are not appropriate, unless you can get your word processor to save as plain text. A good text editor can make programming a lot more pleasant. Linux comes with several text editors. On Windows, you can use notepad in a pinch, but you will probably want something better. For Mac OS, you might download the free TextWrangler application. One possibility that will work on any platform is to use jedit, a good programmer’s text editor that is itself written in Java and that can be downloaded for free from www.jedit.org. To create your own programs, you should open a command line window and cd into the working directory where you will store your source code files. Start up your text editor program, such as by double-clicking its icon or selecting it from a Start menu. Type your code into the editor window, or open an existing source code file that you want to modify. Save the file. Remember that the name of a Java source code file must end in “.java”, and the rest of the file name must match the name of the class that is defined in the file. Once the file is saved in your working directory, go to the command window and use the javac command to compile it, as discussed above. If there are syntax errors in the code, they will be listed in the command window. Each error message contains the line number in the file where the computer found the error. Go back to the editor and try to fix the errors, save your changes, and they try the javac command again. (It’s usually a good idea to just work on the first few errors; sometimes fixing those will make other errors go away.) Remember that when the javac command finally succeeds, you will get no message at all. Then you can use the java command to run your program, as described above. Once you’ve compiled the program, you can run it as many times as you like without recompiling it. That’s really all there is to it: Keep both editor and command-line window open. Edit, save, and compile until you have eliminated all the syntax errors. (Always remember to save the file before compiling it—the compiler only sees the saved file, not the version in the editor window.) When you run the program, you might find that it has semantic errors that cause it to run incorrectly. It that case, you have to go back to the edit/save/compile loop to try to find and fix the problem.
- 70. 54 CHAPTER 2. NAMES AND THINGS 2.6.3 IDEs and Eclipse In an Integrated Development Environment, everything you need to create, compile, and run programs is integrated into a single package, with a graphical user interface that will be familiar to most computer users. There are many different IDEs for Java program development, ranging from fairly simple wrappers around the JDK to highly complex applications with a multitude of features. For a beginning programmer, there is a danger in using an IDE, since the difficulty of learning to use the IDE, on top of the difficulty of learning to program, can be overwhelming. Recently, however, I have begun using one IDE, Eclipse, in my introductory programming courses. Eclipse has a variety of features that are very useful for a beginning programmer. And even though it has many advanced features, its design makes it possible to use Eclipse without understanding its full complexity. It is likely that other modern IDEs have similar properties, but my only in-depth experience is with Eclipse. Eclipse is used by many professional programmers and is probably the most commonly used Java IDE. (In fact, Eclipse is actually a general development platform that can be used for other purposes besides Java development, but its most common use is Java.) Eclipse is itself written in Java. It requires Java 1.4 (or higher) to run, so it works on any computer platform that supports Java 1.4, including Linux, Windows, and recent versions of Mac OS. If you want to use Eclipse to compile and run Java 5.0 programs, you need Eclipse version 3.1 (or higher). Furthermore, Eclipse requires a JDK. You should make sure that JDK 5.0 (or higher) is installed on your computer, as described above, before you install Eclipse. Eclipse can be downloaded for free from www.eclipse.org. The first time you start Eclipse, you will be asked to specify a workspace, which is the directory where all your work will be stored. You can accept the default name, or provide one of your own. When startup is complete, the Eclipse window will be filled by a large “Welcome” screen that includes links to extensive documentation and tutorials. You can close this screen, by clicking the “X” next to the word “Welcome”; you can get back to it later by choosing “Welcome” from the “Help” menu. The Eclipse GUI consists of one large window that is divided into several sections. Each section contains one or more views. If there are several views in one section, there there will be tabs at the top of the section to select the view that is displayed in that section. Each view displays a different type of information. The whole set of views is called a perspective. Eclipse uses different perspectives, that is different sets of views of different types of information, for different tasks. The only perspective that you will need is the “Java Perspective.” Select the “Java Perspective” from the “Open Perspective” submenu of the “Window” menu. (You will only have to do this once, the first time you start Eclipse.) The Java perspective includes a large area in the center of the window where you will create and edit your Java programs. To the left of this is the Package Explorer view, which will contain a list of your Java projects and source code files. To the right is an “Outline” view which shows an outline of the file that you are currently editing; I don’t find this very useful, and I suggest that you close the Outline view by clicking the “X” next to the word Outline. Several other views that will be useful while you are compiling and running programs appear in a section of the window below the editing area. If you accidently close one of the important views, such as the Package Explorer, you can get it back by selecting it form the “Show View” submenu of the “Window” menu. ∗ ∗ ∗ To do any work in Eclipse, you need a project. To start a Java project, go to the “New” submenu in the “File” menu, and select the “Project” command. In the window that pops
- 71. 2.6. PROGRAMMING ENVIRONMENTS 55 up, make sure “Java Project” is selected, and click the “Next” button. In the next window, it should only be necessary to fill in a “Project Name” for the project and click the “Finish” button. The project should appear in the “Package Explorer” view. Click on the small triangle next to the project name to see the contents of the project. At the beginning, it contains only the “JRE System Library”; this is the collection of standard built-in classes that come with Java. To run the TextIO based examples from this textbook, you must add the source code file TextIO.java to your project. If you have downloaded the Web site of this book, you can find a copy of TextIO.java in the source directory. Alternatively, you can navigate to the file on-line and use the “Save As” command of your Web browser to save a copy of the file onto your computer. The easiest way to get TextIO into your project is to locate the source code file on your computer and drag the file icon onto the project name in the Eclipse window. If that doesn’t work, you can try using copy-and-paste: Right-click the file icon (or control-click on Mac OS), select “Copy” from the pop-up menu, right-click the project name in the Eclipse window, and select “Paste”. If you also have trouble with that, you can try using the “Import” command in the “File” menu; select “File system” in the window that pops up, click “Next”, and provide the necessary information in the next window. (Unfortunately, using the file import window is rather complicated. If you find that you have to use it, you should consult the Eclipse documentation about it.) In any case, TextIO should appear in your project, inside a package named “default package”. You will need to click the small triangle next to “default package” to see the file. Once a file is in this list, you can open it by double-clicking it; it will appear in the editing area of the Eclipse window. To run any of the Java programs from this textbook, copy the source code file into your Eclipse Java project. To run the program, right-click the file name in the Package Explorer view (or control-click in Mac OS). In the menu that pops up, go to the “Run As” submenu, and select “Java Application”. The program will be executed. If the program writes to standard output, the output will appear in the “Console” view, under the editing area. If the program uses TextIO for input, you will have to type the required input into the “Console” view—click the “Console” view before you start typing, so that the characters that you type will be sent to the correct part of the window. (Note that if you don’t like doing I/O in the “Console” view, you can use an alternative version of TextIO.java that opens a separate window for I/O. You can find this “GUI” version of TextIO in a directory named TextIO-GUI inside this textbook’s source directory.) You can have more than one program in the same Eclipse project, or you can create addi- tional projects to organize your work better. Remember to place a copy of TextIO.java in any project that requires it. ∗ ∗ ∗ To create your own Java program, you must create a new Java class. To do this, right-click the Java project name in the “Project Explorer” view. Go to the “New” submenu of the popup menu, and select “Class”. In the window that opens, type in the name of the class, and click the “Finish” button. Note that you want the name of the class, not the name of the source code file, so don’t add “.java” at the end of the name. The class should appear inside the “default package,” and it should automatically open in the editing area so that you can start typing in your program. Eclipse has several features that aid you as you type your code. It will underline any syntax error with a jagged red line, and in some cases will place an error marker in the left border of the edit window. If you hover the mouse cursor over the error marker, a description of the
- 72. 56 CHAPTER 2. NAMES AND THINGS error will appear. Note that you do not have to get rid of every error immediately as you type; some errors will go away as you type in more of the program. If an error marker displays a small “light bulb,” Eclipse is offering to try to fix the error for you. Click the light bulb to get a list of possible fixes, then double click the fix that you want to apply. For example, if you use an undeclared variable in your program, Eclipse will offer to declare it for you. You can actually use this error-correcting feature to get Eclipse to write certain types of code for you! Unfortunately, you’ll find that you won’t understand a lot of the proposed fixes until you learn more about the Java language. Another nice Eclipse feature is code assist. Code assist can be invoked by typing Control- Space. It will offer possible completions of whatever you are typing at the moment. For example, if you type part of an identifier and hit Control-Space, you will get a list of identifiers that start with the characters that you have typed; use the up and down arrow keys to select one of the items in the list, and press Return or Enter. (Or hit Escape to dismiss the list.) If there is only one possible completion when you hit Control-Space, it will be inserted automatically. By default, Code Assist will also pop up automatically, after a short delay, when you type a period or certain other characters. For example, if you type “TextIO.” and pause for just a fraction of a second, you will get a list of all the subroutines in the TextIO class. Personally, I find this auto-activation annoying. You can disable it in the Eclipse Preferences. (Look under Java / Editor / Code Assist, and turn off the “Enable auto activation” option.) You can still call up Code Assist manually with Control-Space. Once you have an error-free program, you can run it as described above, by right-clicking its name in the Package Explorer and using “Run As / Java Application”. If you find a problem when you run it, it’s very easy to go back to the editor, make changes, and run it again. Note that using Eclipse, there is no explicit “compile” command. The source code files in your project are automatically compiled, and are re-compiled whenever you modify them. Although I have only talked about Eclipse here, if you are using a different IDE, you will probably find a lot of similarities. Most IDEs use the concept of a “project” to which you have to add your source code files, and most of them have menu commands for running a program. All of them, of course, come with built-in text editors. 2.6.4 The Problem of Packages Every class in Java is contained in something called a package. Classes that are not explicitly put into a different package are in the “default” package. Almost all the examples in this textbook are in the default package, and I will not even discuss packages in any depth until Section 4.5. However, some IDEs might force you to pay attention to packages. When you create a class in Eclipse, you might notice a message that says that “The use of the default package is discouraged.” Although this is true, I have chosen to use it anyway, since it seems easier for beginning programmers to avoid the whole issue of packages, at least at first. Some IDEs might be even less willing than Eclipse to use the default package. If you create a class in a package, the source code starts with a line that specifies which package the class is in. For example, if the class is in a package named testpkg, then the first line of the source code will be package testpkg; In an IDE, this will not cause any problem unless the program you are writing depends on TextIO. You will not be able to use TextIO in a program unless TextIO is placed into the same package as the program. This means that you have to modify the source code file TextIO.java
- 73. 2.6. PROGRAMMING ENVIRONMENTS 57 to specify the package; just add a package statement using the same package name as the program. Then add the modified TextIO.java to the same folder that contains the program source code. Once you’ve done this, the example should run in the same way as if it were in the default package. By the way, if you use packages in a command-line environment, other complications arise. For example, if a class is in a package named testpkg, then the source code file must be in a subdirectory named testpkg that is inside your main Java working directory. Nevertheless, when you compile or execute the program, you should be in the main directory, not in the subdirectory. When you compile the source code file, you have to include the name of the directory in the command: Use “javac testpkg/ClassName.java” on Linux or Mac OS, or “javac testpkgClassName.java” on Windows. The command for executing the program is then “java testpkg.ClassName”, with a period separating the package name from the class name. Since packages can contain subpackages, it can get even worse than this! However, you will not need to worry about any of that when using the examples in this book.
- 74. 58 CHAPTER 2. NAMES AND THINGS Exercises for Chapter 2 1. Write a program that will print your initials to standard output in letters that are nine lines tall. Each big letter should be made up of a bunch of *’s. For example, if your initials were “DJE”, then the output would look something like: ****** ************* ********** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ******** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ***** **** ********** 2. Write a program that simulates rolling a pair of dice. You can simulate rolling one die by choosing one of the integers 1, 2, 3, 4, 5, or 6 at random. The number you pick represents the number on the die after it is rolled. As pointed out in Section 2.5, The expression (int)(Math.random()*6) + 1 does the computation you need to select a random integer between 1 and 6. You can assign this value to a variable to represent one of the dice that are being rolled. Do this twice and add the results together to get the total roll. Your program should report the number showing on each die as well as the total roll. For example: The first die comes up 3 The second die comes up 5 Your total roll is 8 3. Write a program that asks the user’s name, and then greets the user by name. Before outputting the user’s name, convert it to upper case letters. For example, if the user’s name is Fred, then the program should respond “Hello, FRED, nice to meet you!”. 4. Write a program that helps the user count his change. The program should ask how many quarters the user has, then how many dimes, then how many nickels, then how many pennies. Then the program should tell the user how much money he has, expressed in dollars. 5. If you have N eggs, then you have N/12 dozen eggs, with N%12 eggs left over. (This is essentially the definition of the / and % operators for integers.) Write a program that asks the user how many eggs she has and then tells the user how many dozen eggs she has and how many extra eggs are left over. A gross of eggs is equal to 144 eggs. Extend your program so that it will tell the user how many gross, how many dozen, and how many left over eggs she has. For example, if the user says that she has 1342 eggs, then your program would respond with Your number of eggs is 9 gross, 3 dozen, and 10
- 75. Exercises 59 since 1342 is equal to 9*144 + 3*12 + 10. 6. Suppose that a file named “testdata.txt” contains the following information: The first line of the file is the name of a student. Each of the next three lines contains an integer. The integers are the student’s scores on three exams. Write a program that will read the information in the file and display (on standard output) a message the contains the name of the student and the student’s average grade on the three exams. The average is obtained by adding up the individual exam grades and then dividing by the number of exams.
- 76. 60 CHAPTER 2. NAMES AND THINGS Quiz on Chapter 2 1. Briefly explain what is meant by the syntax and the semantics of a programming language. Give an example to illustrate the difference between a syntax error and a semantics error. 2. What does the computer do when it executes a variable declaration statement. Give an example. 3. What is a type, as this term relates to programming? 4. One of the primitive types in Java is boolean. What is the boolean type? Where are boolean values used? What are its possible values? 5. Give the meaning of each of the following Java operators: a) ++ b) && c) != 6. Explain what is meant by an assignment statement, and give an example. What are assignment statements used for? 7. What is meant by precedence of operators? 8. What is a literal? 9. In Java, classes have two fundamentally different purposes. What are they? 10. What is the difference between the statement “x = TextIO.getDouble();” and the state- ment “x = TextIO.getlnDouble();” 11. Explain why the value of the expression 2 + 3 + "test" is the string "5test" while the value of the expression "test" + 2 + 3 is the string "test23". What is the value of "test" + 2 * 3 ? 12. Integrated Development Environments such as Eclipse often use syntax coloring, which assigns various colors to the characters in a program to reflect the syntax of the language. A student notices that Eclipse colors the word String differently from int, double, and boolean. The student asks why String should be a different color, since all these words are names of types. What’s the answer to the student’s question?
- 77. Chapter 3 Programming in the Small II: Control The basic building blocks of programs—variables, expressions, assignment statements, and subroutine call statements—were covered in the previous chapter. Starting with this chapter, we look at how these building blocks can be put together to build complex programs with more interesting behavior. Since we are still working on the level of “programming in the small” in this chapter, we are interested in the kind of complexity that can occur within a single subroutine. On this level, complexity is provided by control structures. The two types of control structures, loops and branches, can be used to repeat a sequence of statements over and over or to choose among two or more possible courses of action. Java includes several control structures of each type, and we will look at each of them in some detail. This chapter will also begin the study of program design. Given a problem, how can you come up with a program to solve that problem? We’ll look at a partial answer to this question in Section 3.2. 3.1 Blocks, Loops, and Branches The ability of a computer to perform complex tasks is built on just a few ways of combining simple commands into control structures. In Java, there are just six such structures that are used to determine the normal flow of control in a program—and, in fact, just three of them would be enough to write programs to perform any task. The six control structures are: the block, the while loop, the do..while loop, the for loop, the if statement, and the switch statement. Each of these structures is considered to be a single “statement,” but each is in fact a structured statement that can contain one or more other statements inside itself. 3.1.1 Blocks The block is the simplest type of structured statement. Its purpose is simply to group a sequence of statements into a single statement. The format of a block is: { hstatementsi } 61
- 78. 62 CHAPTER 3. CONTROL That is, it consists of a sequence of statements enclosed between a pair of braces, “{” and “}”. (In fact, it is possible for a block to contain no statements at all; such a block is called an empty block, and can actually be useful at times. An empty block consists of nothing but an empty pair of braces.) Block statements usually occur inside other statements, where their purpose is to group together several statements into a unit. However, a block can be legally used wherever a statement can occur. There is one place where a block is required: As you might have already noticed in the case of the main subroutine of a program, the definition of a subroutine is a block, since it is a sequence of statements enclosed inside a pair of braces. I should probably note again at this point that Java is what is called a free-format language. There are no syntax rules about how the language has to be arranged on a page. So, for example, you could write an entire block on one line if you want. But as a matter of good programming style, you should lay out your program on the page in a way that will make its structure as clear as possible. In general, this means putting one statement per line and using indentation to indicate statements that are contained inside control structures. This is the format that I will generally use in my examples. Here are two examples of blocks: { System.out.print("The answer is "); System.out.println(ans); } { // This block exchanges the values of x and y int temp; // A temporary variable for use in this block. temp = x; // Save a copy of the value of x in temp. x = y; // Copy the value of y into x. y = temp; // Copy the value of temp into y. } In the second example, a variable, temp, is declared inside the block. This is perfectly legal, and it is good style to declare a variable inside a block if that variable is used nowhere else but inside the block. A variable declared inside a block is completely inaccessible and invisible from outside that block. When the computer executes the variable declaration statement, it allocates memory to hold the value of the variable. When the block ends, that memory is discarded (that is, made available for reuse). The variable is said to be local to the block. There is a general concept called the “scope” of an identifier. The scope of an identifier is the part of the program in which that identifier is valid. The scope of a variable defined inside a block is limited to that block, and more specifically to the part of the block that comes after the declaration of the variable. 3.1.2 The Basic While Loop The block statement by itself really doesn’t affect the flow of control in a program. The five remaining control structures do. They can be divided into two classes: loop statements and branching statements. You really just need one control structure from each category in order to have a completely general-purpose programming language. More than that is just convenience. In this section, I’ll introduce the while loop and the if statement. I’ll give the full details of these statements and of the other three control structures in later sections. A while loop is used to repeat a given statement over and over. Of course, it’s not likely that you would want to keep repeating it forever. That would be an infinite loop, which is
- 79. 3.1. BLOCKS, LOOPS, AND BRANCHES 63 generally a bad thing. (There is an old story about computer pioneer Grace Murray Hopper, who read instructions on a bottle of shampoo telling her to “lather, rinse, repeat.” As the story goes, she claims that she tried to follow the directions, but she ran out of shampoo. (In case you don’t get it, this is a joke about the way that computers mindlessly follow instructions.)) To be more specific, a while loop will repeat a statement over and over, but only so long as a specified condition remains true. A while loop has the form: while (hboolean-expressioni) hstatementi Since the statement can be, and usually is, a block, many while loops have the form: while (hboolean-expressioni) { hstatementsi } The semantics of this statement go like this: When the computer comes to a while state- ment, it evaluates the hboolean-expressioni, which yields either true or false as the value. If the value is false, the computer skips over the rest of the while loop and proceeds to the next command in the program. If the value of the expression is true, the computer executes the hstatementi or block of hstatementsi inside the loop. Then it returns to the beginning of the while loop and repeats the process. That is, it re-evaluates the hboolean-expressioni, ends the loop if the value is false, and continues it if the value is true. This will continue over and over until the value of the expression is false; if that never happens, then there will be an infinite loop. Here is an example of a while loop that simply prints out the numbers 1, 2, 3, 4, 5: int number; // The number to be printed. number = 1; // Start with 1. while ( number < 6 ) { // Keep going as long as number is < 6. System.out.println(number); number = number + 1; // Go on to the next number. } System.out.println("Done!"); The variable number is initialized with the value 1. So the first time through the while loop, when the computer evaluates the expression “number < 6”, it is asking whether 1 is less than 6, which is true. The computer therefor proceeds to execute the two statements inside the loop. The first statement prints out “1”. The second statement adds 1 to number and stores the result back into the variable number; the value of number has been changed to 2. The computer has reached the end of the loop, so it returns to the beginning and asks again whether number is less than 6. Once again this is true, so the computer executes the loop again, this time printing out 2 as the value of number and then changing the value of number to 3. It continues in this way until eventually number becomes equal to 6. At that point, the expression “number < 6” evaluates to false. So, the computer jumps past the end of the loop to the next statement and prints out the message “Done!”. Note that when the loop ends, the value of number is 6, but the last value that was printed was 5. By the way, you should remember that you’ll never see a while loop standing by itself in a real program. It will always be inside a subroutine which is itself defined inside some class. As an example of a while loop used inside a complete program, here is a little program that computes the interest on an investment over several years. This is an improvement over examples from the previous chapter that just reported the results for one year:
- 80. 64 CHAPTER 3. CONTROL public class Interest3 { /* This class implements a simple program that will compute the amount of interest that is earned on an investment over a period of 5 years. The initial amount of the investment and the interest rate are input by the user. The value of the investment at the end of each year is output. */ public static void main(String[] args) { double principal; // The value of the investment. double rate; // The annual interest rate. /* Get the initial investment and interest rate from the user. */ TextIO.put("Enter the initial investment: "); principal = TextIO.getlnDouble(); TextIO.put("Enter the annual interest rate: "); rate = TextIO.getlnDouble(); /* Simulate the investment for 5 years. */ int years; // Counts the number of years that have passed. years = 0; while (years < 5) { double interest; // Interest for this year. interest = principal * rate; principal = principal + interest; // Add it to principal. years = years + 1; // Count the current year. System.out.print("The value of the investment after "); System.out.print(years); System.out.print(" years is $"); System.out.printf("%1.2f", principal); System.out.println(); } // end of while loop } // end of main() } // end of class Interest3 You should study this program, and make sure that you understand what the computer does step-by-step as it executes the while loop. 3.1.3 The Basic If Statement An if statement tells the computer to take one of two alternative courses of action, depending on whether the value of a given boolean-valued expression is true or false. It is an example of a “branching” or “decision” statement. An if statement has the form:
- 81. 3.1. BLOCKS, LOOPS, AND BRANCHES 65 if ( hboolean-expressioni ) hstatementi else hstatementi When the computer executes an if statement, it evaluates the boolean expression. If the value is true, the computer executes the first statement and skips the statement that follows the “else”. If the value of the expression is false, then the computer skips the first statement and executes the second one. Note that in any case, one and only one of the two statements inside the if statement is executed. The two statements represent alternative courses of action; the computer decides between these courses of action based on the value of the boolean expression. In many cases, you want the computer to choose between doing something and not doing it. You can do this with an if statement that omits the else part: if ( hboolean-expressioni ) hstatementi To execute this statement, the computer evaluates the expression. If the value is true, the computer executes the hstatementi that is contained inside the if statement; if the value is false, the computer skips that hstatementi. Of course, either or both of the hstatementi’s in an if statement can be a block, so that an if statement often looks like: if ( hboolean-expressioni ) { hstatementsi } else { hstatementsi } or: if ( hboolean-expressioni ) { hstatementsi } As an example, here is an if statement that exchanges the value of two variables, x and y, but only if x is greater than y to begin with. After this if statement has been executed, we can be sure that the value of x is definitely less than or equal to the value of y: if ( x > y ) { int temp; // A temporary variable for use in this block. temp = x; // Save a copy of the value of x in temp. x = y; // Copy the value of y into x. y = temp; // Copy the value of temp into y. } Finally, here is an example of an if statement that includes an else part. See if you can figure out what it does, and why it would be used: if ( years > 1 ) { // handle case for 2 or more years System.out.print("The value of the investment after "); System.out.print(years); System.out.print(" years is $"); } else { // handle case for 1 year
- 82. 66 CHAPTER 3. CONTROL System.out.print("The value of the investment after 1 year is $"); } // end of if statement System.out.printf("%1.2f", principal); // this is done in any case I’ll have more to say about control structures later in this chapter. But you already know the essentials. If you never learned anything more about control structures, you would already know enough to perform any possible computing task. Simple looping and branching are all you really need! 3.2 Algorithm Development Programming is difficult (like many activities that are useful and worthwhile—and like most of those activities, it can also be rewarding and a lot of fun). When you write a program, you have to tell the computer every small detail of what to do. And you have to get everything exactly right, since the computer will blindly follow your program exactly as written. How, then, do people write any but the most simple programs? It’s not a big mystery, actually. It’s a matter of learning to think in the right way. A program is an expression of an idea. A programmer starts with a general idea of a task for the computer to perform. Presumably, the programmer has some idea of how to perform the task by hand, at least in general outline. The problem is to flesh out that outline into a complete, unambiguous, step-by-step procedure for carrying out the task. Such a procedure is called an “algorithm.” (Technically, an algorithm is an unambiguous, step-by-step procedure that terminates after a finite number of steps; we don’t want to count procedures that go on forever.) An algorithm is not the same as a program. A program is written in some particular programming language. An algorithm is more like the idea behind the program, but it’s the idea of the steps the program will take to perform its task, not just the idea of the task itself. The steps of the algorithm don’t have to be filled in in complete detail, as long as the steps are unambiguous and it’s clear that carrying out the steps will accomplish the assigned task. An algorithm can be expressed in any language, including English. Of course, an algorithm can only be expressed as a program if all the details have been filled in. So, where do algorithms come from? Usually, they have to be developed, often with a lot of thought and hard work. Skill at algorithm development is something that comes with practice, but there are techniques and guidelines that can help. I’ll talk here about some techniques and guidelines that are relevant to “programming in the small,” and I will return to the subject several times in later chapters. 3.2.1 Pseudocode and Stepwise Refinement When programming in the small, you have a few basics to work with: variables, assignment statements, and input/output routines. You might also have some subroutines, objects, or other building blocks that have already been written by you or someone else. (Input/output routines fall into this class.) You can build sequences of these basic instructions, and you can also combine them into more complex control structures such as while loops and if statements. Suppose you have a task in mind that you want the computer to perform. One way to proceed is to write a description of the task, and take that description as an outline of the algorithm you want to develop. Then you can refine and elaborate that description, gradually adding steps and detail, until you have a complete algorithm that can be translated directly into programming language. This method is called stepwise refinement, and it is a type of
- 83. 3.2. ALGORITHM DEVELOPMENT 67 top-down design. As you proceed through the stages of stepwise refinement, you can write out descriptions of your algorithm in pseudocode—informal instructions that imitate the structure of programming languages without the complete detail and perfect syntax of actual program code. As an example, let’s see how one might develop the program from the previous section, which computes the value of an investment over five years. The task that you want the program to perform is: “Compute and display the value of an investment for each of the next five years, where the initial investment and interest rate are to be specified by the user.” You might then write—or at least think—that this can be expanded as: Get the user’s input Compute the value of the investment after 1 year Display the value Compute the value after 2 years Display the value Compute the value after 3 years Display the value Compute the value after 4 years Display the value Compute the value after 5 years Display the value This is correct, but rather repetitive. And seeing that repetition, you might notice an opportunity to use a loop. A loop would take less typing. More important, it would be more general: Essentially the same loop will work no matter how many years you want to process. So, you might rewrite the above sequence of steps as: Get the user’s input while there are more years to process: Compute the value after the next year Display the value Following this algorithm would certainly solve the problem, but for a computer, we’ll have to be more explicit about how to “Get the user’s input,” how to “Compute the value after the next year,” and what it means to say “there are more years to process.” We can expand the step, “Get the user’s input” into Ask the user for the initial investment Read the user’s response Ask the user for the interest rate Read the user’s response To fill in the details of the step “Compute the value after the next year,” you have to know how to do the computation yourself. (Maybe you need to ask your boss or professor for clarification?) Let’s say you know that the value is computed by adding some interest to the previous value. Then we can refine the while loop to: while there are more years to process: Compute the interest Add the interest to the value Display the value As for testing whether there are more years to process, the only way that we can do that is by counting the years ourselves. This displays a very common pattern, and you should expect to use something similar in a lot of programs: We have to start with zero years, add one each
- 84. 68 CHAPTER 3. CONTROL time we process a year, and stop when we reach the desired number of years. So the while loop becomes: years = 0 while years < 5: years = years + 1 Compute the interest Add the interest to the value Display the value We still have to know how to compute the interest. Let’s say that the interest is to be computed by multiplying the interest rate by the current value of the investment. Putting this together with the part of the algorithm that gets the user’s inputs, we have the complete algorithm: Ask the user for the initial investment Read the user’s response Ask the user for the interest rate Read the user’s response years = 0 while years < 5: years = years + 1 Compute interest = value * interest rate Add the interest to the value Display the value Finally, we are at the point where we can translate pretty directly into proper programming- language syntax. We still have to choose names for the variables, decide exactly what we want to say to the user, and so forth. Having done this, we could express our algorithm in Java as: double principal, rate, interest; // declare the variables int years; System.out.print("Type initial investment: "); principal = TextIO.getlnDouble(); System.out.print("Type interest rate: "); rate = TextIO.getlnDouble(); years = 0; while (years < 5) { years = years + 1; interest = principal * rate; principal = principal + interest; System.out.println(principal); } This still needs to be wrapped inside a complete program, it still needs to be commented, and it really needs to print out more information in a nicer format for the user. But it’s essentially the same program as the one in the previous section. (Note that the pseudocode algorithm uses indentation to show which statements are inside the loop. In Java, indentation is completely ignored by the computer, so you need a pair of braces to tell the computer which statements are in the loop. If you leave out the braces, the only statement inside the loop would be “years = years + 1;". The other statements would only be executed once, after the loop ends. The nasty thing is that the computer won’t notice this error for you, like it would if you left out the parentheses around “(years < 5)”. The parentheses are required by the syntax of
- 85. 3.2. ALGORITHM DEVELOPMENT 69 the while statement. The braces are only required semantically. The computer can recognize syntax errors but not semantic errors.) One thing you should have noticed here is that my original specification of the problem— “Compute and display the value of an investment for each of the next five years”—was far from being complete. Before you start writing a program, you should make sure you have a complete specification of exactly what the program is supposed to do. In particular, you need to know what information the program is going to input and output and what computation it is going to perform. Here is what a reasonably complete specification of the problem might look like in this example: “Write a program that will compute and display the value of an investment for each of the next five years. Each year, interest is added to the value. The interest is computed by multiplying the current value by a fixed interest rate. Assume that the initial value and the rate of interest are to be input by the user when the program is run.” 3.2.2 The 3N+1 Problem Let’s do another example, working this time with a program that you haven’t already seen. The assignment here is an abstract mathematical problem that is one of my favorite programming exercises. This time, we’ll start with a more complete specification of the task to be performed: “Given a positive integer, N, define the ’3N+1’ sequence start- ing from N as follows: If N is an even number, then divide N by two; but if N is odd, then multiply N by 3 and add 1. Continue to generate numbers in this way until N becomes equal to 1. For example, starting from N = 3, which is odd, we multiply by 3 and add 1, giving N = 3*3+1 = 10. Then, since N is even, we divide by 2, giving N = 10/2 = 5. We continue in this way, stopping when we reach 1, giving the complete sequence: 3, 10, 5, 16, 8, 4, 2, 1. “Write a program that will read a positive integer from the user and will print out the 3N+1 sequence starting from that integer. The program should also count and print out the number of terms in the sequence.” A general outline of the algorithm for the program we want is: Get a positive integer N from the user; Compute, print, and count each number in the sequence; Output the number of terms; The bulk of the program is in the second step. We’ll need a loop, since we want to keep computing numbers until we get 1. To put this in terms appropriate for a while loop, we want to continue as long as the number is not 1. So, we can expand our pseudocode algorithm to: Get a positive integer N from the user; while N is not 1: Compute N = next term; Output N; Count this term; Output the number of terms;
- 86. 70 CHAPTER 3. CONTROL In order to compute the next term, the computer must take different actions depending on whether N is even or odd. We need an if statement to decide between the two cases: Get a positive integer N from the user; while N is not 1: if N is even: Compute N = N/2; else Compute N = 3 * N + 1; Output N; Count this term; Output the number of terms; We are almost there. The one problem that remains is counting. Counting means that you start with zero, and every time you have something to count, you add one. We need a variable to do the counting. (Again, this is a common pattern that you should expect to see over and over.) With the counter added, we get: Get a positive integer N from the user; Let counter = 0; while N is not 1: if N is even: Compute N = N/2; else Compute N = 3 * N + 1; Output N; Add 1 to counter; Output the counter; We still have to worry about the very first step. How can we get a positive integer from the user? If we just read in a number, it’s possible that the user might type in a negative number or zero. If you follow what happens when the value of N is negative or zero, you’ll see that the program will go on forever, since the value of N will never become equal to 1. This is bad. In this case, the problem is probably no big deal, but in general you should try to write programs that are foolproof. One way to fix this is to keep reading in numbers until the user types in a positive number: Ask user to input a positive number; Let N be the user’s response; while N is not positive: Print an error message; Read another value for N; Let counter = 0; while N is not 1: if N is even: Compute N = N/2; else Compute N = 3 * N + 1; Output N; Add 1 to counter; Output the counter; The first while loop will end only when N is a positive number, as required. (A common beginning programmer’s error is to use an if statement instead of a while statement here: “If N is not positive, ask the user to input another value.” The problem arises if the second
- 87. 3.2. ALGORITHM DEVELOPMENT 71 number input by the user is also non-positive. The if statement is only executed once, so the second input number is never tested. With the while loop, after the second number is input, the computer jumps back to the beginning of the loop and tests whether the second number is positive. If not, it asks the user for a third number, and it will continue asking for numbers until the user enters an acceptable input.) Here is a Java program implementing this algorithm. It uses the operators <= to mean “is less than or equal to” and != to mean “is not equal to.” To test whether N is even, it uses “N % 2 == 0”. All the operators used here were discussed in Section 2.5. /** * This program prints out a 3N+1 sequence starting from a positive * integer specified by the user. It also counts the number of * terms in the sequence, and prints out that number. */ public class ThreeN1 { public static void main(String[] args) { int N; // for computing terms in the sequence int counter; // for counting the terms TextIO.put("Starting point for sequence: "); N = TextIO.getlnInt(); while (N <= 0) { TextIO.put("The starting point must be positive. Please try again: "); N = TextIO.getlnInt(); } // At this point, we know that N > 0 counter = 0; while (N != 1) { if (N % 2 == 0) N = N / 2; else N = 3 * N + 1; TextIO.putln(N); counter = counter + 1; } TextIO.putln(); TextIO.put("There were "); TextIO.put(counter); TextIO.putln(" terms in the sequence."); } // end of main() } // end of class ThreeN1 Two final notes on this program: First, you might have noticed that the first term of the sequence—the value of N input by the user—is not printed or counted by this program. Is this an error? It’s hard to say. Was the specification of the program careful enough to decide? This is the type of thing that might send you back to the boss/professor for clarification. The problem (if it is one!) can be fixed easily enough. Just replace the line “counter = 0” before the while loop with the two lines:
- 88. 72 CHAPTER 3. CONTROL TextIO.putln(N); // print out initial term counter = 1; // and count it Second, there is the question of why this problem is at all interesting. Well, it’s interesting to mathematicians and computer scientists because of a simple question about the problem that they haven’t been able to answer: Will the process of computing the 3N+1 sequence finish after a finite number of steps for all possible starting values of N? Although individual sequences are easy to compute, no one has been able to answer the general question. To put this another way, no one knows whether the process of computing 3N+1 sequences can properly be called an algorithm, since an algorithm is required to terminate after a finite number of steps! (This discussion assumes that the value of N can take on arbitrarily large integer values, which is not true for a variable of type int in a Java program.) 3.2.3 Coding, Testing, Debugging It would be nice if, having developed an algorithm for your program, you could relax, press a button, and get a perfectly working program. Unfortunately, the process of turning an algorithm into Java source code doesn’t always go smoothly. And when you do get to the stage of a working program, it’s often only working in the sense that it does something. Unfortunately not what you want it to do. After program design comes coding: translating the design into a program written in Java or some other language. Usually, no matter how careful you are, a few syntax errors will creep in from somewhere, and the Java compiler will reject your program with some kind of error message. Unfortunately, while a compiler will always detect syntax errors, it’s not very good about telling you exactly what’s wrong. Sometimes, it’s not even good about telling you where the real error is. A spelling error or missing “{” on line 45 might cause the compiler to choke on line 105. You can avoid lots of errors by making sure that you really understand the syntax rules of the language and by following some basic programming guidelines. For example, I never type a “{” without typing the matching “}”. Then I go back and fill in the statements between the braces. A missing or extra brace can be one of the hardest errors to find in a large program. Always, always indent your program nicely. If you change the program, change the indentation to match. It’s worth the trouble. Use a consistent naming scheme, so you don’t have to struggle to remember whether you called that variable interestrate or interestRate. In general, when the compiler gives multiple error messages, don’t try to fix the second error message from the compiler until you’ve fixed the first one. Once the compiler hits an error in your program, it can get confused, and the rest of the error messages might just be guesses. Maybe the best advice is: Take the time to understand the error before you try to fix it. Programming is not an experimental science. When your program compiles without error, you are still not done. You have to test the program to make sure it works correctly. Remember that the goal is not to get the right output for the two sample inputs that the professor gave in class. The goal is a program that will work correctly for all reasonable inputs. Ideally, when faced with an unreasonable input, it will respond by gently chiding the user rather than by crashing. Test your program on a wide variety of inputs. Try to find a set of inputs that will test the full range of functionality that you’ve coded into your program. As you begin writing larger programs, write them in stages and test each stage along the way. You might even have to write some extra code to do the testing—for example to call a subroutine that you’ve just written. You don’t want to be faced, if you can avoid it, with 500 newly written lines of code that have an error in there somewhere.
- 89. 3.3. WHILE AND DO..WHILE 73 The point of testing is to find bugs—semantic errors that show up as incorrect behavior rather than as compilation errors. And the sad fact is that you will probably find them. Again, you can minimize bugs by careful design and careful coding, but no one has found a way to avoid them altogether. Once you’ve detected a bug, it’s time for debugging. You have to track down the cause of the bug in the program’s source code and eliminate it. Debugging is a skill that, like other aspects of programming, requires practice to master. So don’t be afraid of bugs. Learn from them. One essential debugging skill is the ability to read source code—the ability to put aside preconceptions about what you think it does and to follow it the way the computer does—mechanically, step-by-step—to see what it really does. This is hard. I can still remember the time I spent hours looking for a bug only to find that a line of code that I had looked at ten times had a “1” where it should have had an “i”, or the time when I wrote a subroutine named WindowClosing which would have done exactly what I wanted except that the computer was looking for windowClosing (with a lower case “w”). Sometimes it can help to have someone who doesn’t share your preconceptions look at your code. Often, it’s a problem just to find the part of the program that contains the error. Most programming environments come with a debugger, which is a program that can help you find bugs. Typically, your program can be run under the control of the debugger. The debugger allows you to set “breakpoints” in your program. A breakpoint is a point in the program where the debugger will pause the program so you can look at the values of the program’s variables. The idea is to track down exactly when things start to go wrong during the program’s execution. The debugger will also let you execute your program one line at a time, so that you can watch what happens in detail once you know the general area in the program where the bug is lurking. I will confess that I only rarely use debuggers myself. A more traditional approach to debugging is to insert debugging statements into your program. These are output statements that print out information about the state of the program. Typically, a debugging statement would say something like System.out.println("At start of while loop, N = "+ N); You need to be able to tell from the output where in your program the output is coming from, and you want to know the value of important variables. Sometimes, you will find that the computer isn’t even getting to a part of the program that you think it should be executing. Remember that the goal is to find the first point in the program where the state is not what you expect it to be. That’s where the bug is. And finally, remember the golden rule of debugging: If you are absolutely sure that every- thing in your program is right, and if it still doesn’t work, then one of the things that you are absolutely sure of is wrong. 3.3 The while and do..while Statements Statements in Java can be either simple statements or compound statements. Simple statements, such as assignment statements and subroutine call statements, are the basic building blocks of a program. Compound statements, such as while loops and if statements, are used to organize simple statements into complex structures, which are called control structures because they control the order in which the statements are executed. The next five sections explore the details of control structures that are available in Java, starting with the while statement and the do..while statement in this section. At the same time, we’ll look at examples of programming with each control structure and apply the techniques for designing algorithms
- 90. 74 CHAPTER 3. CONTROL that were introduced in the previous section. 3.3.1 The while Statement The while statement was already introduced in Section 3.1. A while loop has the form while ( hboolean-expressioni ) hstatementi The hstatementi can, of course, be a block statement consisting of several statements grouped together between a pair of braces. This statement is called the body of the loop. The body of the loop is repeated as long as the hboolean-expressioni is true. This boolean expression is called the continuation condition, or more simply the test, of the loop. There are a few points that might need some clarification. What happens if the condition is false in the first place, before the body of the loop is executed even once? In that case, the body of the loop is never executed at all. The body of a while loop can be executed any number of times, including zero. What happens if the condition is true, but it becomes false somewhere in the middle of the loop body? Does the loop end as soon as this happens? It doesn’t, because the computer continues executing the body of the loop until it gets to the end. Only then does it jump back to the beginning of the loop and test the condition, and only then can the loop end. Let’s look at a typical problem that can be solved using a while loop: finding the average of a set of positive integers entered by the user. The average is the sum of the integers, divided by the number of integers. The program will ask the user to enter one integer at a time. It will keep count of the number of integers entered, and it will keep a running total of all the numbers it has read so far. Here is a pseudocode algorithm for the program: Let sum = 0 Let count = 0 while there are more integers to process: Read an integer Add it to the sum Count it Divide sum by count to get the average Print out the average But how can we test whether there are more integers to process? A typical solution is to tell the user to type in zero after all the data have been entered. This will work because we are assuming that all the data are positive numbers, so zero is not a legal data value. The zero is not itself part of the data to be averaged. It’s just there to mark the end of the real data. A data value used in this way is sometimes called a sentinel value. So now the test in the while loop becomes “while the input integer is not zero”. But there is another problem! The first time the test is evaluated, before the body of the loop has ever been executed, no integer has yet been read. There is no “input integer” yet, so testing whether the input integer is zero doesn’t make sense. So, we have to do something before the while loop to make sure that the test makes sense. Setting things up so that the test in a while loop makes sense the first time it is executed is called priming the loop. In this case, we can simply read the first integer before the beginning of the loop. Here is a revised algorithm: Let sum = 0 Let count = 0 Read an integer while the integer is not zero:
- 91. 3.3. WHILE AND DO..WHILE 75 Add the integer to the sum Count it Read an integer Divide sum by count to get the average Print out the average Notice that I’ve rearranged the body of the loop. Since an integer is read before the loop, the loop has to begin by processing that integer. At the end of the loop, the computer reads a new integer. The computer then jumps back to the beginning of the loop and tests the integer that it has just read. Note that when the computer finally reads the sentinel value, the loop ends before the sentinel value is processed. It is not added to the sum, and it is not counted. This is the way it’s supposed to work. The sentinel is not part of the data. The original algorithm, even if it could have been made to work without priming, was incorrect since it would have summed and counted all the integers, including the sentinel. (Since the sentinel is zero, the sum would still be correct, but the count would be off by one. Such so-called off-by-one errors are very common. Counting turns out to be harder than it looks!) We can easily turn the algorithm into a complete program. Note that the program cannot use the statement “average = sum/count;” to compute the average. Since sum and count are both variables of type int, the value of sum/count is an integer. The average should be a real number. We’ve seen this problem before: we have to convert one of the int values to a double to force the computer to compute the quotient as a real number. This can be done by type-casting one of the variables to type double. The type cast “(double)sum” converts the value of sum to a real number, so in the program the average is computed as “average = ((double)sum) / count;”. Another solution in this case would have been to declare sum to be a variable of type double in the first place. One other issue is addressed by the program: If the user enters zero as the first input value, there are no data to process. We can test for this case by checking whether count is still equal to zero after the while loop. This might seem like a minor point, but a careful programmer should cover all the bases. Here is the program: /* * This program reads a sequence of positive integers input * by the user, and it will print out the average of those * integers. The user is prompted to enter one integer at a * time. The user must enter a 0 to mark the end of the * data. (The zero is not counted as part of the data to * be averaged.) The program does not check whether the * user’s input is positive, so it will actually work for * both positive and negative input values. */ public class ComputeAverage { public static void main(String[] args) { int inputNumber; // One of the integers input by the user. int sum; // The sum of the positive integers. int count; // The number of positive integers. double average; // The average of the positive integers. /* Initialize the summation and counting variables. */ sum = 0;
- 92. 76 CHAPTER 3. CONTROL count = 0; /* Read and process the user’s input. */ TextIO.put("Enter your first positive integer: "); inputNumber = TextIO.getlnInt(); while (inputNumber != 0) { sum += inputNumber; // Add inputNumber to running sum. count++; // Count the input by adding 1 to count. TextIO.put("Enter your next positive integer, or 0 to end: "); inputNumber = TextIO.getlnInt(); } /* Display the result. */ if (count == 0) { TextIO.putln("You didn’t enter any data!"); } else { average = ((double)sum) / count; TextIO.putln(); TextIO.putln("You entered " + count + " positive integers."); TextIO.putf("Their average is %1.3f.n", average); } } // end main() } // end class ComputeAverage 3.3.2 The do..while Statement Sometimes it is more convenient to test the continuation condition at the end of a loop, instead of at the beginning, as is done in the while loop. The do..while statement is very similar to the while statement, except that the word “while,” along with the condition that it tests, has been moved to the end. The word “do” is added to mark the beginning of the loop. A do..while statement has the form do hstatementi while ( hboolean-expressioni ); or, since, as usual, the hstatementi can be a block, do { hstatementsi } while ( hboolean-expressioni ); Note the semicolon, ’;’, at the very end. This semicolon is part of the statement, just as the semicolon at the end of an assignment statement or declaration is part of the statement. Omitting it is a syntax error. (More generally, every statement in Java ends either with a semicolon or a right brace, ’}’.) To execute a do loop, the computer first executes the body of the loop—that is, the statement or statements inside the loop—and then it evaluates the boolean expression. If the value of the expression is true, the computer returns to the beginning of the do loop and repeats the process; if the value is false, it ends the loop and continues with the next part of the program.
- 93. 3.3. WHILE AND DO..WHILE 77 Since the condition is not tested until the end of the loop, the body of a do loop is always executed at least once. For example, consider the following pseudocode for a game-playing program. The do loop makes sense here instead of a while loop because with the do loop, you know there will be at least one game. Also, the test that is used at the end of the loop wouldn’t even make sense at the beginning: do { Play a Game Ask user if he wants to play another game Read the user’s response } while ( the user’s response is yes ); Let’s convert this into proper Java code. Since I don’t want to talk about game playing at the moment, let’s say that we have a class named Checkers, and that the Checkers class contains a static member subroutine named playGame() that plays one game of checkers against the user. Then, the pseudocode “Play a game” can be expressed as the subroutine call statement “Checkers.playGame();”. We need a variable to store the user’s response. The TextIO class makes it convenient to use a boolean variable to store the answer to a yes/no question. The input function TextIO.getlnBoolean() allows the user to enter the value as “yes” or “no”. “Yes” is considered to be true, and “no” is considered to be false. So, the algorithm can be coded as boolean wantsToContinue; // True if user wants to play again. do { Checkers.playGame(); TextIO.put("Do you want to play again? "); wantsToContinue = TextIO.getlnBoolean(); } while (wantsToContinue == true); When the value of the boolean variable is set to false, it is a signal that the loop should end. When a boolean variable is used in this way—as a signal that is set in one part of the program and tested in another part—it is sometimes called a flag or flag variable (in the sense of a signal flag). By the way, a more-than-usually-pedantic programmer would sneer at the test “while (wantsToContinue == true)”. This test is exactly equivalent to “while (wantsToContinue)”. Testing whether “wantsToContinue == true” is true amounts to the same thing as testing whether “wantsToContinue” is true. A little less offensive is an expression of the form “flag == false”, where flag is a boolean variable. The value of “flag == false” is exactly the same as the value of “!flag”, where ! is the boolean negation operator. So you can write “while (!flag)” instead of “while (flag == false)”, and you can write “if (!flag)” instead of “if (flag == false)”. Although a do..while statement is sometimes more convenient than a while statement, having two kinds of loops does not make the language more powerful. Any problem that can be solved using do..while loops can also be solved using only while statements, and vice versa. In fact, if hdoSomethingi represents any block of program code, then do { hdoSomethingi } while ( hboolean-expressioni ); has exactly the same effect as
- 94. 78 CHAPTER 3. CONTROL hdoSomethingi while ( hboolean-expressioni ) { hdoSomethingi } Similarly, while ( hboolean-expressioni ) { hdoSomethingi } can be replaced by if ( hboolean-expressioni ) { do { hdoSomethingi } while ( hboolean-expressioni ); } without changing the meaning of the program in any way. 3.3.3 break and continue The syntax of the while and do..while loops allows you to test the continuation condition at either the beginning of a loop or at the end. Sometimes, it is more natural to have the test in the middle of the loop, or to have several tests at different places in the same loop. Java provides a general method for breaking out of the middle of any loop. It’s called the break statement, which takes the form break; When the computer executes a break statement in a loop, it will immediately jump out of the loop. It then continues on to whatever follows the loop in the program. Consider for example: while (true) { // looks like it will run forever! TextIO.put("Enter a positive number: "); N = TextIO.getlnInt(); if (N > 0) // input is OK; jump out of loop break; TextIO.putln("Your answer must be > 0."); } // continue here after break If the number entered by the user is greater than zero, the break statement will be executed and the computer will jump out of the loop. Otherwise, the computer will print out “Your answer must be > 0.” and will jump back to the start of the loop to read another input value. (The first line of this loop, “while (true)” might look a bit strange, but it’s perfectly legitimate. The condition in a while loop can be any boolean-valued expression. The computer evaluates this expression and checks whether the value is true or false. The boolean literal “true” is just a boolean expression that always evaluates to true. So “while (true)” can be used to write an infinite loop, or one that will be terminated by a break statement.) A break statement terminates the loop that immediately encloses the break statement. It is possible to have nested loops, where one loop statement is contained inside another. If you use a break statement inside a nested loop, it will only break out of that loop, not out of
- 95. 3.4. THE FOR STATEMENT 79 the loop that contains the nested loop. There is something called a labeled break statement that allows you to specify which loop you want to break. This is not very common, so I will go over it quickly. Labels work like this: You can put a label in front of any loop. A label consists of a simple identifier followed by a colon. For example, a while with a label might look like “mainloop: while...”. Inside this loop you can use the labeled break statement “break mainloop;” to break out of the labeled loop. For example, here is a code segment that checks whether two strings, s1 and s2, have a character in common. If a common character is found, the value of the flag variable nothingInCommon is set to false, and a labeled break is is used to end the processing at that point: boolean nothingInCommon; nothingInCommon = true; // Assume s1 and s2 have no chars in common. int i,j; // Variables for iterating through the chars in s1 and s2. i = 0; bigloop: while (i < s1.length()) { j = 0; while (j < s2.length()) { if (s1.charAt(i) == s2.charAt(j)) { // s1 and s2 have a comman char. nothingInCommon = false; break bigloop; // break out of BOTH loops } j++; // Go on to the next char in s2. } i++; //Go on to the next char in s1. } The continue statement is related to break, but less commonly used. A continue state- ment tells the computer to skip the rest of the current iteration of the loop. However, instead of jumping out of the loop altogether, it jumps back to the beginning of the loop and continues with the next iteration (including evaluating the loop’s continuation condition to see whether any further iterations are required). As with break, when a continue is in a nested loop, it will continue the loop that directly contains it; a “labeled continue” can be used to continue the containing loop instead. break and continue can be used in while loops and do..while loops. They can also be used in for loops, which are covered in the next section. In Section 3.6, we’ll see that break can also be used to break out of a switch statement. A break can occur inside an if statement, but in that case, it does not mean to break out of the if. Instead, it breaks out of the loop or switch statement that contains the if statement. If the if statement is not contained inside a loop or switch, then the if statement cannot legally contain a break. A similar consideration applies to continue statements inside ifs. 3.4 The for Statement We turn in this section to another type of loop, the for statement. Any for loop is equivalent to some while loop, so the language doesn’t get any additional power by having for statements. But for a certain type of problem, a for loop can be easier to construct and easier to read than the corresponding while loop. It’s quite possible that in real programs, for loops actually outnumber while loops.
- 96. 80 CHAPTER 3. CONTROL 3.4.1 For Loops The for statement makes a common type of while loop easier to write. Many while loops have the general form: hinitializationi while ( hcontinuation-conditioni ) { hstatementsi hupdatei } For example, consider this example, copied from an example in Section 3.2: years = 0; // initialize the variable years while ( years < 5 ) { // condition for continuing loop interest = principal * rate; // principal += interest; // do three statements System.out.println(principal); // years++; // update the value of the variable, years } This loop can be written as the following equivalent for statement: for ( years = 0; years < 5; years++ ) { interest = principal * rate; principal += interest; System.out.println(principal); } The initialization, continuation condition, and updating have all been combined in the first line of the for loop. This keeps everything involved in the “control” of the loop in one place, which helps makes the loop easier to read and understand. The for loop is executed in exactly the same way as the original code: The initialization part is executed once, before the loop begins. The continuation condition is executed before each execution of the loop, and the loop ends when this condition is false. The update part is executed at the end of each execution of the loop, just before jumping back to check the condition. The formal syntax of the for statement is as follows: for ( hinitializationi; hcontinuation-conditioni; hupdatei ) hstatementi or, using a block statement: for ( hinitializationi; hcontinuation-conditioni; hupdatei ) { hstatementsi } The hcontinuation-conditioni must be a boolean-valued expression. The hinitializationi can be any expression, but is usually an assignment statement. The hupdatei can also be any expression, but is usually an increment, a decrement, or an assignment statement. Any of the three can be empty. If the continuation condition is empty, it is treated as if it were “true,” so the loop will be repeated forever or until it ends for some other reason, such as a break statement. (Some people like to begin an infinite loop with “for (;;)” instead of “while (true)”.)
- 97. 3.4. THE FOR STATEMENT 81 Usually, the initialization part of a for statement assigns a value to some variable, and the update changes the value of that variable with an assignment statement or with an increment or decrement operation. The value of the variable is tested in the continuation condition, and the loop ends when this condition evaluates to false. A variable used in this way is called a loop control variable. In the for statement given above, the loop control variable is years. Certainly, the most common type of for loop is the counting loop, where a loop control variable takes on all integer values between some minimum and some maximum value. A counting loop has the form for ( hvariablei = hmin i; hvariablei <= hmax i; hvariablei++ ) { hstatementsi } where hmini and hmaxi are integer-valued expressions (usually constants). The hvariablei takes on the values hmini, hmini+1, hmini+2, . . . , hmaxi. The value of the loop control variable is often used in the body of the loop. The for loop at the beginning of this section is a counting loop in which the loop control variable, years, takes on the values 1, 2, 3, 4, 5. Here is an even simpler example, in which the numbers 1, 2, . . . , 10 are displayed on standard output: for ( N = 1 ; N <= 10 ; N++ ) System.out.println( N ); For various reasons, Java programmers like to start counting at 0 instead of 1, and they tend to use a “<” in the condition, rather than a “<=”. The following variation of the above loop prints out the ten numbers 0, 1, 2, . . . , 9: for ( N = 0 ; N < 10 ; N++ ) System.out.println( N ); Using < instead of <= in the test, or vice versa, is a common source of off-by-one errors in programs. You should always stop and think, Do I want the final value to be processed or not? It’s easy to count down from 10 to 1 instead of counting up. Just start with 10, decrement the loop control variable instead of incrementing it, and continue as long as the variable is greater than or equal to one. for ( N = 10 ; N >= 1 ; N-- ) System.out.println( N ); Now, in fact, the official syntax of a for statemenent actually allows both the initialization part and the update part to consist of several expressions, separated by commas. So we can even count up from 1 to 10 and count down from 10 to 1 at the same time! for ( i=1, j=10; i <= 10; i++, j-- ) { TextIO.putf("%5d", i); // Output i in a 5-character wide column. TextIO.putf("%5d", j); // Output j in a 5-character column TextIO.putln(); // and end the line. } As a final example, let’s say that we want to use a for loop that prints out just the even numbers between 2 and 20, that is: 2, 4, 6, 8, 10, 12, 14, 16, 18, 20. There are several ways to do this. Just to show how even a very simple problem can be solved in many ways, here are four different solutions (three of which would get full credit):
- 98. 82 CHAPTER 3. CONTROL (1) // There are 10 numbers to print. // Use a for loop to count 1, 2, // ..., 10. The numbers we want // to print are 2*1, 2*2, ... 2*10. for (N = 1; N <= 10; N++) { System.out.println( 2*N ); } (2) // Use a for loop that counts // 2, 4, ..., 20 directly by // adding 2 to N each time through // the loop. for (N = 2; N <= 20; N = N + 2) { System.out.println( N ); } (3) // Count off all the numbers // 2, 3, 4, ..., 19, 20, but // only print out the numbers // that are even. for (N = 2; N <= 20; N++) { if ( N % 2 == 0 ) // is N even? System.out.println( N ); } (4) // Irritate the professor with // a solution that follows the // letter of this silly assignment // while making fun of it. for (N = 1; N <= 1; N++) { System.out.print("2 4 6 8 10 12 14 16 18 20"); } Perhaps it is worth stressing one more time that a for statement, like any statement, never occurs on its own in a real program. A statement must be inside the main routine of a program or inside some other subroutine. And that subroutine must be defined inside a class. I should also remind you that every variable must be declared before it can be used, and that includes the loop control variable in a for statement. In all the examples that you have seen so far in this section, the loop control variables should be declared to be of type int. It is not required that a loop control variable be an integer. Here, for example, is a for loop in which the variable, ch, is of type char, using the fact that the ++ operator can be applied to characters as well as to numbers: // Print out the alphabet on one line of output. char ch; // The loop control variable; // one of the letters to be printed. for ( ch = ’A’; ch <= ’Z’; ch++ ) System.out.print(ch); System.out.println();
- 99. 3.4. THE FOR STATEMENT 83 3.4.2 Example: Counting Divisors Let’s look at a less trivial problem that can be solved with a for loop. If N and D are positive integers, we say that D is a divisor of N if the remainder when D is divided into N is zero. (Equivalently, we could say that N is an even multiple of D.) In terms of Java programming, D is a divisor of N if N % D is zero. Let’s write a program that inputs a positive integer, N, from the user and computes how many different divisors N has. The numbers that could possibly be divisors of N are 1, 2, . . . , N. To compute the number of divisors of N, we can just test each possible divisor of N and count the ones that actually do divide N evenly. In pseudocode, the algorithm takes the form Get a positive integer, N, from the user Let divisorCount = 0 for each number, testDivisor, in the range from 1 to N: if testDivisor is a divisor of N: Count it by adding 1 to divisorCount Output the count This algorithm displays a common programming pattern that is used when some, but not all, of a sequence of items are to be processed. The general pattern is for each item in the sequence: if the item passes the test: process it The for loop in our divisor-counting algorithm can be translated into Java code as for (testDivisor = 1; testDivisor <= N; testDivisor++) { if ( N % testDivisor == 0 ) divisorCount++; } On a modern computer, this loop can be executed very quickly. It is not impossible to run it even for the largest legal int value, 2147483647. (If you wanted to run it for even larger values, you could use variables of type long rather than int.) However, it does take a noticeable amount of time for very large numbers. So when I implemented this algorithm, I decided to output a dot every time the computer has tested one million possible divisors. In the improved version of the program, there are two types of counting going on. We have to count the number of divisors and we also have to count the number of possible divisors that have been tested. So the program needs two counters. When the second counter reaches 1000000, the program outputs a ’.’ and resets the counter to zero so that we can start counting the next group of one million. Reverting to pseudocode, the algorithm now looks like Get a positive integer, N, from the user Let divisorCount = 0 // Number of divisors found. Let numberTested = 0 // Number of possible divisors tested // since the last period was output. for each number, testDivisor, in the range from 1 to N: if testDivisor is a divisor of N: Count it by adding 1 to divisorCount Add 1 to numberTested if numberTested is 1000000: print out a ’.’ Let numberTested = 0 Output the count
- 100. 84 CHAPTER 3. CONTROL Finally, we can translate the algorithm into a complete Java program: /** * This program reads a positive integer from the user. * It counts how many divisors that number has, and * then it prints the result. */ public class CountDivisors { public static void main(String[] args) { int N; // A positive integer entered by the user. // Divisors of this number will be counted. int testDivisor; // A number between 1 and N that is a // possible divisor of N. int divisorCount; // Number of divisors of N that have been found. int numberTested; // Used to count how many possible divisors // of N have been tested. When the number // reaches 1000000, a period is output and // the value of numberTested is reset to zero. /* Get a positive integer from the user. */ while (true) { TextIO.put("Enter a positive integer: "); N = TextIO.getlnInt(); if (N > 0) break; TextIO.putln("That number is not positive. Please try again."); } /* Count the divisors, printing a "." after every 1000000 tests. */ divisorCount = 0; numberTested = 0; for (testDivisor = 1; testDivisor <= N; testDivisor++) { if ( N % testDivisor == 0 ) divisorCount++; numberTested++; if (numberTested == 1000000) { TextIO.put(’.’); numberTested = 0; } } /* Display the result. */ TextIO.putln(); TextIO.putln("The number of divisors of " + N + " is " + divisorCount); } // end main() } // end class CountDivisors
- 101. 3.4. THE FOR STATEMENT 85 3.4.3 Nested for Loops Control structures in Java are statements that contain statements. In particular, control struc- tures can contain control structures. You’ve already seen several examples of if statements inside loops, and one example of a while loop inside another while, but any combination of one control structure inside another is possible. We say that one structure is nested inside another. You can even have multiple levels of nesting, such as a while loop inside an if statement inside another while loop. The syntax of Java does not set a limit on the number of levels of nesting. As a practical matter, though, it’s difficult to understand a program that has more than a few levels of nesting. Nested for loops arise naturally in many algorithms, and it is important to understand how they work. Let’s look at a couple of examples. First, consider the problem of printing out a multiplication table like this one: 1 2 3 4 5 6 7 8 9 10 11 12 2 4 6 8 10 12 14 16 18 20 22 24 3 6 9 12 15 18 21 24 27 30 33 36 4 8 12 16 20 24 28 32 36 40 44 48 5 10 15 20 25 30 35 40 45 50 55 60 6 12 18 24 30 36 42 48 54 60 66 72 7 14 21 28 35 42 49 56 63 70 77 84 8 16 24 32 40 48 56 64 72 80 88 96 9 18 27 36 45 54 63 72 81 90 99 108 10 20 30 40 50 60 70 80 90 100 110 120 11 22 33 44 55 66 77 88 99 110 121 132 12 24 36 48 60 72 84 96 108 120 132 144 The data in the table are arranged into 12 rows and 12 columns. The process of printing them out can be expressed in a pseudocode algorithm as for each rowNumber = 1, 2, 3, ..., 12: Print the first twelve multiples of rowNumber on one line Output a carriage return The first step in the for loop can itself be expressed as a for loop. We can expand “Print the first twelve multiples of rowNumber on one line” as: for N = 1, 2, 3, ..., 12: Print N * rowNumber so a refined algorithm for printing the table has one for loop nested inside another: for each rowNumber = 1, 2, 3, ..., 12: for N = 1, 2, 3, ..., 12: Print N * rowNumber Output a carriage return We want to print the output in neat columns, with each output number taking up four spaces. This can be done using formatted output with format specifier %4d. Assuming that rowNumber and N have been declared to be variables of type int, the algorithm can be expressed in Java as for ( rowNumber = 1; rowNumber <= 12; rowNumber++ ) { for ( N = 1; N <= 12; N++ ) { // print in 4-character columns System.out.printf( "%4d;", N * rowNumber ); // No carriage return ! }
- 102. 86 CHAPTER 3. CONTROL System.out.println(); // Add a carriage return at end of the line. } This section has been weighed down with lots of examples of numerical processing. For our next example, let’s do some text processing. Consider the problem of finding which of the 26 letters of the alphabet occur in a given string. For example, the letters that occur in “Hello World” are D, E, H, L, O, R, and W. More specifically, we will write a program that will list all the letters contained in a string and will also count the number of different letters. The string will be input by the user. Let’s start with a pseudocode algorithm for the program. Ask the user to input a string Read the response into a variable, str Let count = 0 (for counting the number of different letters) for each letter of the alphabet: if the letter occurs in str: Print the letter Add 1 to count Output the count Since we want to process the entire line of text that is entered by the user, we’ll use TextIO.getln() to read it. The line of the algorithm that reads “for each letter of the al- phabet” can be expressed as “for (letter=’A’; letter<=’Z’; letter++)”. But the body of this for loop needs more thought. How do we check whether the given letter, letter, occurs in str? One idea is to look at each character in the string in turn, and check whether that character is equal to letter. We can get the i-th character of str with the function call str.charAt(i), where i ranges from 0 to str.length() - 1. One more difficulty: A letter such as ’A’ can occur in str in either upper or lower case, ’A’ or ’a’. We have to check for both of these. But we can avoid this difficulty by converting str to upper case before processing it. Then, we only have to check for the upper case letter. We can now flesh out the algorithm fully. Note the use of break in the nested for loop. It is required to avoid printing or counting a given letter more than once (in the case where it occurs more than once in the string). The break statement breaks out of the inner for loop, but not the outer for loop. Upon executing the break, the computer continues the outer loop with the next value of letter. Ask the user to input a string Read the response into a variable, str Convert str to upper case Let count = 0 for letter = ’A’, ’B’, ..., ’Z’: for i = 0, 1, ..., str.length()-1: if letter == str.charAt(i): Print letter Add 1 to count break // jump out of the loop Output the count Here is the complete program: /** * This program reads a line of text entered by the user. * It prints a list of the letters that occur in the text, * and it reports how many different letters were found. */
- 103. 3.4. THE FOR STATEMENT 87 public class ListLetters { public static void main(String[] args) { String str; // Line of text entered by the user. int count; // Number of different letters found in str. char letter; // A letter of the alphabet. TextIO.putln("Please type in a line of text."); str = TextIO.getln(); str = str.toUpperCase(); count = 0; TextIO.putln("Your input contains the following letters:"); TextIO.putln(); TextIO.put(" "); for ( letter = ’A’; letter <= ’Z’; letter++ ) { int i; // Position of a character in str. for ( i = 0; i < str.length(); i++ ) { if ( letter == str.charAt(i) ) { TextIO.put(letter); TextIO.put(’ ’); count++; break; } } } TextIO.putln(); TextIO.putln(); TextIO.putln("There were " + count + " different letters."); } // end main() } // end class ListLetters In fact, there is actually an easier way to determine whether a given letter occurs in a string, str. The built-in function str.indexOf(letter) will return -1 if letter does not occur in the string. It returns a number greater than or equal to zero if it does occur. So, we could check whether letter occurs in str simply by checking “if (str.indexOf(letter) >= 0)”. If we used this technique in the above program, we wouldn’t need a nested for loop. This gives you a preview of how subroutines can be used to deal with complexity. 3.4.4 Enums and for-each Loops Java 5.0 introduces a new “enhanced” form of the for loop that is designed to be convenient for processing data structures. A data structure is a collection of data items, considered as a unit. For example, a list is a data structure that consists simply of a sequence of items. The enhanced for loop makes it easy to apply the same processing to every element of a list or other data structure. Data structures are a major topic in computer science, but we won’t encounter them in any serious way until Chapter 7. However, one of the applications of the enhanced for loop is to enum types, and so we consider it briefly here. (Enums were introduced in Subsection 2.3.3.)
- 104. 88 CHAPTER 3. CONTROL The enhanced for loop can be used to perform the same processing on each of the enum constants that are the possible values of an enumerated type. The syntax for doing this is: for ( henum-type-namei hvariable-namei : henum-type-namei.values() ) hstatementi or for ( henum-type-namei hvariable-namei : henum-type-namei.values() ) { hstatementsi } If MyEnum is the name of any enumerated type, then MyEnum.values() is a function call that returns a list containing all of the values of the enum. (values() is a static member function in MyEnum and of any other enum.) For this enumerated type, the for loop would have the form: for ( MyEnum hvariable-namei : MyEnum.values() ) hstatementi The intent of this is to execute the hstatementi once for each of the possible values of the MyEnum type. The hvariable-namei is the loop control variable. In the hstatementi, it repre- sents the enumerated type value that is currently being processed. This variable should not be declared before the for loop; it is essentially being declared in the loop itself. To give a concrete example, suppose that the following enumerated type has been defined to represent the days of the week: enum Day { MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY } Then we could write: for ( Day d : Day.values() ) { System.out.print( d ); System.out.print(" is day number "); System.out.println( d.ordinal() ); } Day.values() represents the list containing the seven constants that make up the enumerated type. The first time through this loop, the value of d would be the first enumerated type value Day.MONDAY, which has ordinal number 0, so the output would be “MONDAY is day number 0”. The second time through the loop, the value of d would be Day.TUESDAY, and so on through Day.SUNDAY. The body of the loop is executed once for each item in the list Day.values(), with d taking on each of those values in turn. The full output from this loop would be: MONDAY is day number 0 TUESDAY is day number 1 WEDNESDAY is day number 2 THURSDAY is day number 3 FRIDAY is day number 4 SATURDAY is day number 5 SUNDAY is day number 6 Since the intent of the enhanced for loop is to do something “for each” item in a data structure, it is often called a for-each loop. The syntax for this type of loop is unfortunate. It would be better if it were written something like “foreach Day d in Day.values()”, which conveys the meaning much better and is similar to the syntax used in other programming languages for similar types of loops. It’s helpful to think of the colon (:) in the loop as meaning “in.”
- 105. 3.5. THE IF STATEMENT 89 3.5 The if Statement The first of the two branching statements in Java is the if statement, which you have already seen in Section 3.1. It takes the form if (hboolean-expressioni) hstatement-1i else hstatement-2i As usual, the statements inside an if statements can be blocks. The if statement represents a two-way branch. The else part of an if statement—consisting of the word “else” and the statement that follows it—can be omitted. 3.5.1 The Dangling else Problem Now, an if statement is, in particular, a statement. This means that either hstatement-1i or hstatement-2i in the above if statement can itself be an if statement. A problem arises, however, if hstatement-1i is an if statement that has no else part. This special case is effectively forbidden by the syntax of Java. Suppose, for example, that you type if ( x > 0 ) if (y > 0) System.out.println("First case"); else System.out.println("Second case"); Now, remember that the way you’ve indented this doesn’t mean anything at all to the computer. You might think that the else part is the second half of your “if (x > 0)” statement, but the rule that the computer follows attaches the else to “if (y > 0)”, which is closer. That is, the computer reads your statement as if it were formatted: if ( x > 0 ) if (y > 0) System.out.println("First case"); else System.out.println("Second case"); You can force the computer to use the other interpretation by enclosing the nested if in a block: if ( x > 0 ) { if (y > 0) System.out.println("First case"); } else System.out.println("Second case"); These two if statements have different meanings: In the case when x <= 0, the first statement doesn’t print anything, but the second statement prints “Second case.”. 3.5.2 The if...else if Construction Much more interesting than this technicality is the case where hstatement-2i, the else part of the if statement, is itself an if statement. The statement would look like this (perhaps without the final else part):
- 106. 90 CHAPTER 3. CONTROL if (hboolean-expression-1i) hstatement-1i else if (hboolean-expression-2i) hstatement-2i else hstatement-3i However, since the computer doesn’t care how a program is laid out on the page, this is almost always written in the format: if (hboolean-expression-1i) hstatement-1i else if (hboolean-expression-2i) hstatement-2i else hstatement-3i You should think of this as a single statement representing a three-way branch. When the computer executes this, one and only one of the three statements—hstatement-1i, hstatement- 2i, or hstatement-3i—will be executed. The computer starts by evaluating hboolean-expression- 1i. If it is true, the computer executes hstatement-1i and then jumps all the way to the end of the outer if statement, skipping the other two hstatementis. If hboolean-expression-1i is false, the computer skips hstatement-1i and executes the second, nested if statement. To do this, it tests the value of hboolean-expression-2i and uses it to decide between hstatement-2i and hstatement-3i. Here is an example that will print out one of three different messages, depending on the value of a variable named temperature: if (temperature < 50) System.out.println("It’s cold."); else if (temperature < 80) System.out.println("It’s nice."); else System.out.println("It’s hot."); If temperature is, say, 42, the first test is true. The computer prints out the message “It’s cold”, and skips the rest—without even evaluating the second condition. For a temperature of 75, the first test is false, so the computer goes on to the second test. This test is true, so the computer prints “It’s nice” and skips the rest. If the temperature is 173, both of the tests evaluate to false, so the computer says “It’s hot” (unless its circuits have been fried by the heat, that is). You can go on stringing together “else-if’s” to make multi-way branches with any number of cases: if (hboolean-expression-1i) hstatement-1i else if (hboolean-expression-2i) hstatement-2i else if (hboolean-expression-3i) hstatement-3i . . // (more cases) .
- 107. 3.5. THE IF STATEMENT 91 else if (hboolean-expression-Ni) hstatement-Ni else hstatement-(N+1)i The computer evaluates boolean expressions one after the other until it comes to one that is true. It executes the associated statement and skips the rest. If none of the boolean expressions evaluate to true, then the statement in the else part is executed. This statement is called a multi-way branch because only one of the statements will be executed. The final else part can be omitted. In that case, if all the boolean expressions are false, none of the statements is executed. Of course, each of the statements can be a block, consisting of a number of statements enclosed between { and }. (Admittedly, there is lot of syntax here; as you study and practice, you’ll become comfortable with it.) 3.5.3 If Statement Examples As an example of using if statements, lets suppose that x, y, and z are variables of type int, and that each variable has already been assigned a value. Consider the problem of printing out the values of the three variables in increasing order. For examples, if the values are 42, 17, and 20, then the output should be in the order 17, 20, 42. One way to approach this is to ask, where does x belong in the list? It comes first if it’s less than both y and z. It comes last if it’s greater than both y and z. Otherwise, it comes in the middle. We can express this with a 3-way if statement, but we still have to worry about the order in which y and z should be printed. In pseudocode, if (x < y && x < z) { output x, followed by y and z in their correct order } else if (x > y && x > z) { output y and z in their correct order, followed by x } else { output x in between y and z in their correct order } Determining the relative order of y and z requires another if statement, so this becomes if (x < y && x < z) { // x comes first if (y < z) System.out.println( x + " " + y + " " + z ); else System.out.println( x + " " + z + " " + y ); } else if (x > y && x > z) { // x comes last if (y < z) System.out.println( y + " " + z + " " + x ); else System.out.println( z + " " + y + " " + x ); } else { // x in the middle if (y < z) System.out.println( y + " " + x + " " + z); else
- 108. 92 CHAPTER 3. CONTROL System.out.println( z + " " + x + " " + y); } You might check that this code will work correctly even if some of the values are the same. If the values of two variables are the same, it doesn’t matter which order you print them in. Note, by the way, that even though you can say in English “if x is less than y and z,”, you can’t say in Java “if (x < y && z)”. The && operator can only be used between boolean values, so you have to make separate tests, x<y and x<z, and then combine the two tests with &&. There is an alternative approach to this problem that begins by asking, “which order should x and y be printed in?” Once that’s known, you only have to decide where to stick in z. This line of thought leads to different Java code: if ( x < y ) { // x comes before y if ( z < x ) // z comes first System.out.println( z + " " + x + " " + y); else if ( z > y ) // z comes last System.out.println( x + " " + y + " " + z); else // z is in the middle System.out.println( x + " " + z + " " + y); } else { // y comes before x if ( z < y ) // z comes first System.out.println( z + " " + y + " " + x); else if ( z > x ) // z comes last System.out.println( y + " " + x + " " + z); else // z is in the middle System.out.println( y + " " + z + " " + x); } Once again, we see how the same problem can be solved in many different ways. The two approaches to this problem have not exhausted all the possibilities. For example, you might start by testing whether x is greater than y. If so, you could swap their values. Once you’ve done that, you know that x should be printed before y. ∗ ∗ ∗ Finally, let’s write a complete program that uses an if statement in an interesting way. I want a program that will convert measurements of length from one unit of measurement to another, such as miles to yards or inches to feet. So far, the problem is extremely under- specified. Let’s say that the program will only deal with measurements in inches, feet, yards, and miles. It would be easy to extend it later to deal with other units. The user will type in a measurement in one of these units, such as “17 feet” or “2.73 miles”. The output will show the length in terms of each of the four units of measure. (This is easier than asking the user which units to use in the output.) An outline of the process is Read the user’s input measurement and units of measure Express the measurement in inches, feet, yards, and miles Display the four results The program can read both parts of the user’s input from the same line by using TextIO.getDouble() to read the numerical measurement and TextIO.getlnWord() to read the unit of measure. The conversion into different units of measure can be simplified by first
- 109. 3.5. THE IF STATEMENT 93 converting the user’s input into inches. From there, the number of inches can easily be con- verted into feet, yards, and miles. Before converting into inches, we have to test the input to determine which unit of measure the user has specified: Let measurement = TextIO.getDouble() Let units = TextIO.getlnWord() if the units are inches Let inches = measurement else if the units are feet Let inches = measurement * 12 // 12 inches per foot else if the units are yards Let inches = measurement * 36 // 36 inches per yard else if the units are miles Let inches = measurement * 12 * 5280 // 5280 feet per mile else The units are illegal! Print an error message and stop processing Let feet = inches / 12.0 Let yards = inches / 36.0 Let miles = inches / (12.0 * 5280.0) Display the results Since units is a String, we can use units.equals("inches") to check whether the spec- ified unit of measure is “inches”. However, it would be nice to allow the units to be spec- ified as “inch” or abbreviated to “in”. To allow these three possibilities, we can check if (units.equals("inches") || units.equals("inch") || units.equals("in")). It would also be nice to allow upper case letters, as in “Inches” or “IN”. We can do this by converting units to lower case before testing it or by substituting the function units.equalsIgnoreCase for units.equals. In my final program, I decided to make things more interesting by allowing the user to enter a whole sequence of measurements. The program will end only when the user inputs 0. To do this, I just have to wrap the above algorithm inside a while loop, and make sure that the loop ends when the user inputs a 0. Here’s the complete program: /* * This program will convert measurements expressed in inches, * feet, yards, or miles into each of the possible units of * measure. The measurement is input by the user, followed by * the unit of measure. For example: "17 feet", "1 inch", * "2.73 mi". Abbreviations in, ft, yd, and mi are accepted. * The program will continue to read and convert measurements * until the user enters an input of 0. */ public class LengthConverter { public static void main(String[] args) { double measurement; // Numerical measurement, input by user. String units; // The unit of measure for the input, also // specified by the user. double inches, feet, yards, miles; // Measurement expressed in // each possible unit of // measure.
- 110. 94 CHAPTER 3. CONTROL TextIO.putln("Enter measurements in inches, feet, yards, or miles."); TextIO.putln("For example: 1 inch 17 feet 2.73 miles"); TextIO.putln("You can use abbreviations: in ft yd mi"); TextIO.putln("I will convert your input into the other units"); TextIO.putln("of measure."); TextIO.putln(); while (true) { /* Get the user’s input, and convert units to lower case. */ TextIO.put("Enter your measurement, or 0 to end: "); measurement = TextIO.getDouble(); if (measurement == 0) break; // Terminate the while loop. units = TextIO.getlnWord(); units = units.toLowerCase(); /* Convert the input measurement to inches. */ if (units.equals("inch") || units.equals("inches") || units.equals("in")) { inches = measurement; } else if (units.equals("foot") || units.equals("feet") || units.equals("ft")) { inches = measurement * 12; } else if (units.equals("yard") || units.equals("yards") || units.equals("yd")) { inches = measurement * 36; } else if (units.equals("mile") || units.equals("miles") || units.equals("mi")) { inches = measurement * 12 * 5280; } else { TextIO.putln("Sorry, but I don’t understand "" + units + ""."); continue; // back to start of while loop } /* Convert measurement in inches to feet, yards, and miles. */ feet = inches / 12; yards = inches / 36; miles = inches / (12*5280); /* Output measurement in terms of each unit of measure. */ TextIO.putln(); TextIO.putln("That’s equivalent to:"); TextIO.putf("%12.5g", inches); TextIO.putln(" inches"); TextIO.putf("%12.5g", feet); TextIO.putln(" feet"); TextIO.putf("%12.5g", yards);
- 111. 3.5. THE IF STATEMENT 95 TextIO.putln(" yards"); TextIO.putf("%12.5g", miles); TextIO.putln(" miles"); TextIO.putln(); } // end while TextIO.putln(); TextIO.putln("OK! Bye for now."); } // end main() } // end class LengthConverter (Note that this program uses formatted output with the “g” format specifier. In this pro- gram, we have no control over how large or how small the numbers might be. It could easily make sense for the user to enter very large or very small measurements. The “g” format will print a real number in exponential form if it is very large or very small, and in the usual decimal form otherwise. Remember that in the format specification %12.5g, the 5 is the total number of significant digits that are to be printed, so we will always get the same number of signifant digits in the output, no matter what the size of the number. If we had used an “f” format specifier such as %12.5f, the output would be in decimal form with 5 digits after the decimal point. This would print the number 0.0000000007454 as 0.00000, with no significant digits at all! With the “g” format specifier, the output would be 7.454e-10.) 3.5.4 The Empty Statement As a final note in this section, I will mention one more type of statement in Java: the empty statement. This is a statement that consists simply of a semicolon and which tells the computer to do nothing. The existence of the empty statement makes the following legal, even though you would not ordinarily see a semicolon after a } : if (x < 0) { x = -x; }; The semicolon is legal after the }, but the computer considers it to be an empty statement, not part of the if statement. Occasionally, you might find yourself using the empty statement when what you mean is, in fact, “do nothing”. For example, the rather contrived if statement if ( done ) ; // Empty statement else System.out.println( "Not done yet. ); does nothing when the boolean variable done is true, and prints out “Not done yet” when it is false. You can’t just leave out the semicolon in this example, since Java syntax requires an actual statement between the if and the else. I prefer, though, to use an empty block, consisting of { and } with nothing between, for such cases. Occasionally, stray empty statements can cause annoying, hard-to-find errors in a program. For example, the following program segment prints out “Hello” just once, not ten times: for (int i = 0; i < 10; i++); System.out.println("Hello");
- 112. 96 CHAPTER 3. CONTROL Why? Because the “;” at the end of the first line is a statement, and it is this statement that is executed ten times. The System.out.println statement is not really inside the for statement at all, so it is executed just once, after the for loop has completed. 3.6 The switch Statement The second branching statement in Java is the switch statement, which is introduced in this section. The switch statement is used far less often than the if statement, but it is sometimes useful for expressing a certain type of multi-way branch. 3.6.1 The Basic switch Statement A switch statement allows you to test the value of an expression and, depending on that value, to jump directly to some location within the switch statement. Only expressions of certain types can be used. The value of the expression can be one of the primitive integer types int, short, or byte. It can be the primitive char type. Or, as we will see later in this section, it can be an enumuerated type. In particular, the expression cannot be a String or a real number. The positions that you can jump to are marked with case labels that take the form: “case hconstanti:”. This marks the position the computer jumps to when the expression evaluates to the given hconstanti. As the final case in a switch statement you can, optionally, use the label “default:”, which provides a default jump point that is used when the value of the expression is not listed in any case label. A switch statement, as it is most oftern used, has the form: switch (hexpressioni) { case hconstant-1i: hstatements-1i break; case hconstant-2i: hstatements-2i break; . . // (more cases) . case hconstant-Ni: hstatements-Ni break; default: // optional default case hstatements-(N+1)i } // end of switch statement The break statements are technically optional. The effect of a break is to make the computer jump to the end of the switch statement. If you leave out the break statement, the computer will just forge ahead after completing one case and will execute the statements associated with the next case label. This is rarely what you want, but it is legal. (I will note here—although you won’t understand it until you get to the next chapter—that inside a subroutine, the break statement is sometimes replaced by a return statement.) Note that you can leave out one of the groups of statements entirely (including the break). You then have two case labels in a row, containing two different constants. This just means
- 113. 3.6. THE SWITCH STATEMENT 97 that the computer will jump to the same place and perform the same action for each of the two constants. Here is an example of a switch statement. This is not a useful example, but it should be easy for you to follow. Note, by the way, that the constants in the case labels don’t have to be in any particular order, as long as they are all different: switch ( N ) { // (Assume N is an integer variable.) case 1: System.out.println("The number is 1."); break; case 2: case 4: case 8: System.out.println("The number is 2, 4, or 8."); System.out.println("(That’s a power of 2!)"); break; case 3: case 6: case 9: System.out.println("The number is 3, 6, or 9."); System.out.println("(That’s a multiple of 3!)"); break; case 5: System.out.println("The number is 5."); break; default: System.out.println("The number is 7 or is outside the range 1 to 9."); } The switch statement is pretty primitive as control structures go, and it’s easy to make mis- takes when you use it. Java takes all its control structures directly from the older programming languages C and C++. The switch statement is certainly one place where the designers of Java should have introduced some improvements. 3.6.2 Menus and switch Statements One application of switch statements is in processing menus. A menu is a list of options. The user selects one of the options. The computer has to respond to each possible choice in a different way. If the options are numbered 1, 2, . . . , then the number of the chosen option can be used in a switch statement to select the proper response. In a TextIO-based program, the menu can be presented as a numbered list of options, and the user can choose an option by typing in its number. Here is an example that could be used in a variation of the LengthConverter example from the previous section: int optionNumber; // Option number from menu, selected by user. double measurement; // A numerical measurement, input by the user. // The unit of measurement depends on which // option the user has selected. double inches; // The same measurement, converted into inches. /* Display menu and get user’s selected option number. */ TextIO.putln("What unit of measurement does your input use?"); TextIO.putln();
- 114. 98 CHAPTER 3. CONTROL TextIO.putln(" 1. inches"); TextIO.putln(" 2. feet"); TextIO.putln(" 3. yards"); TextIO.putln(" 4. miles"); TextIO.putln(); TextIO.putln("Enter the number of your choice: "); optionNumber = TextIO.getlnInt(); /* Read user’s measurement and convert to inches. */ switch ( optionNumber ) { case 1: TextIO.putln("Enter the number of inches: "); measurement = TextIO.getlnDouble(); inches = measurement; break; case 2: TextIO.putln("Enter the number of feet: "); measurement = TextIO.getlnDouble(); inches = measurement * 12; break; case 3: TextIO.putln("Enter the number of yards: "); measurement = TextIO.getlnDouble(); inches = measurement * 36; break; case 4: TextIO.putln("Enter the number of miles: "); measurement = TextIO.getlnDouble(); inches = measurement * 12 * 5280; break; default: TextIO.putln("Error! Illegal option number! I quit!"); System.exit(1); } // end switch /* Now go on to convert inches to feet, yards, and miles... */ 3.6.3 Enums in switch Statements The type of the expression in a switch can be an enumerated type. In that case, the constants in the case labels must be values from the enumerated type. For example, if the type of the expression is the enumerated type Season defined by enum Season { SPRING, SUMMER, FALL, WINTER } then the constants in the case label must be chosen from among the values Season.SPRING, Season.SUMMER, Season.FALL, or Season.WINTER. However, there is another quirk in the syn- tax: when an enum constant is used in a case label, only the simple name, such as “SPRING” can be used, not the full name “Season.SPRING”. Of course, the computer already knows that the value in the case label must belong to the enumerated type, since it can tell that from the type of expression used, so there is really no need to specify the type name in the constant. As an example, suppose that currentSeason is a variable of type Season. Then we could have the switch statement:
- 115. 3.6. THE SWITCH STATEMENT 99 switch ( currentSeason ) { case WINTER: // ( NOT Season.WINTER ! ) System.out.println("December, January, February"); break; case SPRING: System.out.println("March, April, May"); break; case SUMMER: System.out.println("June, July, August"); break; case FALL: System.out.println("September, October, November"); break; } 3.6.4 Definite Assignment As a somwhat more realistic example, the following switch statement makes a ran- dom choice among three possible alternatives. Recall that the value of the expression (int)(3*Math.random()) is one of the integers 0, 1, or 2, selected at random with equal probability, so the switch statement below will assign one of the values "Rock", "Scissors", "Paper" to computerMove, with probability 1/3 for each case. Although the switch statement in this example is correct, this code segment as a whole illustrates a subtle syntax error that sometimes comes up: String computerMove; switch ( (int)(3*Math.random()) ) { case 0: computerMove = "Rock"; break; case 1: computerMove = "Scissors"; break; case 2: computerMove = "Paper"; break; } System.out.println("Computer’s move is " + computerMove); // ERROR! You probably haven’t spotted the error, since it’s not an error from a human point of view. The computer reports the last line to be an error, because the variable computerMove might not have been assigned a value. In Java, it is only legal to use the value of a variable if a value has already been definitely assigned to that variable. This means that the computer must be able to prove, just from looking at the code when the program is compiled, that the variable must have been assigned a value. Unfortunately, the computer only has a few simple rules that it can apply to make the determination. In this case, it sees a switch statement in which the type of expression is int and in which the cases that are covered are 0, 1, and 2. For other values of the expression, computerMove is never assigned a value. So, the computer thinks computerMove might still be undefined after the switch statement. Now, in fact, this isn’t true: 0, 1, and 2 are actually the only possible values of the expression (int)(3*Math.random()), but the computer isn’t smart enough to figure that out. The easiest way to fix the problem is
- 116. 100 CHAPTER 3. CONTROL to replace the case label case 2 with default. The computer can see that a value is assigned to computerMove in all cases. More generally, we say that a value has been definitely assigned to a variable at a given point in a program if every execution path leading from the declaration of the variable to that point in the code includes an assignment to the variable. This rule takes into account loops and if statements as well as switch statements. For example, the following two if statements both do the same thing as the switch statement given above, but only the one on the right definitely assigns a value to computerMove: String computerMove; String computerMove; int rand; int rand; rand = (int)(3*Math.random()); rand = (int)(3*Math.random()); if ( rand == 0 ) if ( rand == 0 ) computerMove = "Rock"; computerMove = "Rock"; else if ( rand == 1 ) else if ( rand == 1 ) computerMove = "Scissors"; computerMove = "Scissors"; else if ( rand == 2 ) else computerMove = "Paper"; computerMove = "Paper"; In the code on the left, the test “if ( rand == 2 )” in the final else clause is unnecessary because if rand is not 0 or 1, the only remaining possibility is that rand == 2. The computer, however, can’t figure that out. 3.7 Introduction to Exceptions and try..catch In addition to the control structures that determine the normal flow of control in a pro- gram, Java has a way to deal with “exceptional” cases that throw the flow of control off its normal track. When an error occurs during the execution of a program, the default behavior is to terminate the program and to print an error message. However, Java makes it possible to “catch” such errors and program a response different from simply letting the program crash. This is done with the try..catch statement. In this section, we will take a preliminary, incom- plete look at using try..catch to handle errors. Error handling is a complex topic, which we will return to in Chapter 8. 3.7.1 Exceptions The term exception is used to refer to the type of error that one might want to handle with a try..catch. An exception is an exception to the normal flow of control in the program. The term is used in preference to “error” because in some cases, an exception might not be considered to be an error at all. You can sometimes think of an exception as just another way to organize a program. Exceptions in Java are represented as objects of type Exception. Actual exceptions are de- fined by subclasses of Exception. Different subclasses represent different types of exceptions We will look at only two types of exception in this section: NumberFormatException and IllegalArgu- mentException. A NumberFormatException can occur when an attempt is made to convert a string into a number. Such conversions are done by the functions Integer.parseInt and Integer.parseDouble. (See Subsection 2.5.7.) Consider the function call Integer.parseInt(str) where str is a variable of type String. If the value of str is the string "42", then the function call will correctly convert the string into the int 42. However,
- 117. 3.7. EXCEPTIONS AND TRY..CATCH 101 if the value of str is, say, "fred", the function call will fail because "fred" is not a legal string representation of an int value. In this case, an exception of type NumberFormatException occurs. If nothing is done to handle the exception, the program will crash. An IllegalArgumentException can occur when an illegal value is passed as a parameter to a subroutine. For example, if a subroutine requires that a parameter be greater than or equal to zero, an IllegalArgumentException might occur when a negative value is passed to the subroutine. How to respond to the illegal value is up to the person who wrote the subroutine, so we can’t simply say that every illegal parameter value will result in an IllegalArgumentException. However, it is a common response. One case where an IllegalArgumentException can occur is in the valueOf function of an enumerated type. Recall from Subsection 2.3.3 that this function tries to convert a string into one of the values of the enumerated type. If the string that is passed as a parameter to valueOf is not the name of one of the enumerated type’s values, then an IllegalArgumentException occurs. For example, given the enumerated type enum Toss { HEADS, TAILS } Toss.valueOf("HEADS") correctly returns the value Toss.HEADS, while Toss.valueOf("FEET") results in an IllegalArgumentException. 3.7.2 try..catch When an exception occurs, we say that the exception is “thrown”. For example, we say that Integer.parseInt(str) throws an exception of type NumberFormatException when the value of str is illegal. When an exception is thrown, it is possible to “catch” the exception and prevent it from crashing the program. This is done with a try..catch statement. In somewhat simplified form, the syntax for a try..catch is: try { hstatements-1i } catch ( hexception-class-namei hvariable-namei ) { hstatements-2i } The hexception-class-namei could be NumberFormatException, IllegalArgumentException, or some other exception class. When the computer executes this statement, it executes the state- ments in the try part. If no error occurs during the execution of hstatements-1i, then the computer just skips over the catch part and proceeds with the rest of the program. However, if an exception of type hexception-class-namei occurs during the execution of hstatements-1i, the computer immediately jumps to the catch part and executes hstatements-2i, skipping any remaining statements in hstatements-1i. During the execution of hstatements-2i, the hvariable- namei represents the exception object, so that you can, for example, print it out. At the end of the catch part, the computer proceeds with the rest of the program; the exception has been caught and handled and does not crash the program. Note that only one type of exception is caught; if some other type of exception occurs during the execution of hstatements-1i, it will crash the program as usual. (By the way, note that the braces, { and }, are part of the syntax of the try..catch statement. They are required even if there is only one statement between the braces. This is different from the other statements we have seen, where the braces around a single statement are optional.)
- 118. 102 CHAPTER 3. CONTROL As an example, suppose that str is a variable of type String whose value might or might not represent a legal real number. Then we could say: try { double x; x = Double.parseDouble(str); System.out.println( "The number is " + x ); } catch ( NumberFormatException e ) { System.out.println( "Not a legal number." ); } If an error is thrown by the call to Double.parseDouble(str), then the output statement in the try part is skipped, and the statement in the catch part is executed. It’s not always a good idea to catch exceptions and continue with the program. Often that can just lead to an even bigger mess later on, and it might be better just to let the exception crash the program at the point where it occurs. However, sometimes it’s possible to recover from an error. For example, suppose that we have the enumerated type enum Day { MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY } and we want the user to input a value belonging to this type. TextIO does not know about this type, so we can only read the user’s response as a string. The function Day.valueOf can be used to convert the user’s response to a value of type Day. This will throw an exception of type IllegalArgumentException if the user’s response is not the name of one of the values of type Day, but we can respond to the error easily enough by asking the user to enter another response. Here is a code segment that does this. (Converting the user’s response to upper case will allow responses such as “Monday” or “monday” in addition to “MONDAY”.) Day weekday; // User’s response as a value of type Day. while ( true ) { String response; // User’s response as a String. TextIO.put("Please enter a day of the week: "); response = TextIO.getln(); response = response.toUpperCase(); try { weekday = Day.valueOf(response); break; } catch ( IllegalArgumentException e ) { TextIO.putln( response + " is not the name of a day of the week." ); } } The break statement will be reached only if the user’s response is acceptable, and so the loop will end only when a legal value has been assigned to weekday. 3.7.3 Exceptions in TextIO When TextIO reads a numeric value from the user, it makes sure that the user’s response is legal, using a technique similar to the while loop and try..catch in the previous example. However, TextIO can read data from other sources besides the user. (See Subsection 2.4.5.) When it is reading from a file, there is no reasonable way for TextIO to recover from an illegal value in the input, so it responds by throwing an exception. To keep things simple, TextIO only
- 119. 3.7. EXCEPTIONS AND TRY..CATCH 103 throws exceptions of type IllegalArgumentException, no matter what type of error it encounters. For example, an exception will occur if an attempt is made to read from a file after all the data in the file has already been read. In TextIO, the exception is of type IllegalArgumentException. If you have a better response to file errors than to let the program crash, you can use a try..catch to catch exceptions of type IllegalArgumentException. For example, suppose that a file contains nothing but real numbers, and we want a program that will read the numbers and find their sum and their average. Since it is unknown how many numbers are in the file, there is the question of when to stop reading. One approach is simply to try to keep reading indefinitely. When the end of the file is reached, an exception occurs. This exception is not really an error—it’s just a way of detecting the end of the data, so we can catch the exception and finish up the program. We can read the data in a while (true) loop and break out of the loop when an exception occurs. This is an example of the somewhat unusual technique of using an exception as part of the expected flow of control in a program. To read from the file, we need to know the file’s name. To make the program more general, we can let the user enter the file name, instead of hard-coding a fixed file name in the program. However, it is possible that the user will enter the name of a file that does not exist. When we use TextIO.readfile to open a file that does not exist, an exception of type IllegalArgu- mentException occurs. We can catch this exception and ask the user to enter a different file name. Here is a complete program that uses all these ideas: /** * This program reads numbers from a file. It computes the sum and * the average of the numbers that it reads. The file should contain * nothing but numbers of type double; if this is not the case, the * output will be the sum and average of however many numbers were * successfully read from the file. The name of the file will be * input by the user. */ public class ReadNumbersFromFile { public static void main(String[] args) { while (true) { String fileName; // The name of the file, to be input by the user. TextIO.put("Enter the name of the file: "); fileName = TextIO.getln(); try { TextIO.readFile( fileName ); // Try to open the file for input. break; // If that succeeds, break out of the loop. } catch ( IllegalArgumentException e ) { TextIO.putln("Can’t read from the file "" + fileName + ""."); TextIO.putln("Please try again.n"); } } // At this point, TextIO is reading from the file. double number; // A number read from the data file. double sum; // The sum of all the numbers read so far. int count; // The number of numbers that were read. sum = 0;
- 120. 104 CHAPTER 3. CONTROL count = 0; try { while (true) { // Loop ends when an exception occurs. number = TextIO.getDouble(); count++; // This is skipped when the exception occurs sum += number; } } catch ( IllegalArgumentException e ) { // We expect this to occur when the end-of-file is encountered. // We don’t consider this to be an error, so there is nothing to do // in this catch clause. Just proceed with the rest of the program. } // At this point, we’ve read the entire file. TextIO.putln(); TextIO.putln("Number of data values read: " + count); TextIO.putln("The sum of the data values: " + sum); if ( count == 0 ) TextIO.putln("Can’t compute an average of 0 values."); else TextIO.putln("The average of the values: " + (sum/count)); } } 3.8 Introduction to GUI Programming For the past two chapters, you’ve been learning the sort of programming that is done inside a single subroutine. In the rest of the text, we’ll be more concerned with the larger scale structure of programs, but the material that you’ve already learned will be an important foundation for everything to come. In this section, before moving on to programming-in-the-large, we’ll take a look at how programming-in-the-small can be used in other contexts besides text-based, command-line- style programs. We’ll do this by taking a short, introductory look at applets and graphical programming. An applet is a Java program that runs on a Web page. An applet is not a stand-alone application, and it does not have a main() routine. In fact, an applet is an object rather than a class. When Java first appeared on the scene, applets were one of its major appeals. Since then, they have become less important, although they can still be very useful. When we study GUI programming in Chapter 6, we will concentrate on stand-alone GUI programs rather than on applets, but applets are a good place to start for our first look at the subject. When an applet is placed on a Web page, it is assigned a rectangular area on the page. It is the job of the applet to draw the contents of that rectangle. When the region needs to be drawn, the Web page calls a subroutine in the applet to do so. This is not so different from what happens with stand-alone programs. When such a program needs to be run, the system calls the main() routine of the program. Similarly, when an applet needs to be drawn, the Web page calls the paint() routine of the applet. The programmer specifies what happens when these routines are called by filling in the bodies of the routines. Programming in the
- 121. 3.8. GUI PROGRAMMING 105 small! Applets can do other things besides draw themselves, such as responding when the user clicks the mouse on the applet. Each of the applet’s behaviors is defined by a subroutine. The programmer specifies how the applet behaves by filling in the bodies of the appropriate subroutines. A very simple applet, which does nothing but draw itself, can be defined by a class that contains nothing but a paint() routine. The source code for the class would then have the form: import java.awt.*; import java.applet.*; public class hname-of-appleti extends Applet { public void paint(Graphics g) { hstatementsi } } where hname-of-appleti is an identifier that names the class, and the hstatementsi are the code that actually draws the applet. This looks similar to the definition of a stand-alone program, but there are a few things here that need to be explained, starting with the first two lines. When you write a program, there are certain built-in classes that are available for you to use. These built-in classes include System and Math. If you want to use one of these classes, you don’t have to do anything special. You just go ahead and use it. But Java also has a large number of standard classes that are there if you want them but that are not automatically available to your program. (There are just too many of them.) If you want to use these classes in your program, you have to ask for them first. The standard classes are grouped into so-called “packages.” Two of these packages are called “java.awt” and “java.applet”. The directive “import java.awt.*;” makes all the classes from the package java.awt available for use in your program. The java.awt package contains classes related to graphical user interface programming, including a class called Graphics. The Graphics class is referred to in the paint() routine above. The java.applet package contains classes specifically related to applets, including the class named Applet. The first line of the class definition above says that the class “extends Applet.” Applet is a standard class that is defined in the java.applet package. It defines all the basic properties and behaviors of applet objects. By extending the Applet class, the new class we are defining inherits all those properties and behaviors. We only have to define the ways in which our class differs from the basic Applet class. In our case, the only difference is that our applet will draw itself differently, so we only have to define the paint() routine that does the drawing. This is one of the main advantages of object-oriented programming. (Actually, in the future, our applets will be defined to extend JApplet rather than Applet. The JApplet class is itself an extension of Applet. The Applet class has existed since the original version of Java, while JApplet is part of the newer “Swing” set of graphical user interface components. For the moment, the distinction is not important.) One more thing needs to be mentioned—and this is a point where Java’s syntax gets un- fortunately confusing. Applets are objects, not classes. Instead of being static members of a class, the subroutines that define the applet’s behavior are part of the applet object. We say that they are “non-static” subroutines. Of course, objects are related to classes because every object is described by a class. Now here is the part that can get confusing: Even though a non-static subroutine is not actually part of a class (in the sense of being part of the behavior
- 122. 106 CHAPTER 3. CONTROL of the class), it is nevertheless defined in a class (in the sense that the Java code that defines the subroutine is part of the Java code that defines the class). Many objects can be described by the same class. Each object has its own non-static subroutine. But the common definition of those subroutines—the actual Java source code—is physically part of the class that describes all the objects. To put it briefly: static subroutines in a class definition say what the class does; non-static subroutines say what all the objects described by the class do. An applet’s paint() routine is an example of a non-static subroutine. A stand-alone program’s main() routine is an example of a static subroutine. The distinction doesn’t really matter too much at this point: When working with stand-alone programs, mark everything with the reserved word, “static”; leave it out when working with applets. However, the distinction between static and non-static will become more important later in the course. ∗ ∗ ∗ Let’s write an applet that draws something. In order to write an applet that draws some- thing, you need to know what subroutines are available for drawing, just as in writing text- oriented programs you need to know what subroutines are available for reading and writing text. In Java, the built-in drawing subroutines are found in objects of the class Graphics, one of the classes in the java.awt package. In an applet’s paint() routine, you can use the Graphics object g for drawing. (This object is provided as a parameter to the paint() routine when that routine is called.) Graphics objects contain many subroutines. I’ll mention just three of them here. You’ll encounter more of them in Chapter 6. • g.setColor(c), is called to set the color that is used for drawing. The parameter, c is an object belonging to a class named Color, another one of the classes in the java.awt package. About a dozen standard colors are available as static member variables in the Color class. These standard colors include Color.BLACK, Color.WHITE, Color.RED, Color.GREEN, and Color.BLUE. For example, if you want to draw in red, you would say “g.setColor(Color.RED);”. The specified color is used for all subsequent drawing oper- ations up until the next time setColor is called. • g.drawRect(x,y,w,h) draws the outline of a rectangle. The parameters x, y, w, and h must be integer-valued expressions. This subroutine draws the outline of the rectangle whose top-left corner is x pixels from the left edge of the applet and y pixels down from the top of the applet. The width of the rectangle is w pixels, and the height is h pixels. • g.fillRect(x,y,w,h) is similar to drawRect except that it fills in the inside of the rect- angle instead of just drawing an outline. This is enough information to write an applet that will draw the following image on a Web page:
- 123. 3.8. GUI PROGRAMMING 107 The applet first fills its entire rectangular area with red. Then it changes the drawing color to black and draws a sequence of rectangles, where each rectangle is nested inside the previous one. The rectangles can be drawn with a while loop. Each time through the loop, the rectangle gets smaller and it moves down and over a bit. We’ll need variables to hold the width and height of the rectangle and a variable to record how far the top-left corner of the rectangle is inset from the edges of the applet. The while loop ends when the rectangle shrinks to nothing. In general outline, the algorithm for drawing the applet is Set the drawing color to red (using the g.setColor subroutine) Fill in the entire applet (using the g.fillRect subroutine) Set the drawing color to black Set the top-left corner inset to be 0 Set the rectangle width and height to be as big as the applet while the width and height are greater than zero: draw a rectangle (using the g.drawRect subroutine) increase the inset decrease the width and the height In my applet, each rectangle is 15 pixels away from the rectangle that surrounds it, so the inset is increased by 15 each time through the while loop. The rectangle shrinks by 15 pixels on the left and by 15 pixels on the right, so the width of the rectangle shrinks by 30 each time through the loop. The height also shrinks by 30 pixels each time through the loop. It is not hard to code this algorithm into Java and use it to define the paint() method of an applet. I’ve assumed that the applet has a height of 160 pixels and a width of 300 pixels. The size is actually set in the source code of the Web page where the applet appears. In order for an applet to appear on a page, the source code for the page must include a command that specifies which applet to run and how big it should be. (We’ll see how to do that later.) It’s not a great idea to assume that we know how big the applet is going to be. On the other hand, it’s also not a great idea to write an applet that does nothing but draw a static picture. I’ll address both these issues before the end of this section. But for now, here is the source code for the applet: import java.awt.*; import java.applet.Applet; public class StaticRects extends Applet { public void paint(Graphics g) { // Draw a set of nested black rectangles on a red background. // Each nested rectangle is separated by 15 pixels on // all sides from the rectangle that encloses it. int inset; // Gap between borders of applet // and one of the rectangles. int rectWidth, rectHeight; // The size of one of the rectangles. g.setColor(Color.red); g.fillRect(0,0,300,160); // Fill the entire applet with red. g.setColor(Color.black); // Draw the rectangles in black. inset = 0; rectWidth = 299; // Set size of first rect to size of applet.
- 124. 108 CHAPTER 3. CONTROL rectHeight = 159; while (rectWidth >= 0 && rectHeight >= 0) { g.drawRect(inset, inset, rectWidth, rectHeight); inset += 15; // Rects are 15 pixels apart. rectWidth -= 30; // Width decreases by 15 pixels // on left and 15 on right. rectHeight -= 30; // Height decreases by 15 pixels // on top and 15 on bottom. } } // end paint() } // end class StaticRects (You might wonder why the initial rectWidth is set to 299, instead of to 300, since the width of the applet is 300 pixels. It’s because rectangles are drawn as if with a pen whose nib hangs below and to the right of the point where the pen is placed. If you run the pen exactly along the right edge of the applet, the line it draws is actually outside the applet and therefore is not seen. So instead, we run the pen along a line one pixel to the left of the edge of the applet. The same reasoning applies to rectHeight. Careful graphics programming demands attention to details like these.) ∗ ∗ ∗ When you write an applet, you get to build on the work of the people who wrote the Applet class. The Applet class provides a framework on which you can hang your own work. Any programmer can create additional frameworks that can be used by other programmers as a basis for writing specific types of applets or stand-alone programs. I’ve written a small framework that makes it possible to write applets that display simple animations. One example that we will consider is an animated version of the nested rectangles applet from earlier in this section. You can see the applet in action at the bottom of the on-line version of this page. A computer animation is really just a sequence of still images. The computer displays the images one after the other. Each image differs a bit from the preceding image in the sequence. If the differences are not too big and if the sequence is displayed quickly enough, the eye is tricked into perceiving continuous motion. In the example, rectangles shrink continually towards the center of the applet, while new rectangles appear at the edge. The perpetual motion is, of course, an illusion. If you think about it, you’ll see that the applet loops through the same set of images over and over. In each image, there is a gap between the borders of the applet and the outermost rectangle. This gap gets wider and wider until a new rectangle appears at the border. Only it’s not a new rectangle. What has really happened is that the applet has started over again with the first image in the sequence. The problem of creating an animation is really just the problem of drawing each of the still images that make up the animation. Each still image is called a frame. In my framework for animation, which is based on a non-standard class called SimpleAnimationApplet2, all you have to do is fill in the code that says how to draw one frame. The basic format is as follows: import java.awt.*; public class hname-of-classi extends SimpleAnimationApplet2 { public void drawFrame(Graphics g) { hstatementsi // to draw one frame of the animation
- 125. 3.8. GUI PROGRAMMING 109 } } The “import java.awt.*;” is required to get access to graphics-related classes such as Graphics and Color. You get to fill in any name you want for the class, and you get to fill in the statements inside the subroutine. The drawFrame() subroutine will be called by the system each time a frame needs to be drawn. All you have to do is say what happens when this subroutine is called. Of course, you have to draw a different picture for each frame, and to do that you need to know which frame you are drawing. The class SimpleAnimationApplet2 provides a function named getFrameNumber() that you can call to find out which frame to draw. This function returns an integer value that represents the frame number. If the value returned is 0, you are supposed to draw the first frame; if the value is 1, you are supposed to draw the second frame, and so on. In the sample applet, the thing that differs from one frame to another is the distance between the edges of the applet and the outermost rectangle. Since the rectangles are 15 pixels apart, this distance increases from 0 to 14 and then jumps back to 0 when a “new” rectangle appears. The appropriate value can be computed very simply from the frame number, with the statement “inset = getFrameNumber() % 15;”. The value of the expression getFrameNumber() % 15 is between 0 and 14. When the frame number reaches 15 or any multiple of 15, the value of getFrameNumber() % 15 jumps back to 0. Drawing one frame in the sample animated applet is very similar to drawing the single image of the StaticRects applet, as given above. The paint() method in the StaticRects applet becomes, with only minor modification, the drawFrame() method of my MovingRects animation applet. I’ve chosen to make one improvement: The StaticRects applet assumes that the applet is 300 by 160 pixels. The MovingRects applet will work for any applet size. To implement this, the drawFrame() routine has to know how big the applet is. There are two functions that can be called to get this information. The function getWidth() returns an integer value representing the width of the applet, and the function getHeight() returns the height. The width and height, together with the frame number, are used to compute the size of the first rectangle that is drawn. Here is the complete source code: import java.awt.*; public class MovingRects extends SimpleAnimationApplet2 { public void drawFrame(Graphics g) { // Draw one frame in the animation by filling in the background // with a solid red and then drawing a set of nested black // rectangles. The frame number tells how much the first // rectangle is to be inset from the borders of the applet. int width; // Width of the applet, in pixels. int height; // Height of the applet, in pixels. int inset; // Gap between borders of applet and a rectangle. // The inset for the outermost rectangle goes // from 0 to 14 then back to 0, and so on, // as the frameNumber varies. int rectWidth, rectHeight; // The size of one of the rectangles. width = getWidth(); // Find out the size of the drawing area.
- 126. 110 CHAPTER 3. CONTROL height = getHeight(); g.setColor(Color.red); // Fill the frame with red. g.fillRect(0,0,width,height); g.setColor(Color.black); // Switch color to black. inset = getFrameNumber() % 15; // Get the inset for the // outermost rect. rectWidth = width - 2*inset - 1; // Set size of outermost rect. rectHeight = height - 2*inset - 1; while (rectWidth >= 0 && rectHeight >= 0) { g.drawRect(inset,inset,rectWidth,rectHeight); inset += 15; // Rects are 15 pixels apart. rectWidth -= 30; // Width decreases by 15 pixels // on left and 15 on right. rectHeight -= 30; // Height decreases by 15 pixels // on top and 15 on bottom. } } // end drawFrame() } // end class MovingRects The main point here is that by building on an existing framework, you can do interesting things using the type of local, inside-a-subroutine programming that was covered in Chapter 2 and Chapter 3. As you learn more about programming and more about Java, you’ll be able to do more on your own—but no matter how much you learn, you’ll always be dependent on other people’s work to some extent.
- 127. Exercises 111 Exercises for Chapter 3 1. How many times do you have to roll a pair of dice before they come up snake eyes? You could do the experiment by rolling the dice by hand. Write a computer program that simulates the experiment. The program should report the number of rolls that it makes before the dice come up snake eyes. (Note: “Snake eyes” means that both dice show a value of 1.) Exercise 2.2 explained how to simulate rolling a pair of dice. 2. Which integer between 1 and 10000 has the largest number of divisors, and how many divisors does it have? Write a program to find the answers and print out the results. It is possible that several integers in this range have the same, maximum number of divisors. Your program only has to print out one of them. Subsection 3.4.2 discussed divisors. The source code for that example is CountDivisors.java. You might need some hints about how to find a maximum value. The basic idea is to go through all the integers, keeping track of the largest number of divisors that you’ve seen so far. Also, keep track of the integer that had that number of divisors. 3. Write a program that will evaluate simple expressions such as 17 + 3 and 3.14159 * 4.7. The expressions are to be typed in by the user. The input always consist of a number, followed by an operator, followed by another number. The operators that are allowed are +, -, *, and /. You can read the numbers with TextIO.getDouble() and the operator with TextIO.getChar(). Your program should read an expression, print its value, read another expression, print its value, and so on. The program should end when the user enters 0 as the first number on the line. 4. Write a program that reads one line of input text and breaks it up into words. The words should be output one per line. A word is defined to be a sequence of letters. Any characters in the input that are not letters should be discarded. For example, if the user inputs the line He said, "That’s not a good idea." then the output of the program should be He said that s not a good idea An improved version of the program would list “that’s” as a single word. An apostrophe can be considered to be part of a word if there is a letter on each side of the apostrophe. To test whether a character is a letter, you might use (ch >= ’a’ && ch <= ’z’) || (ch >= ’A’ && ch <= ’Z’). However, this only works in English and similar languages. A better choice is to call the standard function Character.isLetter(ch), which returns a boolean value of true if ch is a letter and false if it is not. This works for any Unicode character.
- 128. 112 CHAPTER 3. CONTROL 5. Suppose that a file contains information about sales figures for a company in various cities. Each line of the file contains a city name, followed by a colon (:) followed by the data for that city. The data is a number of type double. However, for some cities, no data was available. In these lines, the data is replaced by a comment explaining why the data is missing. For example, several lines from the file might look like: San Francisco: 19887.32 Chicago: no report received New York: 298734.12 Write a program that will compute and print the total sales from all the cities together. The program should also report the number of cities for which data was not available. The name of the file is “sales.dat”. To complete this program, you’ll need one fact about file input with TextIO that was not covered in Subsection 2.4.5. Since you don’t know in advance how many lines there are in the file, you need a way to tell when you have gotten to the end of the file. When TextIO is reading from a file, the function TextIO.eof() can be used to test for end of file. This boolean-valued function returns true if the file has been entirely read and returns false if there is more data to read in the file. This means that you can read the lines of the file in a loop while (TextIO.eof() == false).... The loop will end when all the lines of the file have been read. Suggestion: For each line, read and ignore characters up to the colon. Then read the rest of the line into a variable of type String. Try to convert the string into a number, and use try..catch to test whether the conversion succeeds. 6. Write an applet that draws a checkerboard. Assume that the size of the applet is 160 by 160 pixels. Each square in the checkerboard is 20 by 20 pixels. The checkerboard contains 8 rows of squares and 8 columns. The squares are red and black. Here is a tricky way to determine whether a given square is red or black: If the row number and the column number are either both even or both odd, then the square is red. Otherwise, it is black. Note that a square is just a rectangle in which the height is equal to the width, so you can use the subroutine g.fillRect() to draw the squares. Here is an image of the checkerboard: (To run an applet, you need a Web page to display it. A very simple page will do. Assume that your applet class is called Checkerboard, so that when you compile it you get a class file named Checkerboard.class Make a file that contains only the lines:
- 129. Exercises 113 <applet code="Checkerboard.class" width=160 height=160> </applet> Call this file Checkerboard.html. This is the source code for a simple Web page that shows nothing but your applet. You can open the file in a Web browser or with Sun’s appletviewer program. The compiled class file, Checkerboard.class, must be in the same directory with the Web-page file, Checkerboard.html. (If you are using the Eclipse Integrated Development Environment, you can simply right-click the name of the source code file in the Package Explorer. In the pop-up menu, go to “Run As” then to “Java Applet”. This will open the window in which the applet appears. The default size for the window is bigger than 160-by-160, so the drawing of the checkerboard will not fill the entire window.) 7. Write an animation applet that shows a checkerboard pattern in which the even numbered rows slide to the left while the odd numbered rows slide to the right. You can assume that the applet is 160 by 160 pixels. Each row should be offset from its usual position by the amount getFrameNumber() % 40. Hints: Anything you draw outside the boundaries of the applet will be invisible, so you can draw more than 8 squares in a row. You can use negative values of x in g.fillRect(x,y,w,h). (Before trying to do this exercise, it would be a good idea to look at a working applet, which can be found in the on-line version of this book.) Your applet will extend the non-standard class, SimpleAnimationApplet2, which was introduced in Section 3.8. The compiled class files, SimpleAnimationApplet2.class and SimpleAnimationApplet2$1.class, must be in the same directory as your Web-page source file along with the compiled class file for your own class. These files are produced when you compile SimpleAnimationApplet2.java. Assuming that the name of your class is SlidingCheckerboard, then the source file for the Web page should contain the lines: <applet code="SlidingCheckerboard.class" width=160 height=160> </applet>
- 130. 114 CHAPTER 3. CONTROL Quiz on Chapter 3 1. What is an algorithm? 2. Explain briefly what is meant by “pseudocode” and how is it useful in the development of algorithms. 3. What is a block statement? How are block statements used in Java programs? 4. What is the main difference between a while loop and a do..while loop? 5. What does it mean to prime a loop? 6. Explain what is meant by an animation and how a computer displays an animation. 7. Write a for loop that will print out all the multiples of 3 from 3 to 36, that is: 3 6 9 12 15 18 21 24 27 30 33 36. 8. Fill in the following main() routine so that it will ask the user to enter an integer, read the user’s response, and tell the user whether the number entered is even or odd. (You can use TextIO.getInt() to read the integer. Recall that an integer n is even if n % 2 == 0.) public static void main(String[] args) { // Fill in the body of this subroutine! } 9. Suppose that s1 and s2 are variables of type String, whose values are expected to be string representations of values of type int. Write a code segment that will compute and print the integer sum of those values, or will print an error message if the values cannot successfully be converted into integers. (Use a try..catch statement.) 10. Show the exact output that would be produced by the following main() routine: public static void main(String[] args) { int N; N = 1; while (N <= 32) { N = 2 * N; System.out.println(N); } } 11. Show the exact output produced by the following main() routine: public static void main(String[] args) { int x,y; x = 5; y = 1; while (x > 0) { x = x - 1; y = y * x; System.out.println(y); } }
- 131. Quiz 115 12. What output is produced by the following program segment? Why? (Recall that name.charAt(i) is the i-th character in the string, name.) String name; int i; boolean startWord; name = "Richard M. Nixon"; startWord = true; for (i = 0; i < name.length(); i++) { if (startWord) System.out.println(name.charAt(i)); if (name.charAt(i) == ’ ’) startWord = true; else startWord = false; }
- 132. 116 CHAPTER 3. CONTROL
- 133. Chapter 4 Programming in the Large I: Subroutines One way to break up a complex program into manageable pieces is to use subroutines. A subroutine consists of the instructions for carrying out a certain task, grouped together and given a name. Elsewhere in the program, that name can be used as a stand-in for the whole set of instructions. As a computer executes a program, whenever it encounters a subroutine name, it executes all the instructions necessary to carry out the task associated with that subroutine. Subroutines can be used over and over, at different places in the program. A subroutine can even be used inside another subroutine. This allows you to write simple subroutines and then use them to help write more complex subroutines, which can then be used in turn in other subroutines. In this way, very complex programs can be built up step-by-step, where each step in the construction is reasonably simple. As mentioned in Section 3.8, subroutines in Java can be either static or non-static. This chapter covers static subroutines only. Non-static subroutines, which are used in true object- oriented programming, will be covered in the next chapter. 4.1 Black Boxes A subroutine consists of instructions for performing some task, chunked together and given a name. “Chunking” allows you to deal with a potentially very complicated task as a single concept. Instead of worrying about the many, many steps that the computer might have to go though to perform that task, you just need to remember the name of the subroutine. Whenever you want your program to perform the task, you just call the subroutine. Subroutines are a major tool for dealing with complexity. A subroutine is sometimes said to be a “black box” because you can’t see what’s “inside” it (or, to be more precise, you usually don’t want to see inside it, because then you would have to deal with all the complexity that the subroutine is meant to hide). Of course, a black box that has no way of interacting with the rest of the world would be pretty useless. A black box needs some kind of interface with the rest of the world, which allows some interaction between what’s inside the box and what’s outside. A physical black box might have buttons on the outside that you can push, dials that you can set, and slots that can be used for passing information back and forth. Since we are trying to hide complexity, not create it, we have the first rule of black boxes: 117
- 134. 118 CHAPTER 4. SUBROUTINES The interface of a black box should be fairly straight- forward, well-defined, and easy to understand. Are there any examples of black boxes in the real world? Yes; in fact, you are surrounded by them. Your television, your car, your VCR, your refrigerator. . . . You can turn your television on and off, change channels, and set the volume by using elements of the television’s interface— dials, remote control, don’t forget to plug in the power—without understanding anything about how the thing actually works. The same goes for a VCR, although if the stories are true about how hard people find it to set the time on a VCR, then maybe the VCR violates the simple interface rule. Now, a black box does have an inside—the code in a subroutine that actually performs the task, all the electronics inside your television set. The inside of a black box is called its implementation. The second rule of black boxes is that: To use a black box, you shouldn’t need to know any- thing about its implementation; all you need to know is its interface. In fact, it should be possible to change the implementation, as long as the behavior of the box, as seen from the outside, remains unchanged. For example, when the insides of TV sets went from using vacuum tubes to using transistors, the users of the sets didn’t even need to know about it—or even know what it means. Similarly, it should be possible to rewrite the inside of a subroutine, to use more efficient code, for example, without affecting the programs that use that subroutine. Of course, to have a black box, someone must have designed and built the implementation in the first place. The black box idea works to the advantage of the implementor as well as of the user of the black box. After all, the black box might be used in an unlimited number of different situations. The implementor of the black box doesn’t need to know about any of that. The implementor just needs to make sure that the box performs its assigned task and interfaces correctly with the rest of the world. This is the third rule of black boxes: The implementor of a black box should not need to know anything about the larger systems in which the box will be used. In a way, a black box divides the world into two parts: the inside (implementation) and the outside. The interface is at the boundary, connecting those two parts. ∗ ∗ ∗ By the way, you should not think of an interface as just the physical connection between the box and the rest of the world. The interface also includes a specification of what the box does and how it can be controlled by using the elements of the physical interface. It’s not enough to say that a TV set has a power switch; you need to specify that the power switch is used to turn the TV on and off! To put this in computer science terms, the interface of a subroutine has a semantic as well as a syntactic component. The syntactic part of the interface tells you just what you have to type in order to call the subroutine. The semantic component specifies exactly what task the subroutine will accomplish. To write a legal program, you need to know the syntactic specification of the subroutine. To understand the purpose of the subroutine and to use it effectively, you need to know the subroutine’s semantic specification. I will refer to both parts of the interface—syntactic and semantic—collectively as the contract of the subroutine.
- 135. 4.2. STATIC SUBROUTINES AND VARIABLES 119 The contract of a subroutine says, essentially, “Here is what you have to do to use me, and here is what I will do for you, guaranteed.” When you write a subroutine, the comments that you write for the subroutine should make the contract very clear. (I should admit that in practice, subroutines’ contracts are often inadequately specified, much to the regret and annoyance of the programmers who have to use them.) For the rest of this chapter, I turn from general ideas about black boxes and subroutines in general to the specifics of writing and using subroutines in Java. But keep the general ideas and principles in mind. They are the reasons that subroutines exist in the first place, and they are your guidelines for using them. This should be especially clear in Section 4.6, where I will discuss subroutines as a tool in program development. ∗ ∗ ∗ You should keep in mind that subroutines are not the only example of black boxes in programming. For example, a class is also a black box. We’ll see that a class can have a “public” part, representing its interface, and a “private” part that is entirely inside its hidden implementation. All the principles of black boxes apply to classes as well as to subroutines. 4.2 Static Subroutines and Static Variables Every subroutine in Java must be defined inside some class. This makes Java rather unusual among programming languages, since most languages allow free-floating, independent subroutines. One purpose of a class is to group together related subroutines and variables. Perhaps the designers of Java felt that everything must be related to something. As a less philosophical motivation, Java’s designers wanted to place firm controls on the ways things are named, since a Java program potentially has access to a huge number of subroutines created by many different programmers. The fact that those subroutines are grouped into named classes (and classes are grouped into named “packages”) helps control the confusion that might result from so many different names. A subroutine that is a member of a class is often called a method, and “method” is the term that most people prefer for subroutines in Java. I will start using the term “method” occasionally; however, I will continue to prefer the more general term “subroutine” for static subroutines. I will use the term “method” most often to refer to non-static subroutines, which belong to objects rather than to classes. This chapter will deal with static subroutines almost exclusively. We’ll turn to non-static methods and object-oriented programming in the next chapter. 4.2.1 Subroutine Definitions A subroutine definition in Java takes the form: hmodifiersi hreturn-typei hsubroutine-namei ( hparameter-listi ) { hstatementsi } It will take us a while—most of the chapter—to get through what all this means in detail. Of course, you’ve already seen examples of subroutines in previous chapters, such as the main() routine of a program and the paint() routine of an applet. So you are familiar with the general format. The hstatementsi between the braces, { and }, in a subroutine definition make up the body of the subroutine. These statements are the inside, or implementation part, of the “black box”,
- 136. 120 CHAPTER 4. SUBROUTINES as discussed in the previous section. They are the instructions that the computer executes when the method is called. Subroutines can contain any of the statements discussed in Chapter 2 and Chapter 3. The hmodifiersi that can occur at the beginning of a subroutine definition are words that set certain characteristics of the subroutine, such as whether it is static or not. The modifiers that you’ve seen so far are “static” and “public”. There are only about a half-dozen possible modifiers altogether. If the subroutine is a function, whose job is to compute some value, then the hreturn-typei is used to specify the type of value that is returned by the function. We’ll be looking at functions and return types in some detail in Section 4.4. If the subroutine is not a function, then the hreturn-typei is replaced by the special value void, which indicates that no value is returned. The term “void” is meant to indicate that the return value is empty or non-existent. Finally, we come to the hparameter-listi of the method. Parameters are part of the interface of a subroutine. They represent information that is passed into the subroutine from outside, to be used by the subroutine’s internal computations. For a concrete example, imagine a class named Television that includes a method named changeChannel(). The immediate question is: What channel should it change to? A parameter can be used to answer this question. Since the channel number is an integer, the type of the parameter would be int, and the declaration of the changeChannel() method might look like public void changeChannel(int channelNum) { ... } This declaration specifies that changeChannel() has a parameter named channelNum of type int. However, channelNum does not yet have any particular value. A value for channelNum is provided when the subroutine is called; for example: changeChannel(17); The parameter list in a subroutine can be empty, or it can consist of one or more parameter declarations of the form htypei hparameter-namei. If there are several declarations, they are separated by commas. Note that each declaration can name only one parameter. For example, if you want two parameters of type double, you have to say “double x, double y”, rather than “double x, y”. Parameters are covered in more detail in the next section. Here are a few examples of subroutine definitions, leaving out the statements that define what the subroutines do: public static void playGame() { // "public" and "static" are modifiers; "void" is the // return-type; "playGame" is the subroutine-name; // the parameter-list is empty. . . . // Statements that define what playGame does go here. } int getNextN(int N) { // There are no modifiers; "int" in the return-type // "getNextN" is the subroutine-name; the parameter-list // includes one parameter whose name is "N" and whose // type is "int". . . . // Statements that define what getNextN does go here. } static boolean lessThan(double x, double y) { // "static" is a modifier; "boolean" is the // return-type; "lessThan" is the subroutine-name; the
- 137. 4.2. STATIC SUBROUTINES AND VARIABLES 121 // parameter-list includes two parameters whose names are // "x" and "y", and the type of each of these parameters // is "double". . . . // Statements that define what lessThan does go here. } In the second example given here, getNextN is a non-static method, since its definition does not include the modifier “static”—and so it’s not an example that we should be looking at in this chapter! The other modifier shown in the examples is “public”. This modifier indicates that the method can be called from anywhere in a program, even from outside the class where the method is defined. There is another modifier, “private”, which indicates that the method can be called only from inside the same class. The modifiers public and private are called access specifiers. If no access specifier is given for a method, then by default, that method can be called from anywhere in the “package” that contains the class, but not from outside that package. (Packages were introduced in Subsection 2.6.4, and you’ll learn more about them later in this chapter, in Section 4.5.) There is one other access modifier, protected, which will only become relevant when we turn to object-oriented programming in Chapter 5. Note, by the way, that the main() routine of a program follows the usual syntax rules for a subroutine. In public static void main(String[] args) { ... } the modifiers are public and static, the return type is void, the subroutine name is main, and the parameter list is “String[] args”. The only question might be about “String[]”, which has to be a type if it is to match the syntax of a parameter list. In fact, String[] represents a so-called “array type”, so the syntax is valid. We will cover arrays in Chapter 7. (The parameter, args, represents information provided to the program when the main() routine is called by the system. In case you know the term, the information consists of any “command-line arguments” specified in the command that the user typed to run the program.) You’ve already had some experience with filling in the implementation of a subroutine. In this chapter, you’ll learn all about writing your own complete subroutine definitions, including the interface part. 4.2.2 Calling Subroutines When you define a subroutine, all you are doing is telling the computer that the subroutine exists and what it does. The subroutine doesn’t actually get executed until it is called. (This is true even for the main() routine in a class—even though you don’t call it, it is called by the system when the system runs your program.) For example, the playGame() method given as an example above could be called using the following subroutine call statement: playGame(); This statement could occur anywhere in the same class that includes the definition of playGame(), whether in a main() method or in some other subroutine. Since playGame() is a public method, it can also be called from other classes, but in that case, you have to tell the computer which class it comes from. Since playGame() is a static method, its full name includes the name of the class in which it is defined. Let’s say, for example, that playGame() is defined in a class named Poker. Then to call playGame() from outside the Poker class, you would have to say Poker.playGame();
- 138. 122 CHAPTER 4. SUBROUTINES The use of the class name here tells the computer which class to look in to find the method. It also lets you distinguish between Poker.playGame() and other potential playGame() methods defined in other classes, such as Roulette.playGame() or Blackjack.playGame(). More generally, a subroutine call statement for a static subroutine takes the form hsubroutine-namei(hparametersi); if the subroutine that is being called is in the same class, or hclass-namei.hsubroutine-namei(hparametersi); if the subroutine is defined elsewhere, in a different class. (Non-static methods belong to objects rather than classes, and they are called using object names instead of class names. More on that later.) Note that the parameter list can be empty, as in the playGame() example, but the parentheses must be there even if there is nothing between them. 4.2.3 Subroutines in Programs It’s time to give an example of what a complete program looks like, when it includes other subroutines in addition to the main() routine. Let’s write a program that plays a guessing game with the user. The computer will choose a random number between 1 and 100, and the user will try to guess it. The computer tells the user whether the guess is high or low or correct. If the user gets the number after six guesses or fewer, the user wins the game. After each game, the user has the option of continuing with another game. Since playing one game can be thought of as a single, coherent task, it makes sense to write a subroutine that will play one guessing game with the user. The main() routine will use a loop to call the playGame() subroutine over and over, as many times as the user wants to play. We approach the problem of designing the playGame() subroutine the same way we write a main() routine: Start with an outline of the algorithm and apply stepwise refinement. Here is a short pseudocode algorithm for a guessing game program: Pick a random number while the game is not over: Get the user’s guess Tell the user whether the guess is high, low, or correct. The test for whether the game is over is complicated, since the game ends if either the user makes a correct guess or the number of guesses is six. As in many cases, the easiest thing to do is to use a “while (true)” loop and use break to end the loop whenever we find a reason to do so. Also, if we are going to end the game after six guesses, we’ll have to keep track of the number of guesses that the user has made. Filling out the algorithm gives: Let computersNumber be a random number between 1 and 100 Let guessCount = 0 while (true): Get the user’s guess Count the guess by adding 1 to guess count if the user’s guess equals computersNumber: Tell the user he won break out of the loop if the number of guesses is 6: Tell the user he lost break out of the loop if the user’s guess is less than computersNumber:
- 139. 4.2. STATIC SUBROUTINES AND VARIABLES 123 Tell the user the guess was low else if the user’s guess is higher than computersNumber: Tell the user the guess was high With variable declarations added and translated into Java, this becomes the definition of the playGame() routine. A random integer between 1 and 100 can be computed as (int)(100 * Math.random()) + 1. I’ve cleaned up the interaction with the user to make it flow better. static void playGame() { int computersNumber; // A random number picked by the computer. int usersGuess; // A number entered by user as a guess. int guessCount; // Number of guesses the user has made. computersNumber = (int)(100 * Math.random()) + 1; // The value assigned to computersNumber is a randomly // chosen integer between 1 and 100, inclusive. guessCount = 0; TextIO.putln(); TextIO.put("What is your first guess? "); while (true) { usersGuess = TextIO.getInt(); // Get the user’s guess. guessCount++; if (usersGuess == computersNumber) { TextIO.putln("You got it in " + guessCount + " guesses! My number was " + computersNumber); break; // The game is over; the user has won. } if (guessCount == 6) { TextIO.putln("You didn’t get the number in 6 guesses."); TextIO.putln("You lose. My number was " + computersNumber); break; // The game is over; the user has lost. } // If we get to this point, the game continues. // Tell the user if the guess was too high or too low. if (usersGuess < computersNumber) TextIO.put("That’s too low. Try again: "); else if (usersGuess > computersNumber) TextIO.put("That’s too high. Try again: "); } TextIO.putln(); } // end of playGame() Now, where exactly should you put this? It should be part of the same class as the main() routine, but not inside the main routine. It is not legal to have one subroutine physically nested inside another. The main() routine will call playGame(), but not contain it physically. You can put the definition of playGame() either before or after the main() routine. Java is not very picky about having the members of a class in any particular order. It’s pretty easy to write the main routine. You’ve done things like this before. Here’s what the complete program looks like (except that a serious program needs more comments than I’ve included here). public class GuessingGame { public static void main(String[] args) { TextIO.putln("Let’s play a game. I’ll pick a number between"); TextIO.putln("1 and 100, and you try to guess it.");
- 140. 124 CHAPTER 4. SUBROUTINES boolean playAgain; do { playGame(); // call subroutine to play one game TextIO.put("Would you like to play again? "); playAgain = TextIO.getlnBoolean(); } while (playAgain); TextIO.putln("Thanks for playing. Goodbye."); } // end of main() static void playGame() { int computersNumber; // A random number picked by the computer. int usersGuess; // A number entered by user as a guess. int guessCount; // Number of guesses the user has made. computersNumber = (int)(100 * Math.random()) + 1; // The value assigned to computersNumber is a randomly // chosen integer between 1 and 100, inclusive. guessCount = 0; TextIO.putln(); TextIO.put("What is your first guess? "); while (true) { usersGuess = TextIO.getInt(); // Get the user’s guess. guessCount++; if (usersGuess == computersNumber) { TextIO.putln("You got it in " + guessCount + " guesses! My number was " + computersNumber); break; // The game is over; the user has won. } if (guessCount == 6) { TextIO.putln("You didn’t get the number in 6 guesses."); TextIO.putln("You lose. My number was " + computersNumber); break; // The game is over; the user has lost. } // If we get to this point, the game continues. // Tell the user if the guess was too high or too low. if (usersGuess < computersNumber) TextIO.put("That’s too low. Try again: "); else if (usersGuess > computersNumber) TextIO.put("That’s too high. Try again: "); } TextIO.putln(); } // end of playGame() } // end of class GuessingGame Take some time to read the program carefully and figure out how it works. And try to convince yourself that even in this relatively simple case, breaking up the program into two methods makes the program easier to understand and probably made it easier to write each piece. 4.2.4 Member Variables A class can include other things besides subroutines. In particular, it can also include variable declarations. Of course, you can declare variables inside subroutines. Those are called local variables. However, you can also have variables that are not part of any subroutine. To
- 141. 4.2. STATIC SUBROUTINES AND VARIABLES 125 distinguish such variables from local variables, we call them member variables, since they are members of a class. Just as with subroutines, member variables can be either static or non-static. In this chapter, we’ll stick to static variables. A static member variable belongs to the class itself, and it exists as long as the class exists. Memory is allocated for the variable when the class is first loaded by the Java interpreter. Any assignment statement that assigns a value to the variable changes the content of that memory, no matter where that assignment statement is located in the program. Any time the variable is used in an expression, the value is fetched from that same memory, no matter where the expression is located in the program. This means that the value of a static member variable can be set in one subroutine and used in another subroutine. Static member variables are “shared” by all the static subroutines in the class. A local variable in a subroutine, on the other hand, exists only while that subroutine is being executed, and is completely inaccessible from outside that one subroutine. The declaration of a member variable looks just like the declaration of a local variable except for two things: The member variable is declared outside any subroutine (although it still has to be inside a class), and the declaration can be marked with modifiers such as static, public, and private. Since we are only working with static member variables for now, every declaration of a member variable in this chapter will include the modifier static. They might also be marked as public or private. For example: static String usersName; public static int numberOfPlayers; private static double velocity, time; A static member variable that is not declared to be private can be accessed from outside the class where it is defined, as well as inside. When it is used in some other class, it must be referred to with a compound identifier of the form hclass-namei.hvariable-namei. For example, the System class contains the public static member variable named out, and you use this variable in your own classes by referring to System.out. If numberOfPlayers is a public static member variable in a class named Poker, then subroutines in the Poker class would refer to it simply as numberOfPlayers, while subroutines in another class would refer to it as Poker.numberOfPlayers. As an example, let’s add a static member variable to the GuessingGame class that we wrote earlier in this section. This variable will be used to keep track of how many games the user wins. We’ll call the variable gamesWon and declare it with the statement “static int gamesWon;”. In the playGame() routine, we add 1 to gamesWon if the user wins the game. At the end of the main() routine, we print out the value of gamesWon. It would be impossible to do the same thing with a local variable, since we need access to the same variable from both subroutines. When you declare a local variable in a subroutine, you have to assign a value to that variable before you can do anything with it. Member variables, on the other hand are automatically initialized with a default value. For numeric variables, the default value is zero. For boolean variables, the default is false. And for char variables, it’s the unprintable character that has Unicode code number zero. (For objects, such as Strings, the default initial value is a special value called null, which we won’t encounter officially until later.) Since it is of type int, the static member variable gamesWon automatically gets assigned an initial value of zero. This happens to be the correct initial value for a variable that is being used as a counter. You can, of course, assign a different value to the variable at the beginning of the main() routine if you are not satisfied with the default initial value.
- 142. 126 CHAPTER 4. SUBROUTINES Here’s a revised version of GuessingGame.java that includes the gamesWon variable. The changes from the above version are shown in italic: public class GuessingGame2 { static int gamesWon; // The number of games won by // the user. public static void main(String[] args) { gamesWon = 0; // This is actually redundant, since 0 is // the default initial value. TextIO.putln("Let’s play a game. I’ll pick a number between"); TextIO.putln("1 and 100, and you try to guess it."); boolean playAgain; do { playGame(); // call subroutine to play one game TextIO.put("Would you like to play again? "); playAgain = TextIO.getlnBoolean(); } while (playAgain); TextIO.putln(); TextIO.putln("You won " + gamesWon + " games."); TextIO.putln("Thanks for playing. Goodbye."); } // end of main() static void playGame() { int computersNumber; // A random number picked by the computer. int usersGuess; // A number entered by user as a guess. int guessCount; // Number of guesses the user has made. computersNumber = (int)(100 * Math.random()) + 1; // The value assigned to computersNumber is a randomly // chosen integer between 1 and 100, inclusive. guessCount = 0; TextIO.putln(); TextIO.put("What is your first guess? "); while (true) { usersGuess = TextIO.getInt(); // Get the user’s guess. guessCount++; if (usersGuess == computersNumber) { TextIO.putln("You got it in " + guessCount + " guesses! My number was " + computersNumber); gamesWon++; // Count this game by incrementing gamesWon. break; // The game is over; the user has won. } if (guessCount == 6) { TextIO.putln("You didn’t get the number in 6 guesses."); TextIO.putln("You lose. My number was " + computersNumber); break; // The game is over; the user has lost. } // If we get to this point, the game continues. // Tell the user if the guess was too high or too low. if (usersGuess < computersNumber) TextIO.put("That’s too low. Try again: "); else if (usersGuess > computersNumber) TextIO.put("That’s too high. Try again: "); }
- 143. 4.3. PARAMETERS 127 TextIO.putln(); } // end of playGame() } // end of class GuessingGame2 4.3 Parameters If a subroutine is a black box, then a parameter provides a mechanism for passing infor- mation from the outside world into the box. Parameters are part of the interface of a subroutine. They allow you to customize the behavior of a subroutine to adapt it to a particular situation. As an analogy, consider a thermostat—a black box whose task it is to keep your house at a certain temperature. The thermostat has a parameter, namely the dial that is used to set the desired temperature. The thermostat always performs the same task: maintaining a constant temperature. However, the exact task that it performs—that is, which temperature it maintains—is customized by the setting on its dial. 4.3.1 Using Parameters As an example, let’s go back to the “3N+1” problem that was discussed in Subsection 3.2.2. (Recall that a 3N+1 sequence is computed according to the rule, “if N is odd, multiply by 3 and add 1; if N is even, divide by 2; continue until N is equal to 1.” For example, starting from N=3 we get the sequence: 3, 10, 5, 16, 8, 4, 2, 1.) Suppose that we want to write a subroutine to print out such sequences. The subroutine will always perform the same task: Print out a 3N+1 sequence. But the exact sequence it prints out depends on the starting value of N. So, the starting value of N would be a parameter to the subroutine. The subroutine could be written like this: /** * This subroutine prints a 3N+1 sequence to standard output, using * startingValue as the initial value of N. It also prints the number * of terms in the sequence. The value of the parameter, startingValue, * must be a positive integer. */ static void print3NSequence(int startingValue) { int N; // One of the terms in the sequence. int count; // The number of terms. N = startingValue; // The first term is whatever value // is passed to the subroutine as // a parameter. int count = 1; // We have one term, the starting value, so far. System.out.println("The 3N+1 sequence starting from " + N); System.out.println(); System.out.println(N); // print initial term of sequence while (N > 1) { if (N % 2 == 1) // is N odd? N = 3 * N + 1; else N = N / 2;
- 144. 128 CHAPTER 4. SUBROUTINES count++; // count this term System.out.println(N); // print this term } System.out.println(); System.out.println("There were " + count + " terms in the sequence."); } // end print3NSequence The parameter list of this subroutine, “(int startingValue)”, specifies that the subroutine has one parameter, of type int. Within the body of the subroutine, the parameter name can be used in the same way as a variable name. However, the parameter gets its initial value from outside the subroutine. When the subroutine is called, a value must be provided for this parameter in the subroutine call statement. This value will be assigned to the parameter, startingValue, before the body of the subroutine is executed. For example, the subrou- tine could be called using the subroutine call statement “print3NSequence(17);”. When the computer executes this statement, the computer assigns the value 17 to startingValue and then executes the statements in the subroutine. This prints the 3N+1 sequence starting from 17. If K is a variable of type int, then when the computer executes the subroutine call state- ment “print3NSequence(K);”, it will take the value of the variable K, assign that value to startingValue, and execute the body of the subroutine. The class that contains print3NSequence can contain a main() routine (or other subrou- tines) that call print3NSequence. For example, here is a main() program that prints out 3N+1 sequences for various starting values specified by the user: public static void main(String[] args) { TextIO.putln("This program will print out 3N+1 sequences"); TextIO.putln("for starting values that you specify."); TextIO.putln(); int K; // Input from user; loop ends when K < 0. do { TextIO.putln("Enter a starting value;") TextIO.put("To end the program, enter 0: "); K = TextIO.getInt(); // Get starting value from user. if (K > 0) // Print sequence, but only if K is > 0. print3NSequence(K); } while (K > 0); // Continue only if K > 0. } // end main Remember that before you can use this program, the definitions of main and of print3NSequence must both be wrapped inside a class definition. 4.3.2 Formal and Actual Parameters Note that the term “parameter” is used to refer to two different, but related, concepts. There are parameters that are used in the definitions of subroutines, such as startingValue in the above example. And there are parameters that are used in subroutine call statements, such as the K in the statement “print3NSequence(K);”. Parameters in a subroutine definition are called formal parameters or dummy parameters. The parameters that are passed to a subroutine when it is called are called actual parameters or arguments. When a subroutine is called, the actual parameters in the subroutine call statement are evaluated and the values are assigned to the formal parameters in the subroutine’s definition. Then the body of the subroutine is executed.
- 145. 4.3. PARAMETERS 129 A formal parameter must be a name, that is, a simple identifier. A formal parameter is very much like a variable, and—like a variable—it has a specified type such as int, boolean, or String. An actual parameter is a value, and so it can be specified by any expression, provided that the expression computes a value of the correct type. The type of the actual parameter must be one that could legally be assigned to the formal parameter with an assignment statement. For example, if the formal parameter is of type double, then it would be legal to pass an int as the actual parameter since ints can legally be assigned to doubles. When you call a subroutine, you must provide one actual parameter for each formal parameter in the subroutine’s definition. Consider, for example, a subroutine static void doTask(int N, double x, boolean test) { // statements to perform the task go here } This subroutine might be called with the statement doTask(17, Math.sqrt(z+1), z >= 10); When the computer executes this statement, it has essentially the same effect as the block of statements: { int N; // Allocate memory locations for the formal parameters. double x; boolean test; N = 17; // Assign 17 to the first formal parameter, N. x = Math.sqrt(z+1); // Compute Math.sqrt(z+1), and assign it to // the second formal parameter, x. test = (z >= 10); // Evaluate "z >= 10" and assign the resulting // true/false value to the third formal // parameter, test. // statements to perform the task go here } (There are a few technical differences between this and “doTask(17,Math.sqrt(z+1),z>=10);” —besides the amount of typing—because of questions about scope of variables and what hap- pens when several variables or parameters have the same name.) Beginning programming students often find parameters to be surprisingly confusing. Call- ing a subroutine that already exists is not a problem—the idea of providing information to the subroutine in a parameter is clear enough. Writing the subroutine definition is another matter. A common mistake is to assign values to the formal parameters at the beginning of the subrou- tine, or to ask the user to input their values. This represents a fundamental misunderstanding. When the statements in the subroutine are executed, the formal parameters will already have values. The values come from the subroutine call statement. Remember that a subroutine is not independent. It is called by some other routine, and it is the calling routine’s responsibility to provide appropriate values for the parameters. 4.3.3 Overloading In order to call a subroutine legally, you need to know its name, you need to know how many formal parameters it has, and you need to know the type of each parameter. This information is called the subroutine’s signature. The signature of the subroutine doTask, used as an example above, can be expressed as as: doTask(int,double,boolean). Note that the signature does
- 146. 130 CHAPTER 4. SUBROUTINES not include the names of the parameters; in fact, if you just want to use the subroutine, you don’t even need to know what the formal parameter names are, so the names are not part of the interface. Java is somewhat unusual in that it allows two different subroutines in the same class to have the same name, provided that their signatures are different. (The language C++ on which Java is based also has this feature.) When this happens, we say that the name of the subroutine is overloaded because it has several different meanings. The computer doesn’t get the subroutines mixed up. It can tell which one you want to call by the number and types of the actual parameters that you provide in the subroutine call statement. You have already seen overloading used in the TextIO class. This class includes many different methods named putln, for example. These methods all have different signatures, such as: putln(int) putln(double) putln(String) putln(char) putln(boolean) putln() The computer knows which of these subroutines you want to use based on the type of the actual parameter that you provide. TextIO.putln(17) calls the subroutine with signature putln(int), while TextIO.putln("Hello") calls the subroutine with signature putln(String). Of course all these different subroutines are semantically related, which is why it is acceptable programming style to use the same name for them all. But as far as the computer is concerned, printing out an int is very different from printing out a String, which is different from printing out a boolean, and so forth—so that each of these operations requires a different method. Note, by the way, that the signature does not include the subroutine’s return type. It is illegal to have two subroutines in the same class that have the same signature but that have different return types. For example, it would be a syntax error for a class to contain two methods defined as: int getln() { ... } double getln() { ... } So it should be no surprise that in the TextIO class, the methods for reading different types are not all named getln(). In a given class, there can only be one routine that has the name getln and has no parameters. So, the input routines in TextIO are distinguished by having different names, such as getlnInt() and getlnDouble(). Java 5.0 introduced another complication: It is possible to have a single subroutine that takes a variable number of actual parameters. You have already used subroutines that do this—the formatted output routines System.out.printf and TextIO.putf. When you call these subroutines, the number of parameters in the subroutine call can be arbitrarily large, so it would be impossible to have different subroutines to handle each case. Unfortunately, writing the definition of such a subroutine requires some knowledge of arrays, which will not be covered until Chapter 7. When we get to that chapter, you’ll learn how to write subroutines with a variable number of parameters. For now, we will ignore this complication. 4.3.4 Subroutine Examples Let’s do a few examples of writing small subroutines to perform assigned tasks. Of course, this is only one side of programming with subroutines. The task performed by a subroutine is always a subtask in a larger program. The art of designing those programs—of deciding how to
- 147. 4.3. PARAMETERS 131 break them up into subtasks—is the other side of programming with subroutines. We’ll return to the question of program design in Section 4.6. As a first example, let’s write a subroutine to compute and print out all the divisors of a given positive integer. The integer will be a parameter to the subroutine. Remember that the syntax of any subroutine is: hmodifiersi hreturn-typei hsubroutine-namei ( hparameter-listi ) { hstatementsi } Writing a subroutine always means filling out this format. In this case, the statement of the problem tells us that there is one parameter, of type int, and it tells us what the statements in the body of the subroutine should do. Since we are only working with static subroutines for now, we’ll need to use static as a modifier. We could add an access modifier (public or private), but in the absence of any instructions, I’ll leave it out. Since we are not told to return a value, the return type is void. Since no names are specified, we’ll have to make up names for the formal parameter and for the subroutine itself. I’ll use N for the parameter and printDivisors for the subroutine name. The subroutine will look like static void printDivisors( int N ) { hstatementsi } and all we have left to do is to write the statements that make up the body of the routine. This is not difficult. Just remember that you have to write the body assuming that N already has a value! The algorithm is: “For each possible divisor D in the range from 1 to N, if D evenly divides N, then print D.” Written in Java, this becomes: /** * Print all the divisors of N. * We assume that N is a positive integer. */ static void printDivisors( int N ) { int D; // One of the possible divisors of N. System.out.println("The divisors of " + N + " are:"); for ( D = 1; D <= N; D++ ) { if ( N % D == 0 ) System.out.println(D); } } I’ve added a comment before the subroutine definition indicating the contract of the subroutine—that is, what it does and what assumptions it makes. The contract includes the assumption that N is a positive integer. It is up to the caller of the subroutine to make sure that this assumption is satisfied. As a second short example, consider the problem: Write a subroutine named printRow. It should have a parameter ch of type char and a parameter N of type int. The subroutine should print out a line of text containing N copies of the character ch. Here, we are told the name of the subroutine and the names of the two parameters, so we don’t have much choice about the first line of the subroutine definition. The task in this case is pretty simple, so the body of the subroutine is easy to write. The complete subroutine is given by
- 148. 132 CHAPTER 4. SUBROUTINES /** * Write one line of output containing N copies of the * character ch. If N <= 0, an empty line is output. */ static void printRow( char ch, int N ) { int i; // Loop-control variable for counting off the copies. for ( i = 1; i <= N; i++ ) { System.out.print( ch ); } System.out.println(); } Note that in this case, the contract makes no assumption about N, but it makes it clear what will happen in all cases, including the unexpected case that N < 0. Finally, let’s do an example that shows how one subroutine can build on another. Let’s write a subroutine that takes a String as a parameter. For each character in the string, it will print a line of output containing 25 copies of that character. It should use the printRow() subroutine to produce the output. Again, we get to choose a name for the subroutine and a name for the parameter. I’ll call the subroutine printRowsFromString and the parameter str. The algorithm is pretty clear: For each position i in the string str, call printRow(str.charAt(i),25) to print one line of the output. So, we get: /** * For each character in str, write a line of output * containing 25 copies of that character. */ static void printRowsFromString( String str ) { int i; // Loop-control variable for counting off the chars. for ( i = 0; i < str.length(); i++ ) { printRow( str.charAt(i), 25 ); } } We could use printRowsFromString in a main() routine such as public static void main(String[] args) { String inputLine; // Line of text input by user. TextIO.put("Enter a line of text: "); inputLine = TextIO.getln(); TextIO.putln(); printRowsFromString( inputLine ); } Of course, the three routines, main(), printRowsFromString(), and printRow(), would have to be collected together inside the same class. The program is rather useless, but it does demonstrate the use of subroutines. You’ll find the program in the file RowsOfChars.java, if you want to take a look. 4.3.5 Throwing Exceptions I have been talking about the “contract” of a subroutine. The contract says what the subroutine will do, provided that the caller of the subroutine provides acceptable values for subroutine’s
- 149. 4.3. PARAMETERS 133 parameters. The question arises, though, what should the subroutine do when the caller violates the contract by providing bad parameter values? We’ve already seen that some subroutines respond to bad parameter values by throw- ing exceptions. (See Section 3.7.) For example, the contract of the built-in subroutine Double.parseDouble says that the parameter should be a string representation of a num- ber of type double; if this is true, then the subroutine will convert the string into the equivalent numeric value. If the caller violates the contract by passing an invalid string as the actual parameter, the subroutine responds by throwing an exception of type NumberFormatException. Many subroutines throw IllegalArgumentExceptions in response to bad parameter values. You might want to take this response in your own subroutines. This can be done with a throw statement. An exception is an object, and in order to throw an exception, you must create an exception object. You won’t officially learn how to do this until Chapter 5, but for now, you can use the following syntax for a throw statement that throws an IllegalArgumentException: throw new IllegalArgumentException( herror-messagei ); where herror-messagei is a string that describes the error that has been detected. (The word “new” in this statement is what creates the object.) To use this statement in a subroutine, you would check whether the values of the parameters are legal. If not, you would throw the exception. For example, consider the print3NSequence subroutine from the beginning of this section. The parameter of print3NSequence is supposed to be a positive integer. We can modify the subroutine definition to make it throw an exception when this condition is violated: static void print3NSequence(int startingValue) { if (startingValue <= 0) // The contract is violated! throw new IllegalArgumentException( "Starting value must be positive." ); . . // (The rest of the subroutine is the same as before.) . If the start value is bad, the computer executes the throw statement. This will immediate terminate the subroutine, without executing the rest of the body of the subroutine. Further- more, the program as a whole will crash unless the exception is “caught” and handled elsewhere in the program by a try..catch statement, as discussed in Section 3.7. 4.3.6 Global and Local Variables I’ll finish this section on parameters by noting that we now have three different sorts of vari- ables that can be used inside a subroutine: local variables declared in the subroutine, formal parameter names, and static member variables that are declared outside the subroutine but inside the same class as the subroutine. Local variables have no connection to the outside world; they are purely part of the internal working of the subroutine. Parameters are used to “drop” values into the subroutine when it is called, but once the subroutine starts executing, parameters act much like local variables. Changes made inside a subroutine to a formal parameter have no effect on the rest of the program (at least if the type of the parameter is one of the primitive types—things are more complicated in the case of objects, as we’ll see later). Things are different when a subroutine uses a variable that is defined outside the subroutine. That variable exists independently of the subroutine, and it is accessible to other parts of the program, as well as to the subroutine. Such a variable is said to be global to the subroutine,
- 150. 134 CHAPTER 4. SUBROUTINES as opposed to the local variables defined inside the subroutine. The scope of a global variable includes the entire class in which it is defined. Changes made to a global variable can have effects that extend outside the subroutine where the changes are made. You’ve seen how this works in the last example in the previous section, where the value of the global variable, gamesWon, is computed inside a subroutine and is used in the main() routine. It’s not always bad to use global variables in subroutines, but you should realize that the global variable then has to be considered part of the subroutine’s interface. The subroutine uses the global variable to communicate with the rest of the program. This is a kind of sneaky, back-door communication that is less visible than communication done through parameters, and it risks violating the rule that the interface of a black box should be straightforward and easy to understand. So before you use a global variable in a subroutine, you should consider whether it’s really necessary. I don’t advise you to take an absolute stand against using global variables inside subroutines. There is at least one good reason to do it: If you think of the class as a whole as being a kind of black box, it can be very reasonable to let the subroutines inside that box be a little sneaky about communicating with each other, if that will make the class as a whole look simpler from the outside. 4.4 Return Values A subroutine that returns a value is called a function. A given function can only return a value of a specified type, called the return type of the function. A function call generally occurs in a position where the computer is expecting to find a value, such as the right side of an assignment statement, as an actual parameter in a subroutine call, or in the middle of some larger expression. A boolean-valued function can even be used as the test condition in an if, while, for or do..while statement. (It is also legal to use a function call as a stand-alone statement, just as if it were a reg- ular subroutine. In this case, the computer ignores the value computed by the subroutine. Sometimes this makes sense. For example, the function TextIO.getln(), with a return type of String, reads and returns a line of input typed in by the user. Usually, the line that is returned is assigned to a variable to be used later in the program, as in the statement “name = TextIO.getln();”. However, this function is also useful as a subroutine call statement “TextIO.getln();”, which still reads all input up to and including the next carriage return. Since the return value is not assigned to a variable or used in an expression, it is simply dis- carded. So, the effect of the subroutine call is to read and discard some input. Sometimes, discarding unwanted input is exactly what you need to do.) 4.4.1 The return statement You’ve already seen how functions such as Math.sqrt() and TextIO.getInt() can be used. What you haven’t seen is how to write functions of your own. A function takes the same form as a regular subroutine, except that you have to specify the value that is to be returned by the subroutine. This is done with a return statement, which has the following syntax: return hexpressioni ; Such a return statement can only occur inside the definition of a function, and the type of the hexpressioni must match the return type that was specified for the function. (More exactly, it must be legal to assign the expression to a variable whose type is specified by the
- 151. 4.4. RETURN VALUES 135 return type.) When the computer executes this return statement, it evaluates the expression, terminates execution of the function, and uses the value of the expression as the returned value of the function. For example, consider the function definition static double pythagoras(double x, double y) { // Computes the length of the hypotenuse of a right // triangle, where the sides of the triangle are x and y. return Math.sqrt( x*x + y*y ); } Suppose the computer executes the statement “totalLength = 17 + pythagoras(12,5);”. When it gets to the term pythagoras(12,5), it assigns the actual parameters 12 and 5 to the formal parameters x and y in the function. In the body of the function, it evaluates Math.sqrt(12.0*12.0 + 5.0*5.0), which works out to 13.0. This value is “returned” by the function, so the 13.0 essentially replaces the function call in the statement “totalLength = 17 + pythagoras(12,5);”. The return value is added to 17, and the result, 30.0, is stored in the variable, totalLength. The effect is the same as if the statement had been “totalLength = 17 + 13.0;”. Note that a return statement does not have to be the last statement in the function definition. At any point in the function where you know the value that you want to return, you can return it. Returning a value will end the function immediately, skipping any subsequent statements in the function. However, it must be the case that the function definitely does return some value, no matter what path the execution of the function takes through the code. You can use a return statement inside an ordinary subroutine, one with declared return type “void”. Since a void subroutine does not return a value, the return statement does not include an expression; it simply takes the form “return;”. The effect of this statement is to terminate execution of the subroutine and return control back to the point in the program from which the subroutine was called. This can be convenient if you want to terminate execution somewhere in the middle of the subroutine, but return statements are optional in non-function subroutines. In a function, on the other hand, a return statement, with expression, is always required. 4.4.2 Function Examples Here is a very simple function that could be used in a program to compute 3N+1 sequences. (The 3N+1 sequence problem is one we’ve looked at several times already, including in the previous section). Given one term in a 3N+1 sequence, this function computes the next term of the sequence: static int nextN(int currentN) { if (currentN % 2 == 1) // test if current N is odd return 3*currentN + 1; // if so, return this value else return currentN / 2; // if not, return this instead } This function has two return statements. Exactly one of the two return statements is executed to give the value of the function. Some people prefer to use a single return statement at the very end of the function when possible. This allows the reader to find the return statement easily. You might choose to write nextN() like this, for example:
- 152. 136 CHAPTER 4. SUBROUTINES static int nextN(int currentN) { int answer; // answer will be the value returned if (currentN % 2 == 1) // test if current N is odd answer = 3*currentN+1; // if so, this is the answer else answer = currentN / 2; // if not, this is the answer return answer; // (Don’t forget to return the answer!) } Here is a subroutine that uses this nextN function. In this case, the improvement from the version of this subroutine in Section 4.3 is not great, but if nextN() were a long function that performed a complex computation, then it would make a lot of sense to hide that complexity inside a function: static void print3NSequence(int startingValue) { int N; // One of the terms in the sequence. int count; // The number of terms found. N = startingValue; // Start the sequence with startingValue. count = 1; TextIO.putln("The 3N+1 sequence starting from " + N); TextIO.putln(); TextIO.putln(N); // print initial term of sequence while (N > 1) { N = nextN( N ); // Compute next term, using the function nextN. count++; // Count this term. TextIO.putln(N); // Print this term. } TextIO.putln(); TextIO.putln("There were " + count + " terms in the sequence."); } ∗ ∗ ∗ Here are a few more examples of functions. The first one computes a letter grade corre- sponding to a given numerical grade, on a typical grading scale: /** * Returns the letter grade corresponding to the numerical * grade that is passed to this function as a parameter. */ static char letterGrade(int numGrade) { if (numGrade >= 90) return ’A’; // 90 or above gets an A else if (numGrade >= 80) return ’B’; // 80 to 89 gets a B else if (numGrade >= 65) return ’C’; // 65 to 79 gets a C else if (numGrade >= 50) return ’D’; // 50 to 64 gets a D else
- 153. 4.4. RETURN VALUES 137 return ’F’; // anything else gets an F } // end of function letterGrade The type of the return value of letterGrade() is char. Functions can return values of any type at all. Here’s a function whose return value is of type boolean. It demonstrates some interesting programming points, so you should read the comments: /** * The function returns true if N is a prime number. A prime number * is an integer greater than 1 that is not divisible by any positive * integer, except itself and 1. If N has any divisor, D, in the range * 1 < D < N, then it has a divisor in the range 2 to Math.sqrt(N), namely * either D itself or N/D. So we only test possible divisors from 2 to * Math.sqrt(N). */ static boolean isPrime(int N) { int divisor; // A number we will test to see whether it evenly divides N. if (N <= 1) return false; // No number <= 1 is a prime. int maxToTry; // The largest divisor that we need to test. maxToTry = (int)Math.sqrt(N); // We will try to divide N by numbers between 2 and maxToTry. // If N is not evenly divisible by any of these numbers, then // N is prime. (Note that since Math.sqrt(N) is defined to // return a value of type double, the value must be typecast // to type int before it can be assigned to maxToTry.) for (divisor = 2; divisor <= maxToTry; divisor++) { if ( N % divisor == 0 ) // Test if divisor evenly divides N. return false; // If so, we know N is not prime. // No need to continue testing! } // If we get to this point, N must be prime. Otherwise, // the function would already have been terminated by // a return statement in the previous loop. return true; // Yes, N is prime. } // end of function isPrime Finally, here is a function with return type String. This function has a String as parameter. The returned value is a reversed copy of the parameter. For example, the reverse of “Hello World” is “dlroW olleH”. The algorithm for computing the reverse of a string, str, is to start with an empty string and then to append each character from str, starting from the last character of str and working backwards to the first: static String reverse(String str) { String copy; // The reversed copy. int i; // One of the positions in str, // from str.length() - 1 down to 0. copy = ""; // Start with an empty string. for ( i = str.length() - 1; i >= 0; i-- ) {
- 154. 138 CHAPTER 4. SUBROUTINES // Append i-th char of str to copy. copy = copy + str.charAt(i); } return copy; } A palindrome is a string that reads the same backwards and forwards, such as “radar”. The reverse() function could be used to check whether a string, word, is a palindrome by testing “if (word.equals(reverse(word)))”. By the way, a typical beginner’s error in writing functions is to print out the answer, instead of returning it. This represents a fundamental misunderstanding. The task of a function is to compute a value and return it to the point in the program where the function was called. That’s where the value is used. Maybe it will be printed out. Maybe it will be assigned to a variable. Maybe it will be used in an expression. But it’s not for the function to decide. 4.4.3 3N+1 Revisited I’ll finish this section with a complete new version of the 3N+1 program. This will give me a chance to show the function nextN(), which was defined above, used in a complete program. I’ll also take the opportunity to improve the program by getting it to print the terms of the sequence in columns, with five terms on each line. This will make the output more presentable. This idea is this: Keep track of how many terms have been printed on the current line; when that number gets up to 5, start a new line of output. To make the terms line up into neat columns, I use formatted output. /** * A program that computes and displays several 3N+1 sequences. Starting * values for the sequences are input by the user. Terms in the sequence * are printed in columns, with five terms on each line of output. * After a sequence has been displayed, the number of terms in that * sequence is reported to the user. */ public class ThreeN2 { public static void main(String[] args) { TextIO.putln("This program will print out 3N+1 sequences"); TextIO.putln("for starting values that you specify."); TextIO.putln(); int K; // Starting point for sequence, specified by the user. do { TextIO.putln("Enter a starting value;"); TextIO.put("To end the program, enter 0: "); K = TextIO.getInt(); // get starting value from user if (K > 0) // print sequence, but only if K is > 0 print3NSequence(K); } while (K > 0); // continue only if K > 0 } // end main /** * print3NSequence prints a 3N+1 sequence to standard output, using
- 155. 4.4. RETURN VALUES 139 * startingValue as the initial value of N. It also prints the number * of terms in the sequence. The value of the parameter, startingValue, * must be a positive integer. */ static void print3NSequence(int startingValue) { int N; // One of the terms in the sequence. int count; // The number of terms found. int onLine; // The number of terms that have been output // so far on the current line. N = startingValue; // Start the sequence with startingValue; count = 1; // We have one term so far. TextIO.putln("The 3N+1 sequence starting from " + N); TextIO.putln(); TextIO.put(N, 8); // Print initial term, using 8 characters. onLine = 1; // There’s now 1 term on current output line. while (N > 1) { N = nextN(N); // compute next term count++; // count this term if (onLine == 5) { // If current output line is full TextIO.putln(); // ...then output a carriage return onLine = 0; // ...and note that there are no terms // on the new line. } TextIO.putf("%8d", N); // Print this term in an 8-char column. onLine++; // Add 1 to the number of terms on this line. } TextIO.putln(); // end current line of output TextIO.putln(); // and then add a blank line TextIO.putln("There were " + count + " terms in the sequence."); } // end of Print3NSequence /** * nextN computes and returns the next term in a 3N+1 sequence, * given that the current term is currentN. */ static int nextN(int currentN) { if (currentN % 2 == 1) return 3 * currentN + 1; else return currentN / 2; } // end of nextN() } // end of class ThreeN2 You should read this program carefully and try to understand how it works. (Try using 27 for the starting value!)
- 156. 140 CHAPTER 4. SUBROUTINES 4.5 APIs, Packages, and Javadoc As computers and their user interfaces have become easier to use, they have also become more complex for programmers to deal with. You can write programs for a simple console-style user interface using just a few subroutines that write output to the console and read the user’s typed replies. A modern graphical user interface, with windows, buttons, scroll bars, menus, text-input boxes, and so on, might make things easier for the user, but it forces the programmer to cope with a hugely expanded array of possibilities. The programmer sees this increased complexity in the form of great numbers of subroutines that are provided for managing the user interface, as well as for other purposes. 4.5.1 Toolboxes Someone who wants to program for Macintosh computers—and to produce programs that look and behave the way users expect them to—must deal with the Macintosh Toolbox, a collection of well over a thousand different subroutines. There are routines for opening and closing windows, for drawing geometric figures and text to windows, for adding buttons to windows, and for responding to mouse clicks on the window. There are other routines for creating menus and for reacting to user selections from menus. Aside from the user interface, there are routines for opening files and reading data from them, for communicating over a network, for sending output to a printer, for handling communication between programs, and in general for doing all the standard things that a computer has to do. Microsoft Windows provides its own set of subroutines for programmers to use, and they are quite a bit different from the subroutines used on the Mac. Linux has several different GUI toolboxes for the programmer to choose from. The analogy of a “toolbox” is a good one to keep in mind. Every programming project involves a mixture of innovation and reuse of existing tools. A programmer is given a set of tools to work with, starting with the set of basic tools that are built into the language: things like variables, assignment statements, if statements, and loops. To these, the programmer can add existing toolboxes full of routines that have already been written for performing certain tasks. These tools, if they are well-designed, can be used as true black boxes: They can be called to perform their assigned tasks without worrying about the particular steps they go through to accomplish those tasks. The innovative part of programming is to take all these tools and apply them to some particular project or problem (word-processing, keeping track of bank accounts, processing image data from a space probe, Web browsing, computer games, . . . ). This is called applications programming. A software toolbox is a kind of black box, and it presents a certain interface to the program- mer. This interface is a specification of what routines are in the toolbox, what parameters they use, and what tasks they perform. This information constitutes the API , or Applications Programming Interface, associated with the toolbox. The Macintosh API is a specification of all the routines available in the Macintosh Toolbox. A company that makes some hard- ware device—say a card for connecting a computer to a network—might publish an API for that device consisting of a list of routines that programmers can call in order to communicate with and control the device. Scientists who write a set of routines for doing some kind of complex computation—such as solving “differential equations,” say—would provide an API to allow others to use those routines without understanding the details of the computations they perform. ∗ ∗ ∗
- 157. 4.5. APIS, PACKAGES, AND JAVADOC 141 The Java programming language is supplemented by a large, standard API. You’ve seen part of this API already, in the form of mathematical subroutines such as Math.sqrt(), the String data type and its associated routines, and the System.out.print() routines. The standard Java API includes routines for working with graphical user interfaces, for network communication, for reading and writing files, and more. It’s tempting to think of these routines as being built into the Java language, but they are technically subroutines that have been written and made available for use in Java programs. Java is platform-independent. That is, the same program can run on platforms as diverse as Macintosh, Windows, Linux, and others. The same Java API must work on all these platforms. But notice that it is the interface that is platform-independent; the implementation varies from one platform to another. A Java system on a particular computer includes implementations of all the standard API routines. A Java program includes only calls to those routines. When the Java interpreter executes a program and encounters a call to one of the standard routines, it will pull up and execute the implementation of that routine which is appropriate for the particular platform on which it is running. This is a very powerful idea. It means that you only need to learn one API to program for a wide variety of platforms. 4.5.2 Java’s Standard Packages Like all subroutines in Java, the routines in the standard API are grouped into classes. To provide larger-scale organization, classes in Java can be grouped into packages, which were introduced briefly in Subsection 2.6.4. You can have even higher levels of grouping, since packages can also contain other packages. In fact, the entire standard Java API is implemented in several packages. One of these, which is named “java”, contains several non-GUI packages as well as the original AWT graphics user interface classes. Another package, “javax”, was added in Java version 1.2 and contains the classes used by the Swing graphical user interface and other additions to the API. A package can contain both classes and other packages. A package that is contained in another package is sometimes called a “sub-package.” Both the java package and the javax package contain sub-packages. One of the sub-packages of java, for example, is called “awt”. Since awt is contained within java, its full name is actually java.awt. This package con- tains classes that represent GUI components such as buttons and menus in the AWT, the older of the two Java GUI toolboxes, which is no longer widely used. However, java.awt also contains a number of classes that form the foundation for all GUI programming, such as the Graphics class which provides routines for drawing on the screen, the Color class which repre- sents colors, and the Font class which represents the fonts that are used to display characters on the screen. Since these classes are contained in the package java.awt, their full names are actually java.awt.Graphics, java.awt.Color, and java.awt.Font. (I hope that by now you’ve gotten the hang of how this naming thing works in Java.) Similarly, javax contains a sub-package named javax.swing, which includes such classes as javax.swing.JButton, javax.swing.JMenu, and javax.swing.JFrame. The GUI classes in javax.swing, together with the foundational classes in java.awt, are all part of the API that makes it possible to program graphical user interfaces in Java. The java package includes several other sub-packages, such as java.io, which provides fa- cilities for input/output, java.net, which deals with network communication, and java.util, which provides a variety of “utility” classes. The most basic package is called java.lang. This package contains fundamental classes such as String, Math, Integer, and Double. It might be helpful to look at a graphical representation of the levels of nesting in the
- 158. 142 CHAPTER 4. SUBROUTINES java package, its sub-packages, the classes in those sub-packages, and the subroutines in those classes. This is not a complete picture, since it shows only a very few of the many items in each element: j a v a l a n g a w t u t i l M a t h G r a p h i c s s q r t ( ) r a n d o m ( ) d r a w R e c t ( ) s e t C o l o r ( ) S t r i n g F o n t I n t e g e r C o l o r S u b r o u t i n e s n e s t e d i n c l a s s e s n e s t e d i n t w o l a y e r s o f p a c k a g e s . T h e f u l l n a m e o f s q r t ( ) i s j a v a . l a n g . M a t h . s q r t ( ) The official documentation for the standard Java 5.0 API lists 165 different packages, in- cluding sub-packages, and it lists 3278 classes in these packages. Many of these are rather obscure or very specialized, but you might want to browse through the documentation to see what is available. As I write this, the documentation for the complete API can be found at http://java.sun.com/j2se/1.5.0/docs/api/index.html Even an expert programmer won’t be familiar with the entire API, or even a majority of it. In this book, you’ll only encounter several dozen classes, and those will be sufficient for writing a wide variety of programs. 4.5.3 Using Classes from Packages Let’s say that you want to use the class java.awt.Color in a program that you are writing. Like any class, java.awt.Color is a type, which means that you can use it to declare variables and parameters and to specify the return type of a function. One way to do this is to use the full name of the class as the name of the type. For example, suppose that you want to declare a variable named rectColor of type java.awt.Color. You could say: java.awt.Color rectColor; This is just an ordinary variable declaration of the form “htype-namei hvariable-namei;”. Of course, using the full name of every class can get tiresome, so Java makes it possible to avoid using the full name of a class by importing the class. If you put import java.awt.Color; at the beginning of a Java source code file, then, in the rest of the file, you can abbreviate the full name java.awt.Color to just the simple name of the class, Color. Note that the import
- 159. 4.5. APIS, PACKAGES, AND JAVADOC 143 line comes at the start of a file and is not inside any class. Although it is sometimes referred to as a statement, it is more properly called an import directive since it is not a statement in the usual sense. Using this import directive would allow you to say Color rectColor; to declare the variable. Note that the only effect of the import directive is to allow you to use simple class names instead of full “package.class” names; you aren’t really importing anything substantial. If you leave out the import directive, you can still access the class—you just have to use its full name. There is a shortcut for importing all the classes from a given package. You can import all the classes from java.awt by saying import java.awt.*; The “*” is a wildcard that matches every class in the package. (However, it does not match sub-packages; you cannot import the entire contents of all the sub-packages of the java package by saying import java.*.) Some programmers think that using a wildcard in an import statement is bad style, since it can make a large number of class names available that you are not going to use and might not even know about. They think it is better to explicitly import each individual class that you want to use. In my own programming, I often use wildcards to import all the classes from the most relevant packages, and use individual imports when I am using just one or two classes from a given package. In fact, any Java program that uses a graphical user interface is likely to use many classes from the java.awt and java.swing packages as well as from another package named java.awt.event, and I usually begin such programs with import java.awt.*; import java.awt.event.*; import javax.swing.*; A program that works with networking might include the line “import java.net.*;”, while one that reads or writes files might use “import java.io.*;”. (But when you start importing lots of packages in this way, you have to be careful about one thing: It’s possible for two classes that are in different packages to have the same name. For example, both the java.awt package and the java.util package contain classes named List. If you import both java.awt.* and java.util.*, the simple name List will be ambiguous. If you try to declare a variable of type List, you will get a compiler error message about an ambiguous class name. The solution is simple: Use the full name of the class, either java.awt.List or java.util.List. Another solution, of course, is to use import to import the individual classes you need, instead of importing entire packages.) Because the package java.lang is so fundamental, all the classes in java.lang are auto- matically imported into every program. It’s as if every program began with the statement “import java.lang.*;”. This is why we have been able to use the class name String instead of java.lang.String, and Math.sqrt() instead of java.lang.Math.sqrt(). It would still, however, be perfectly legal to use the longer forms of the names. Programmers can create new packages. Suppose that you want some classes that you are writing to be in a package named utilities. Then the source code file that defines those classes must begin with the line package utilities;
- 160. 144 CHAPTER 4. SUBROUTINES This would come even before any import directive in that file. Furthermore, as mentioned in Subsection 2.6.4, the source code file would be placed in a folder with the same name as the package. A class that is in a package automatically has access to other classes in the same package; that is, a class doesn’t have to import the package in which it is defined. In projects that define large numbers of classes, it makes sense to organize those classes into packages. It also makes sense for programmers to create new packages as toolboxes that provide functionality and API’s for dealing with areas not covered in the standard Java API. (And in fact such “toolmaking” programmers often have more prestige than the applications programmers who use their tools.) However, I will not be creating any packages in this textbook. For the purposes of this book, you need to know about packages mainly so that you will be able to import the standard packages. These packages are always available to the programs that you write. You might wonder where the standard classes are actually located. Again, that can depend to some extent on the version of Java that you are using, but in the standard Java 5.0, they are stored in jar files in a subdirectory of the main Java installation directory. A jar (or “Java archive”) file is a single file that can contain many classes. Most of the standard classes can be found in a jar file named classes.jar. In fact, Java programs are generally distributed in the form of jar files, instead of as individual class files. Although we won’t be creating packages explicitly, every class is actually part of a package. If a class is not specifically placed in a package, then it is put in something called the default package, which has no name. All the examples that you see in this book are in the default package. 4.5.4 Javadoc To use an API effectively, you need good documentation for it. The documentation for most Java APIs is prepared using a system called Javadoc. For example, this system is used to prepare the documentation for Java’s standard packages. And almost everyone who creates a toolbox in Java publishes Javadoc documentation for it. Javadoc documentation is prepared from special comments that are placed in the Java source code file. Recall that one type of Java comment begins with /* and ends with */. A Javadoc comment takes the same form, but it begins with /** rather than simply /*. You have already seen comments of this form in some of the examples in this book, such as this subroutine from Section 4.3: /** * This subroutine prints a 3N+1 sequence to standard output, using * startingValue as the initial value of N. It also prints the number * of terms in the sequence. The value of the parameter, startingValue, * must be a positive integer. */ static void print3NSequence(int startingValue) { ... Note that the Javadoc comment is placed just before the subroutine that it is commenting on. This rule is always followed. You can have Javadoc comments for subroutines, for member variables, and for classes. The Javadoc comment always immediately precedes the thing it is commenting on. Like any comment, a Javadoc comment is ignored by the computer when the file is compiled. But there is a tool called javadoc that reads Java source code files, extracts any Javadoc
- 161. 4.5. APIS, PACKAGES, AND JAVADOC 145 comments that it finds, and creates a set of Web pages containing the comments in a nicely formatted, interlinked form. By default, javadoc will only collect information about public classes, subroutines, and member variables, but it allows the option of creating documentation for non-public things as well. If javadoc doesn’t find any Javadoc comment for something, it will construct one, but the comment will contain only basic information such as the name and type of a member variable or the name, return type, and parameter list of a subroutine. This is syntactic information. To add information about semantics and pragmatics, you have to write a Javadoc comment. As an example, you can look at the documentation Web page for TextIO. The documentation page was created by applying the javadoc tool to the source code file, TextIO.java. If you have downloaded the on-line version of this book, the documentation can be found in the TextIO Javadoc directory, or you can find a link to it in the on-line version of this section. In a Javadoc comment, the *’s at the start of each line are optional. The javadoc tool will remove them. In addition to normal text, the comment can contain certain special codes. For one thing, the comment can contain HTML mark-up commands. HTML is the language that is used to create web pages, and Javadoc comments are meant to be shown on web pages. The javadoc tool will copy any HTML commands in the comments to the web pages that it creates. You’ll learn some basic HTML in Section 6.2, but as an example, you can add <p> to indicate the start of a new paragraph. (Generally, in the absence of HTML commands, blank lines and extra spaces in the comment are ignored.) In addition to HTML commands, Javadoc comments can include doc tags, which are processed as commands by the javadoc tool. A doc tag has a name that begins with the character @. I will only discuss three tags: @param, @return, and @throws. These tags are used in Javadoc comments for subroutines to provide information about its parameters, its return value, and the exceptions that it might throw. These tags are always placed at the end of the comment, after any description of the subroutine itself. The syntax for using them is: @param hparameter-namei hdescription-of-parameteri @return hdescription-of-return-valuei @throws hexception-class-namei hdescription-of-exceptioni The hdescriptionsi can extend over several lines. The description ends at the next tag or at the end of the comment. You can include a @param tag for every parameter of the subroutine and a @throws for as many types of exception as you want to document. You should have a @return tag only for a non-void subroutine. These tags do not have to be given in any particular order. Here is an example that doesn’t do anything exciting but that does use all three types of doc tag: /** * This subroutine computes the area of a rectangle, given its width * and its height. The length and the width should be positive numbers. * @param width the length of one side of the rectangle * @param height the length the second side of the rectangle * @return the area of the rectangle * @throws IllegalArgumentException if either the width or the height * is a negative number. */ public static double areaOfRectangle( double length, double width ) { if ( width < 0 || height < 0 ) throw new IllegalArgumentException("Sides must have positive length.");
- 162. 146 CHAPTER 4. SUBROUTINES double area; area = width * height; return area; } I will use Javadoc comments for some of my examples. I encourage you to use them in your own code, even if you don’t plan to generate Web page documentation of your work, since it’s a standard format that other Java programmers will be familiar with. If you do want to create Web-page documentation, you need to run the javadoc tool. This tool is available as a command in the Java Development Kit that was discussed in Section 2.6. You can use javadoc in a command line interface similarly to the way that the javac and java commands are used. Javadoc can also be applied in the Eclipse integrated development environment that was also discussed in Section 2.6: Just right-click the class or package that you want to document in the Package Explorer, select “Export,” and select “Javadoc” in the window that pops up. I won’t go into any of the details here; see the documentation. 4.6 More on Program Design Understanding how programs work is one thing. Designing a program to perform some particular task is another thing altogether. In Section 3.2, I discussed how pseudocode and stepwise refinement can be used to methodically develop an algorithm. We can now see how subroutines can fit into the process. Stepwise refinement is inherently a top-down process, but the process does have a “bottom,” that is, a point at which you stop refining the pseudocode algorithm and translate what you have directly into proper programming language. In the absence of subroutines, the process would not bottom out until you get down to the level of assignment statements and very primitive input/output operations. But if you have subroutines lying around to perform certain useful tasks, you can stop refining as soon as you’ve managed to express your algorithm in terms of those tasks. This allows you to add a bottom-up element to the top-down approach of stepwise re- finement. Given a problem, you might start by writing some subroutines that perform tasks relevant to the problem domain. The subroutines become a toolbox of ready-made tools that you can integrate into your algorithm as you develop it. (Alternatively, you might be able to buy or find a software toolbox written by someone else, containing subroutines that you can use in your project as black boxes.) Subroutines can also be helpful even in a strict top-down approach. As you refine your algorithm, you are free at any point to take any sub-task in the algorithm and make it into a subroutine. Developing that subroutine then becomes a separate problem, which you can work on separately. Your main algorithm will merely call the subroutine. This, of course, is just a way of breaking your problem down into separate, smaller problems. It is still a top-down approach because the top-down analysis of the problem tells you what subroutines to write. In the bottom-up approach, you start by writing or obtaining subroutines that are relevant to the problem domain, and you build your solution to the problem on top of that foundation of subroutines. 4.6.1 Preconditions and Postconditions When working with subroutines as building blocks, it is important to be clear about how a subroutine interacts with the rest of the program. This interaction is specified by the contract
- 163. 4.6. MORE ON PROGRAM DESIGN 147 of the subroutine, as discussed in Section 4.1. A convenient way to express the contract of a subroutine is in terms of preconditions and postconditions. The precondition of a subroutine is something that must be true when the subroutine is called, if the subroutine is to work correctly. For example, for the built-in function Math.sqrt(x), a precondition is that the parameter, x, is greater than or equal to zero, since it is not possible to take the square root of a negative number. In terms of a contract, a precon- dition represents an obligation of the caller of the subroutine. If you call a subroutine without meeting its precondition, then there is no reason to expect it to work properly. The program might crash or give incorrect results, but you can only blame yourself, not the subroutine. A postcondition of a subroutine represents the other side of the contract. It is something that will be true after the subroutine has run (assuming that its preconditions were met—and that there are no bugs in the subroutine). The postcondition of the function Math.sqrt() is that the square of the value that is returned by this function is equal to the parameter that is provided when the subroutine is called. Of course, this will only be true if the preconditiion— that the parameter is greater than or equal to zero—is met. A postcondition of the built-in subroutine System.out.print() is that the value of the parameter has been displayed on the screen. Preconditions most often give restrictions on the acceptable values of parameters, as in the example of Math.sqrt(x). However, they can also refer to global variables that are used in the subroutine. The postcondition of a subroutine specifies the task that it performs. For a function, the postcondition should specify the value that the function returns. Subroutines are often described by comments that explicitly specify their preconditions and postconditions. When you are given a pre-written subroutine, a statement of its preconditions and postconditions tells you how to use it and what it does. When you are assigned to write a subroutine, the preconditions and postconditions give you an exact specification of what the subroutine is expected to do. I will use this approach in the example that constitutes the rest of this section. The comments are given in the form of Javadoc comments, but I will explicitly label the preconditions and postconditions. (Many computer scientists think that new doc tags @precondition and @postcondition should be added to the Javadoc system for explicit labeling of preconditions and postconditions, but that has not yet been done.) 4.6.2 A Design Example Let’s work through an example of program design using subroutines. In this example, we will use prewritten subroutines as building blocks and we will also design new subroutines that we need to complete the project. Suppose that I have found an already-written class called Mosaic. This class allows a program to work with a window that displays little colored rectangles arranged in rows and columns. The window can be opened, closed, and otherwise manipulated with static member subroutines defined in the Mosaic class. In fact, the class defines a toolbox or API that can be used for working with such windows. Here are some of the available routines in the API, with Javadoc-style comments: /** * Opens a "mosaic" window on the screen. * * Precondition: The parameters rows, cols, w, and h are positive integers. * Postcondition: A window is open on the screen that can display rows and * columns of colored rectangles. Each rectangle is w pixels
- 164. 148 CHAPTER 4. SUBROUTINES * wide and h pixels high. The number of rows is given by * the first parameter and the number of columns by the * second. Initially, all rectangles are black. * Note: The rows are numbered from 0 to rows - 1, and the columns are * numbered from 0 to cols - 1. */ public static void open(int rows, int cols, int w, int h) /** * Sets the color of one of the rectangles in the window. * * Precondition: row and col are in the valid range of row and column numbers, * and r, g, and b are in the range 0 to 255, inclusive. * Postcondition: The color of the rectangle in row number row and column * number col has been set to the color specified by r, g, * and b. r gives the amount of red in the color with 0 * representing no red and 255 representing the maximum * possible amount of red. The larger the value of r, the * more red in the color. g and b work similarly for the * green and blue color components. */ public static void setColor(int row, int col, int r, int g, int b) /** * Gets the red component of the color of one of the rectangles. * * Precondition: row and col are in the valid range of row and column numbers. * Postcondition: The red component of the color of the specified rectangle is * returned as an integer in the range 0 to 255 inclusive. */ public static int getRed(int row, int col) /** * Like getRed, but returns the green component of the color. */ public static int getGreen(int row, int col) /** * Like getRed, but returns the blue component of the color. */ public static int getBlue(int row, int col) /** * Tests whether the mosaic window is currently open. * * Precondition: None. * Postcondition: The return value is true if the window is open when this * function is called, and it is false if the window is * closed. */ public static boolean isOpen() /**
- 165. 4.6. MORE ON PROGRAM DESIGN 149 * Inserts a delay in the program (to regulate the speed at which the colors * are changed, for example). * * Precondition: milliseconds is a positive integer. * Postcondition: The program has paused for at least the specified number * of milliseconds, where one second is equal to 1000 * milliseconds. */ public static void delay(int milliseconds) Remember that these subroutines are members of the Mosaic class, so when they are called from outside Mosaic, the name of the class must be included as part of the name of the routine. For example, we’ll have to use the name Mosaic.isOpen() rather than simply isOpen(). ∗ ∗ ∗ My idea is to use the Mosaic class as the basis for a neat animation. I want to fill the window with randomly colored squares, and then randomly change the colors in a loop that continues as long as the window is open. “Randomly change the colors” could mean a lot of different things, but after thinking for a while, I decide it would be interesting to have a “disturbance” that wanders randomly around the window, changing the color of each square that it encounters. Here’s a picture showing what the contents of the window might look like at one point in time: With basic routines for manipulating the window as a foundation, I can turn to the specific problem at hand. A basic outline for my program is Open a Mosaic window Fill window with random colors; Move around, changing squares at random. Filling the window with random colors seems like a nice coherent task that I can work on separately, so let’s decide to write a separate subroutine to do it. The third step can be expanded a bit more, into the steps: Start in the middle of the window, then keep moving to a new square and changing the color of that square. This should continue as long as the mosaic window is still open. Thus we can refine the algorithm to: Open a Mosaic window Fill window with random colors; Set the current position to the middle square in the window; As long as the mosaic window is open: Randomly change color of the square at the current position; Move current position up, down, left, or right, at random;
- 166. 150 CHAPTER 4. SUBROUTINES I need to represent the current position in some way. That can be done with two int variables named currentRow and currentColumn that hold the row number and the column number of the square where the disturbance is currently located. I’ll use 10 rows and 20 columns of squares in my mosaic, so setting the current position to be in the center means setting currentRow to 5 and currentColumn to 10. I already have a subroutine, Mosaic.open(), to open the window, and I have a function, Mosaic.isOpen(), to test whether the window is open. To keep the main routine simple, I decide that I will write two more subroutines of my own to carry out the two tasks in the while loop. The algorithm can then be written in Java as: Mosaic.open(10,20,10,10) fillWithRandomColors(); currentRow = 5; // Middle row, halfway down the window. currentColumn = 10; // Middle column. while ( Mosaic.isOpen() ) { changeToRandomColor(currentRow, currentColumn); randomMove(); } With the proper wrapper, this is essentially the main() routine of my program. It turns out I have to make one small modification: To prevent the animation from running too fast, the line “Mosaic.delay(20);” is added to the while loop. The main() routine is taken care of, but to complete the program, I still have to write the subroutines fillWithRandomColors(), changeToRandomColor(int,int), and randomMove(). Writing each of these subroutines is a separate, small task. The fillWithRandomColors() routine is defined by the postcondition that “each of the rectangles in the mosaic has been changed to a random color.” Pseudocode for an algorithm to accomplish this task can be given as: For each row: For each column: set the square in that row and column to a random color “For each row” and “for each column” can be implemented as for loops. We’ve already planned to write a subroutine changeToRandomColor that can be used to set the color. (The possi- bility of reusing subroutines in several places is one of the big payoffs of using them!) So, fillWithRandomColors() can be written in proper Java as: static void fillWithRandomColors() { for (int row = 0; row < 10; row++) for (int column = 0; column < 20; column++) changeToRandomColor(row,column); } Turning to the changeToRandomColor subroutine, we already have a method in the Mosaic class, Mosaic.setColor(), that can be used to change the color of a square. If we want a ran- dom color, we just have to choose random values for r, g, and b. According to the precondition of the Mosaic.setColor() subroutine, these random values must be integers in the range from 0 to 255. A formula for randomly selecting such an integer is “(int)(256*Math.random())”. So the random color subroutine becomes: static void changeToRandomColor(int rowNum, int colNum) { int red = (int)(256*Math.random()); int green = (int)(256*Math.random()); int blue = (int)(256*Math.random());
- 167. 4.6. MORE ON PROGRAM DESIGN 151 mosaic.setColor(rowNum,colNum,red,green,blue); } Finally, consider the randomMove subroutine, which is supposed to randomly move the disturbance up, down, left, or right. To make a random choice among four directions, we can choose a random integer in the range 0 to 3. If the integer is 0, move in one direction; if it is 1, move in another direction; and so on. The position of the disturbance is given by the variables currentRow and currentColumn. To “move up” means to subtract 1 from currentRow. This leaves open the question of what to do if currentRow becomes -1, which would put the disturbance above the window. Rather than let this happen, I decide to move the disturbance to the opposite edge of the applet by setting currentRow to 9. (Remember that the 10 rows are numbered from 0 to 9.) Moving the disturbance down, left, or right is handled similarly. If we use a switch statement to decide which direction to move, the code for randomMove becomes: int directionNum; directionNum = (int)(4*Math.random()); switch (directionNum) { case 0: // move up currentRow--; if (currentRow < 0) // CurrentRow is outside the mosaic; currentRow = 9; // move it to the opposite edge. break; case 1: // move right currentColumn++; if (currentColumn >= 20) currentColumn = 0; break; case 2: // move down currentRow++; if (currentRow >= 10) currentRow = 0; break; case 3: // move left currentColumn--; if (currentColumn < 0) currentColumn = 19; break; } 4.6.3 The Program Putting this all together, we get the following complete program. Note that I’ve added Javadoc- style comments for the class itself and for each of the subroutines. The variables currentRow and currentColumn are defined as static members of the class, rather than local variables, because each of them is used in several different subroutines. This program actually depends on two other classes, Mosaic and another class called MosaicCanvas that is used by Mosaic. If you want to compile and run this program, both of these classes must be available to the program.
- 168. 152 CHAPTER 4. SUBROUTINES /** * This program opens a window full of randomly colored squares. A "disturbance" * moves randomly around in the window, randomly changing the color of each * square that it visits. The program runs until the user closes the window. */ public class RandomMosaicWalk { static int currentRow; // Row currently containing the disturbance. static int currentColumn; // Column currently containing disturbance. /** * The main program creates the window, fills it with random colors, * and then moves the disturbances in a random walk around the window * as long as the window is open. */ public static void main(String[] args) { Mosaic.open(10,20,10,10); fillWithRandomColors(); currentRow = 5; // start at center of window currentColumn = 10; while (Mosaic.isOpen()) { changeToRandomColor(currentRow, currentColumn); randomMove(); Mosaic.delay(20); } } // end main /** * Fills the window with randomly colored squares. * Precondition: The mosaic window is open. * Postcondition: Each square has been set to a random color. */ static void fillWithRandomColors() { for (int row=0; row < 10; row++) { for (int column=0; column < 20; column++) { changeToRandomColor(row, column); } } } // end fillWithRandomColors /** * Changes one square to a new randomly selected color. * Precondition: The specified rowNum and colNum are in the valid range * of row and column numbers. * Postcondition: The square in the specified row and column has * been set to a random color. * @param rowNum the row number of the square, counting rows down * from 0 at the top * @param colNum the column number of the square, counting columns over * from 0 at the left */ static void changeToRandomColor(int rowNum, int colNum) { int red = (int)(256*Math.random()); // Choose random levels in range int green = (int)(256*Math.random()); // 0 to 255 for red, green, int blue = (int)(256*Math.random()); // and blue color components.
- 169. 4.7. THE TRUTH ABOUT DECLARATIONS 153 Mosaic.setColor(rowNum,colNum,red,green,blue); } // end of changeToRandomColor() /** * Move the disturbance. * Precondition: The global variables currentRow and currentColumn * are within the legal range of row and column numbers. * Postcondition: currentRow or currentColumn is changed to one of the * neighboring positions in the grid -- up, down, left, or * right from the current position. If this moves the * position outside of the grid, then it is moved to the * opposite edge of the grid. */ static void randomMove() { int directionNum; // Randomly set to 0, 1, 2, or 3 to choose direction. directionNum = (int)(4*Math.random()); switch (directionNum) { case 0: // move up currentRow--; if (currentRow < 0) currentRow = 9; break; case 1: // move right currentColumn++; if (currentColumn >= 20) currentColumn = 0; break; case 2: // move down currentRow++; if (currentRow >= 10) currentRow = 0; break; case 3: // move left currentColumn--; if (currentColumn < 0) currentColumn = 19; break; } } // end randomMove } // end class RandomMosaicWalk 4.7 The Truth About Declarations Names are fundamental to programming, as I said a few chapters ago. There are a lot of details involved in declaring and using names. I have been avoiding some of those details. In this section, I’ll reveal most of the truth (although still not the full truth) about declaring and using variables in Java. The material in the subsections “Initialization in Declarations” and “Named Constants” is particularly important, since I will be using it regularly in future chapters.
- 170. 154 CHAPTER 4. SUBROUTINES 4.7.1 Initialization in Declarations When a variable declaration is executed, memory is allocated for the variable. This memory must be initialized to contain some definite value before the variable can be used in an expres- sion. In the case of a local variable, the declaration is often followed closely by an assignment statement that does the initialization. For example, int count; // Declare a variable named count. count = 0; // Give count its initial value. However, the truth about declaration statements is that it is legal to include the initializa- tion of the variable in the declaration statement. The two statements above can therefore be abbreviated as int count = 0; // Declare count and give it an initial value. The computer still executes this statement in two steps: Declare the variable count, then assign the value 0 to the newly created variable. The initial value does not have to be a constant. It can be any expression. It is legal to initialize several variables in one declaration statement. For example, char firstInitial = ’D’, secondInitial = ’E’; int x, y = 1; // OK, but only y has been initialized! int N = 3, M = N+2; // OK, N is initialized // before its value is used. This feature is especially common in for loops, since it makes it possible to declare a loop control variable at the same point in the loop where it is initialized. Since the loop control variable generally has nothing to do with the rest of the program outside the loop, it’s reasonable to have its declaration in the part of the program where it’s actually used. For example: for ( int i = 0; i < 10; i++ ) { System.out.println(i); } Again, you should remember that this is simply an abbreviation for the following, where I’ve added an extra pair of braces to show that i is considered to be local to the for statement and no longer exists after the for loop ends: { int i; for ( i = 0; i < 10; i++ ) { System.out.println(i); } } (You might recall, by the way, that for “for-each” loops, the special type of for statement that is used with enumerated types, declaring the variable in the for is required. See Subsec- tion 3.4.4.) A member variable can also be initialized at the point where it is declared, just as for a local variable. For example: public class Bank { static double interestRate = 0.05; static int maxWithdrawal = 200;
- 171. 4.7. THE TRUTH ABOUT DECLARATIONS 155 . . // More variables and subroutines. . } A static member variable is created as soon as the class is loaded by the Java interpreter, and the initialization is also done at that time. In the case of member variables, this is not simply an abbreviation for a declaration followed by an assignment statement. Declaration statements are the only type of statement that can occur outside of a subroutine. Assignment statements cannot, so the following is illegal: public class Bank { static double interestRate; interestRate = 0.05; // ILLEGAL: . // Can’t be outside a subroutine!: . . Because of this, declarations of member variables often include initial values. In fact, as mentioned in Subsection 4.2.4, if no initial value is provided for a member variable, then a default initial value is used. For example, when declaring an integer member variable, count, “static int count;” is equivalent to “static int count = 0;”. 4.7.2 Named Constants Sometimes, the value of a variable is not supposed to change after it is initialized. For example, in the above example where interestRate is initialized to the value 0.05, it’s quite possible that that is meant to be the value throughout the entire program. In this case, the programmer is probably defining the variable, interestRate, to give a meaningful name to the otherwise meaningless number, 0.05. It’s easier to understand what’s going on when a program says “principal += principal*interestRate;” rather than “principal += principal*0.05;”. In Java, the modifier “final” can be applied to a variable declaration to ensure that the value stored in the variable cannot be changed after the variable has been initialized. For example, if the member variable interestRate is declared with final static double interestRate = 0.05; then it would be impossible for the value of interestRate to change anywhere else in the program. Any assignment statement that tries to assign a value to interestRate will be rejected by the computer as a syntax error when the program is compiled. It is legal to apply the final modifier to local variables and even to formal parameters, but it is most useful for member variables. I will often refer to a static member variable that is declared to be final as a named constant, since its value remains constant for the whole time that the program is running. The readability of a program can be greatly enhanced by using named constants to give meaningful names to important quantities in the program. A recommended style rule for named constants is to give them names that consist entirely of upper case letters, with underscore characters to separate words if necessary. For example, the preferred style for the interest rate constant would be final static double INTEREST RATE = 0.05; This is the style that is generally used in Java’s standard classes, which define many named constants. For example, we have already seen that the Math class contains a variable Math.PI. This variable is declared in the Math class as a “public final static” variable of type double.
- 172. 156 CHAPTER 4. SUBROUTINES Similarly, the Color class contains named constants such as Color.RED and Color.YELLOW which are public final static variables of type Color. Many named constants are created just to give meaningful names to be used as parameters in subroutine calls. For example, the standard class named Font contains named constants Font.PLAIN, Font.BOLD, and Font.ITALIC. These constants are used for specifying different styles of text when calling various subroutines in the Font class. Enumerated type constants (See Subsection 2.3.3.) are also examples of named constants. The enumerated type definition enum Alignment { LEFT, RIGHT, CENTER } defines the constants Alignment.LEFT, Alignment.RIGHT, and Alignment.CENTER. Technically, Alignment is a class, and the three constants are public final static members of that class. Defining the enumerated type is similar to defining three constants of type, say, int: public static final int ALIGNMENT LEFT = 0; public static final int ALIGNMNENT RIGHT = 1; public static final int ALIGNMENT CENTER = 2; In fact, this is how things were generally done before the introduction of enumerated types in Java 5.0, and it is what is done with the constants Font.PLAIN, Font.BOLD, and Font.ITALIC mentioned above. Using the integer constants, you could define a variable of type int and assign it the values ALIGNMENT LEFT, ALIGNMENT RIGHT, or ALIGNMENT CENTER to represent different types of alignment. The only problem with this is that the computer has no way of knowing that you intend the value of the variable to represent an alignment, and it will not raise any objection if the value that is assigned to the variable is not one of the three valid alignment values. With the enumerated type, on the other hand, the only values that can be assigned to a variable of type Alignment are the constant values that are listed in the definition of the enumerated type. Any attempt to assign an invalid value to the variable is a syntax error which the computer will detect when the program is compiled. This extra safety is one of the major advantages of enumerated types. ∗ ∗ ∗ Curiously enough, one of the major reasons to use named constants is that it’s easy to change the value of a named constant. Of course, the value can’t change while the program is running. But between runs of the program, it’s easy to change the value in the source code and recompile the program. Consider the interest rate example. It’s quite possible that the value of the interest rate is used many times throughout the program. Suppose that the bank changes the interest rate and the program has to be modified. If the literal number 0.05 were used throughout the program, the programmer would have to track down each place where the interest rate is used in the program and change the rate to the new value. (This is made even harder by the fact that the number 0.05 might occur in the program with other meanings besides the interest rate, as well as by the fact that someone might have used 0.025 to represent half the interest rate.) On the other hand, if the named constant INTEREST RATE is declared and used consistently throughout the program, then only the single line where the constant is initialized needs to be changed. As an extended example, I will give a new version of the RandomMosaicWalk program from the previous section. This version uses named constants to represent the number of rows in the mosaic, the number of columns, and the size of each little square. The three constants are declared as final static member variables with the lines:
- 173. 4.7. THE TRUTH ABOUT DECLARATIONS 157 final static int ROWS = 30; // Number of rows in mosaic. final static int COLUMNS = 30; // Number of columns in mosaic. final static int SQUARE SIZE = 15; // Size of each square in mosaic. The rest of the program is carefully modified to use the named constants. For example, in the new version of the program, the Mosaic window is opened with the statement Mosaic.open(ROWS, COLUMNS, SQUARE SIZE, SQUARE SIZE); Sometimes, it’s not easy to find all the places where a named constant needs to be used. If you don’t use the named constant consistently, you’ve more or less defeated the purpose. It’s always a good idea to run a program using several different values for any named constants, to test that it works properly in all cases. Here is the complete new program, RandomMosaicWalk2, with all modifications from the previous version shown in italic. I’ve left out some of the comments to save space. public class RandomMosaicWalk2 { final static int ROWS = 30; // Number of rows in mosaic. final static int COLUMNS = 30; // Number of columns in mosaic. final static int SQUARE SIZE = 15; // Size of each square in mosaic. static int currentRow; // Row currently containing the disturbance. static int currentColumn; // Column currently containing disturbance. public static void main(String[] args) { Mosaic.open( ROWS, COLUMNS, SQUARE SIZE, SQUARE SIZE ); fillWithRandomColors(); currentRow = ROWS / 2; // start at center of window currentColumn = COLUMNS / 2; while (Mosaic.isOpen()) { changeToRandomColor(currentRow, currentColumn); randomMove(); Mosaic.delay(20); } } // end main static void fillWithRandomColors() { for (int row=0; row < ROWS; row++) { for (int column=0; column < COLUMNS; column++) { changeToRandomColor(row, column); } } } // end fillWithRandomColors static void changeToRandomColor(int rowNum, int colNum) { int red = (int)(256*Math.random()); // Choose random levels in range int green = (int)(256*Math.random()); // 0 to 255 for red, green, int blue = (int)(256*Math.random()); // and blue color components. Mosaic.setColor(rowNum,colNum,red,green,blue); } // end changeToRandomColor static void randomMove() { int directionNum; // Randomly set to 0, 1, 2, or 3 to choose direction. directionNum = (int)(4*Math.random()); switch (directionNum) { case 0: // move up
- 174. 158 CHAPTER 4. SUBROUTINES currentRow--; if (currentRow < 0) currentRow = ROWS - 1; break; case 1: // move right currentColumn++; if (currentColumn >= COLUMNS) currentColumn = 0; break; case 2: // move down currentRow ++; if (currentRow >= ROWS) currentRow = 0; break; case 3: // move left currentColumn--; if (currentColumn < 0) currentColumn = COLUMNS - 1; break; } } // end randomMove } // end class RandomMosaicWalk2 4.7.3 Naming and Scope Rules When a variable declaration is executed, memory is allocated for that variable. The variable name can be used in at least some part of the program source code to refer to that memory or to the data that is stored in the memory. The portion of the program source code where the variable name is valid is called the scope of the variable. Similarly, we can refer to the scope of subroutine names and formal parameter names. For static member subroutines, scope is straightforward. The scope of a static subroutine is the entire source code of the class in which it is defined. That is, it is possible to call the subroutine from any point in the class, including at a point in the source code before the point where the definition of the subroutine appears. It is even possible to call a subroutine from within itself. This is an example of something called “recursion,” a fairly advanced topic that we will return to later. For a variable that is declared as a static member variable in a class, the situation is similar, but with one complication. It is legal to have a local variable or a formal parameter that has the same name as a member variable. In that case, within the scope of the local variable or parameter, the member variable is hidden. Consider, for example, a class named Game that has the form: public class Game { static int count; // member variable static void playGame() { int count; // local variable . . // Some statements to define playGame() . }
- 175. 4.7. THE TRUTH ABOUT DECLARATIONS 159 . . // More variables and subroutines. . } // end Game In the statements that make up the body of the playGame() subroutine, the name “count” refers to the local variable. In the rest of the Game class, “count” refers to the member vari- able, unless hidden by other local variables or parameters named count. However, there is one further complication. The member variable named count can also be referred to by the full name Game.count. Usually, the full name is only used outside the class where count is defined. However, there is no rule against using it inside the class. The full name, Game.count, can be used inside the playGame() subroutine to refer to the member variable. So, the full scope rule is that the scope of a static member variable includes the entire class in which it is defined, but where the simple name of the member variable is hidden by a local variable or formal parameter name, the member variable must be referred to by its full name of the form hclassNamei.hvariableNamei. (Scope rules for non-static members are similar to those for static members, except that, as we shall see, non-static members cannot be used in static subroutines.) The scope of a formal parameter of a subroutine is the block that makes up the body of the subroutine. The scope of a local variable extends from the declaration statement that defines the variable to the end of the block in which the declaration occurs. As noted above, it is possible to declare a loop control variable of a for loop in the for statement, as in “for (int i=0; i < 10; i++)”. The scope of such a declaration is considered as a special case: It is valid only within the for statement and does not extend to the remainder of the block that contains the for statement. It is not legal to redefine the name of a formal parameter or local variable within its scope, even in a nested block. For example, this is not allowed: void badSub(int y) { int x; while (y > 0) { int x; // ERROR: x is already defined. . . . } } In many languages, this would be legal; the declaration of x in the while loop would hide the original declaration. It is not legal in Java; however, once the block in which a variable is declared ends, its name does become available for reuse in Java. For example: void goodSub(int y) { while (y > 10) { int x; . . . // The scope of x ends here. } while (y > 0) {
- 176. 160 CHAPTER 4. SUBROUTINES int x; // OK: Previous declaration of x has expired. . . . } } You might wonder whether local variable names can hide subroutine names. This can’t happen, for a reason that might be surprising. There is no rule that variables and subroutines have to have different names. The computer can always tell whether a name refers to a variable or to a subroutine, because a subroutine name is always followed by a left parenthesis. It’s perfectly legal to have a variable called count and a subroutine called count in the same class. (This is one reason why I often write subroutine names with parentheses, as when I talk about the main() routine. It’s a good idea to think of the parentheses as part of the name.) Even more is true: It’s legal to reuse class names to name variables and subroutines. The syntax rules of Java guarantee that the computer can always tell when a name is being used as a class name. A class name is a type, and so it can be used to declare variables and formal parameters and to specify the return type of a function. This means that you could legally have a class called Insanity in which you declare a function static Insanity Insanity( Insanity Insanity ) { ... } The first Insanity is the return type of the function. The second is the function name, the third is the type of the formal parameter, and the fourth is a formal parameter name. However, please remember that not everything that is possible is a good idea!
- 177. Exercises 161 Exercises for Chapter 4 1. To “capitalize” a string means to change the first letter of each word in the string to upper case (if it is not already upper case). For example, a capitalized version of “Now is the time to act!” is “Now Is The Time To Act!”. Write a subroutine named printCapitalized that will print a capitalized version of a string to standard output. The string to be printed should be a parameter to the subroutine. Test your subroutine with a main() routine that gets a line of input from the user and applies the subroutine to it. Note that a letter is the first letter of a word if it is not immediately preceded in the string by another letter. Recall that there is a standard boolean-valued function Character.isLetter(char) that can be used to test whether its parameter is a letter. There is another standard char-valued function, Character.toUpperCase(char), that returns a capitalized version of the single character passed to it as a parameter. That is, if the parameter is a letter, it returns the upper-case version. If the parameter is not a letter, it just returns a copy of the parameter. 2. The hexadecimal digits are the ordinary, base-10 digits ’0’ through ’9’ plus the letters ’A’ through ’F’. In the hexadecimal system, these digits represent the values 0 through 15, respectively. Write a function named hexValue that uses a switch statement to find the hexadecimal value of a given character. The character is a parameter to the function, and its hexadecimal value is the return value of the function. You should count lower case letters ’a’ through ’f’ as having the same value as the corresponding upper case letters. If the parameter is not one of the legal hexadecimal digits, return -1 as the value of the function. A hexadecimal integer is a sequence of hexadecimal digits, such as 34A7, FF8, 174204, or FADE. If str is a string containing a hexadecimal integer, then the corresponding base-10 integer can be computed as follows: value = 0; for ( i = 0; i < str.length(); i++ ) value = value*16 + hexValue( str.charAt(i) ); Of course, this is not valid if str contains any characters that are not hexadecimal digits. Write a program that reads a string from the user. If all the characters in the string are hexadecimal digits, print out the corresponding base-10 value. If not, print out an error message. 3. Write a function that simulates rolling a pair of dice until the total on the dice comes up to be a given number. The number that you are rolling for is a parameter to the function. The number of times you have to roll the dice is the return value of the function. The parameter should be one of the possible totals: 2, 3, . . . , 12. The function should throw an IllegalArgumentException if this is not the case. Use your function in a program that computes and prints the number of rolls it takes to get snake eyes. (Snake eyes means that the total showing on the dice is 2.) 4. This exercise builds on Exercise 4.3. Every time you roll the dice repeatedly, trying to get a given total, the number of rolls it takes can be different. The question naturally arises, what’s the average number of rolls to get a given total? Write a function that performs the experiment of rolling to get a given total 10000 times. The desired total is
- 178. 162 CHAPTER 4. SUBROUTINES a parameter to the subroutine. The average number of rolls is the return value. Each individual experiment should be done by calling the function you wrote for Exercise 4.3. Now, write a main program that will call your function once for each of the possible totals (2, 3, ..., 12). It should make a table of the results, something like: Total On Dice Average Number of Rolls ------------- ----------------------- 2 35.8382 3 18.0607 . . . . 5. The sample program RandomMosaicWalk.java from Section 4.6 shows a “disturbance” that wanders around a grid of colored squares. When the disturbance visits a square, the color of that square is changed. The applet at the bottom of Section 4.7 in the on-line version of this book shows a variation on this idea. In this applet, all the squares start out with the default color, black. Every time the disturbance visits a square, a small amount is added to the red component of the color of that square. Write a subroutine that will add 25 to the red component of one of the squares in the mosaic. The row and column numbers of the square should be passed as parameters to the subroutine. Recall that you can discover the current red component of the square in row r and column c with the function call Mosaic.getRed(r,c). Use your subroutine as a substitute for the changeToRandomColor() subroutine in the program RandomMosaicWalk2.java. (This is the improved version of the program from Section 4.7 that uses named constants for the number of rows, number of columns, and square size.) Set the number of rows and the number of columns to 80. Set the square size to 5. 6. For this exercise, you will write another program based on the non-standard Mosaic class that was presented in Section 4.6. While the program does not do anything particularly interesting, it’s interesting as a programming problem. An applet that does the same thing as the program can be seen in the on-line version of this book. Here is a picture showing what it looks like at several different times: The program will show a rectangle that grows from the center of the applet to the edges, getting brighter as it grows. The rectangle is made up of the little squares of the mosaic. You should first write a subroutine that draws a rectangle on a Mosaic window. More specifically, write a subroutine named rectangle such that the subroutine call statement rectangle(top,left,height,width,r,g,b);
- 179. Exercises 163 will call Mosaic.setColor(row,col,r,g,b) for each little square that lies on the outline of a rectangle. The topmost row of the rectangle is specified by top. The number of rows in the rectangle is specified by height (so the bottommost row is top+height-1). The leftmost column of the rectangle is specified by left. The number of columns in the rectangle is specified by width (so the rightmost column is left+width-1.) The animation loops through the same sequence of steps over and over. In each step, a rectangle is drawn in gray (that is, with all three color components having the same value). There is a pause of 200 milliseconds so the user can see the rectangle. Then the very same rectangle is drawn in black, effectively erasing the gray rectangle. Finally, the variables giving the top row, left column, size, and color level of the rectangle are adjusted to get ready for the next step. In the applet, the color level starts at 50 and increases by 10 after each step. When the rectangle gets to the outer edge of the applet, the loop ends. The animation then starts again at the beginning of the loop. You might want to make a subroutine that does one loop through all the steps of the animation. The main() routine simply opens a Mosaic window and then does the animation loop over and over until the user closes the window. There is a 1000 millisecond delay between one animation loop and the next. Use a Mosaic window that has 41 rows and 41 columns. (I advise you not to used named constants for the numbers of rows and columns, since the problem is complicated enough already.)
- 180. 164 CHAPTER 4. SUBROUTINES Quiz on Chapter 4 1. A “black box” has an interface and an implementation. Explain what is meant by the terms interface and implementation. 2. A subroutine is said to have a contract. What is meant by the contract of a subroutine? When you want to use a subroutine, why is it important to understand its contract? The contract has both “syntactic” and “semantic” aspects. What is the syntactic aspect? What is the semantic aspect? 3. Briefly explain how subroutines can be a useful tool in the top-down design of programs. 4. Discuss the concept of parameters. What are parameters for? What is the difference between formal parameters and actual parameters? 5. Give two different reasons for using named constants (declared with the final modifier). 6. What is an API? Give an example. 7. Write a subroutine named “stars” that will output a line of stars to standard output. (A star is the character “*”.) The number of stars should be given as a parameter to the subroutine. Use a for loop. For example, the command “stars(20)” would output ******************** 8. Write a main() routine that uses the subroutine that you wrote for Question 7 to output 10 lines of stars with 1 star in the first line, 2 stars in the second line, and so on, as shown below. * ** *** **** ***** ****** ******* ******** ********* ********** 9. Write a function named countChars that has a String and a char as parameters. The function should count the number of times the character occurs in the string, and it should return the result as the value of the function. 10. Write a subroutine with three parameters of type int. The subroutine should determine which of its parameters is smallest. The value of the smallest parameter should be returned as the value of the subroutine.
- 181. Chapter 5 Programming in the Large II: Objects and Classes Whereas a subroutine represents a single task, an object can encapsulate both data (in the form of instance variables) and a number of different tasks or “behaviors” related to that data (in the form of instance methods). Therefore objects provide another, more sophisticated type of structure that can be used to help manage the complexity of large programs. This chapter covers the creation and use of objects in Java. Section 5.5 covers the central ideas of object-oriented programming: inheritance and polymorphism. However, in this text- book, we will generally use these ideas in a limited form, by creating independent classes and building on existing classes rather than by designing entire hierarchies of classes from scratch. Section 5.6 and Section 5.7 cover some of the many details of object oriented programming in Java. Although these details are used occasionally later in the book, you might want to skim through them now and return to them later when they are actually needed. 5.1 Objects, Instance Methods, and Instance Variables Object-oriented programming (OOP) represents an attempt to make programs more closely model the way people think about and deal with the world. In the older styles of programming, a programmer who is faced with some problem must identify a computing task that needs to be performed in order to solve the problem. Programming then consists of finding a sequence of instructions that will accomplish that task. But at the heart of object- oriented programming, instead of tasks we find objects—entities that have behaviors, that hold information, and that can interact with one another. Programming consists of designing a set of objects that somehow model the problem at hand. Software objects in the program can represent real or abstract entities in the problem domain. This is supposed to make the design of the program more natural and hence easier to get right and easier to understand. To some extent, OOP is just a change in point of view. We can think of an object in standard programming terms as nothing more than a set of variables together with some subroutines for manipulating those variables. In fact, it is possible to use object-oriented techniques in any programming language. However, there is a big difference between a language that makes OOP possible and one that actively supports it. An object-oriented programming language such as Java includes a number of features that make it very different from a standard language. In order to make effective use of those features, you have to “orient” your thinking correctly. 165
- 182. 166 CHAPTER 5. OBJECTS AND CLASSES 5.1.1 Objects, Classes, and Instances Objects are closely related to classes. We have already been working with classes for several chapters, and we have seen that a class can contain variables and subroutines. If an object is also a collection of variables and subroutines, how do they differ from classes? And why does it require a different type of thinking to understand and use them effectively? In the one section where we worked with objects rather than classes, Section 3.8, it didn’t seem to make much difference: We just left the word “static” out of the subroutine definitions! I have said that classes “describe” objects, or more exactly that the non-static portions of classes describe objects. But it’s probably not very clear what this means. The more usual terminology is to say that objects belong to classes, but this might not be much clearer. (There is a real shortage of English words to properly distinguish all the concepts involved. An object certainly doesn’t “belong” to a class in the same way that a member variable “belongs” to a class.) From the point of view of programming, it is more exact to say that classes are used to create objects. A class is a kind of factory for constructing objects. The non-static parts of the class specify, or describe, what variables and subroutines the objects will contain. This is part of the explanation of how objects differ from classes: Objects are created and destroyed as the program runs, and there can be many objects with the same structure, if they are created using the same class. Consider a simple class whose job is to group together a few static member variables. For example, the following class could be used to store information about the person who is using the program: class UserData { static String name; static int age; } In a program that uses this class, there is only one copy of each of the variables UserData.name and UserData.age. There can only be one “user,” since we only have memory space to store data about one user. The class, UserData, and the variables it contains exist as long as the program runs. Now, consider a similar class that includes non-static variables: class PlayerData { String name; int age; } In this case, there is no such variable as PlayerData.name or PlayerData.age, since name and age are not static members of PlayerData. So, there is nothing much in the class at all— except the potential to create objects. But, it’s a lot of potential, since it can be used to create any number of objects! Each object will have its own variables called name and age. There can be many “players” because we can make new objects to represent new players on demand. A program might use this class to store information about multiple players in a game. Each player has a name and an age. When a player joins the game, a new PlayerData object can be created to represent that player. If a player leaves the game, the PlayerData object that represents that player can be destroyed. A system of objects in the program is being used to dynamically model what is happening in the game. You can’t do this with “static” variables! In Section 3.8, we worked with applets, which are objects. The reason they didn’t seem to be any different from classes is because we were only working with one applet in each class that we looked at. But one class can be used to make many applets. Think of an applet that scrolls
- 183. 5.1. OBJECTS AND INSTANCE METHODS 167 a message across a Web page. There could be several such applets on the same page, all created from the same class. If the scrolling message in the applet is stored in a non-static variable, then each applet will have its own variable, and each applet can show a different message. The situation is even clearer if you think about windows, which, like applets, are objects. As a program runs, many windows might be opened and closed, but all those windows can belong to the same class. Here again, we have a dynamic situation where multiple objects are created and destroyed as a program runs. ∗ ∗ ∗ An object that belongs to a class is said to be an instance of that class. The variables that the object contains are called instance variables. The subroutines that the object contains are called instance methods. (Recall that in the context of object-oriented programming, method is a synonym for “subroutine”. From now on, since we are doing object-oriented programming, I will prefer the term “method.”) For example, if the PlayerData class, as defined above, is used to create an object, then that object is an instance of the PlayerData class, and name and age are instance variables in the object. It is important to remember that the class of an object determines the types of the instance variables; however, the actual data is contained inside the individual objects, not the class. Thus, each object has its own set of data. An applet that scrolls a message across a Web page might include a subroutine named scroll(). Since the applet is an object, this subroutine is an instance method of the applet. The source code for the method is in the class that is used to create the applet. Still, it’s better to think of the instance method as belonging to the object, not to the class. The non-static subroutines in the class merely specify the instance methods that every object created from the class will contain. The scroll() methods in two different applets do the same thing in the sense that they both scroll messages across the screen. But there is a real difference between the two scroll() methods. The messages that they scroll can be different. You might say that the method definition in the class specifies what type of behavior the objects will have, but the specific behavior can vary from object to object, depending on the values of their instance variables. As you can see, the static and the non-static portions of a class are very different things and serve very different purposes. Many classes contain only static members, or only non-static. However, it is possible to mix static and non-static members in a single class, and we’ll see a few examples later in this chapter where it is reasonable to do so. You should distiguish between the source code for the class, and the class itself. The source code determines both the class and the objects that are created from that class. The “static” definitions in the source code specify the things that are part of the class itself, whereas the non-static definitions in the source code specify things that will become part of every instance object that is created from the class. By the way, static member variables and static member subroutines in a class are sometimes called class variables and class methods, since they belong to the class itself, rather than to instances of that class. 5.1.2 Fundamentals of Objects So far, I’ve been talking mostly in generalities, and I haven’t given you much idea what you have to put in a program if you want to work with objects. Let’s look at a specific example to see how it works. Consider this extremely simplified version of a Student class, which could be used to store information about students taking a course:
- 184. 168 CHAPTER 5. OBJECTS AND CLASSES public class Student { public String name; // Student’s name. public double test1, test2, test3; // Grades on three tests. public double getAverage() { // compute average test grade return (test1 + test2 + test3) / 3; } } // end of class Student None of the members of this class are declared to be static, so the class exists only for creating objects. This class definition says that any object that is an instance of the Student class will include instance variables named name, test1, test2, and test3, and it will include an instance method named getAverage(). The names and tests in different objects will generally have different values. When called for a particular student, the method getAverage() will compute an average using that student’s test grades. Different students can have different averages. (Again, this is what it means to say that an instance method belongs to an individual object, not to the class.) In Java, a class is a type, similar to the built-in types such as int and boolean. So, a class name can be used to specify the type of a variable in a declaration statement, the type of a formal parameter, or the return type of a function. For example, a program could define a variable named std of type Student with the statement Student std; However, declaring a variable does not create an object! This is an important point, which is related to this Very Important Fact: In Java, no variable can ever hold an object. A variable can only hold a reference to an object. You should think of objects as floating around independently in the computer’s memory. In fact, there is a special portion of memory called the heap where objects live. Instead of holding an object itself, a variable holds the information necessary to find the object in memory. This information is called a reference or pointer to the object. In effect, a reference to an object is the address of the memory location where the object is stored. When you use a variable of class type, the computer uses the reference in the variable to find the actual object. In a program, objects are created using an operator called new, which creates an object and returns a reference to that object. For example, assuming that std is a variable of type Student, declared as above, the assignment statement std = new Student(); would create a new object which is an instance of the class Student, and it would store a reference to that object in the variable std. The value of the variable is a reference to the object, not the object itself. It is not quite true, then, to say that the object is the “value of the variable std” (though sometimes it is hard to avoid using this terminology). It is certainly not at all true to say that the object is “stored in the variable std.” The proper terminology is that “the variable std refers to the object,” and I will try to stick to that terminology as much as possible. So, suppose that the variable std refers to an object belonging to the class Student. That object has instance variables name, test1, test2, and test3. These instance variables can
- 185. 5.1. OBJECTS AND INSTANCE METHODS 169 be referred to as std.name, std.test1, std.test2, and std.test3. This follows the usual naming convention that when B is part of A, then the full name of B is A.B. For example, a program might include the lines System.out.println("Hello, " + std.name + ". Your test grades are:"); System.out.println(std.test1); System.out.println(std.test2); System.out.println(std.test3); This would output the name and test grades from the object to which std refers. Simi- larly, std can be used to call the getAverage() instance method in the object by saying std.getAverage(). To print out the student’s average, you could say: System.out.println( "Your average is " + std.getAverage() ); More generally, you could use std.name any place where a variable of type String is legal. You can use it in expressions. You can assign a value to it. You can even use it to call subroutines from the String class. For example, std.name.length() is the number of characters in the student’s name. It is possible for a variable like std, whose type is given by a class, to refer to no object at all. We say in this case that std holds a null reference. The null reference is written in Java as “null”. You can store a null reference in the variable std by saying std = null; and you could test whether the value of std is null by testing if (std == null) . . . If the value of a variable is null, then it is, of course, illegal to refer to instance variables or instance methods through that variable—since there is no object, and hence no instance variables to refer to. For example, if the value of the variable std is null, then it would be illegal to refer to std.test1. If your program attempts to use a null reference illegally like this, the result is an error called a null pointer exception. Let’s look at a sequence of statements that work with objects: Student std, std1, // Declare four variables of std2, std3; // type Student. std = new Student(); // Create a new object belonging // to the class Student, and // store a reference to that // object in the variable std. std1 = new Student(); // Create a second Student object // and store a reference to // it in the variable std1. std2 = std1; // Copy the reference value in std1 // into the variable std2. std3 = null; // Store a null reference in the // variable std3. std.name = "John Smith"; // Set values of some instance variables. std1.name = "Mary Jones"; // (Other instance variables have default // initial values of zero.)
- 186. 170 CHAPTER 5. OBJECTS AND CLASSES After the computer executes these statements, the situation in the computer’s memory looks like this: This picture shows variables as little boxes, labeled with the names of the variables. Objects are shown as boxes with round corners. When a variable contains a reference to an object, the value of that variable is shown as an arrow pointing to the object. The variable std3, with a value of null, doesn’t point anywhere. The arrows from std1 and std2 both point to the same object. This illustrates a Very Important Point: When one object variable is assigned to another, only a reference is copied. The object referred to is not copied. When the assignment “std2 = std1;” was executed, no new object was created. Instead, std2 was set to refer to the very same object that std1 refers to. This has some consequences that might be surprising. For example, std1.name and std2.name are two different names for the same variable, namely the instance variable in the object that both std1 and std2 refer to. After the string "Mary Jones" is assigned to the variable std1.name, it is also true that the value of std2.name is "Mary Jones". There is a potential for a lot of confusion here, but you can help protect yourself from it if you keep telling yourself, “The object is not in the variable. The variable just holds a pointer to the object.” You can test objects for equality and inequality using the operators == and !=, but here again, the semantics are different from what you are used to. When you make a test “if (std1 == std2)”, you are testing whether the values stored in std1 and std2 are the same. But the values are references to objects, not objects. So, you are testing whether std1 and std2 refer to the same object, that is, whether they point to the same location
- 187. 5.1. OBJECTS AND INSTANCE METHODS 171 in memory. This is fine, if its what you want to do. But sometimes, what you want to check is whether the instance variables in the objects have the same values. To do that, you would need to ask whether “std1.test1 == std2.test1 && std1.test2 == std2.test2 && std1.test3 == std2.test3 && std1.name.equals(std2.name)”. I’ve remarked previously that Strings are objects, and I’ve shown the strings "Mary Jones" and "John Smith" as objects in the above illustration. A variable of type String can only hold a reference to a string, not the string itself. It could also hold the value null, meaning that it does not refer to any string at all. This explains why using the == operator to test strings for equality is not a good idea. Suppose that greeting is a variable of type String, and that the string it refers to is "Hello". Then would the test greeting == "Hello" be true? Well, maybe, maybe not. The variable greeting and the String literal "Hello" each refer to a string that contains the characters H-e-l-l-o. But the strings could still be different objects, that just happen to contain the same characters. The function greeting.equals("Hello") tests whether greeting and "Hello" contain the same characters, which is almost certainly the question you want to ask. The expression greeting == "Hello" tests whether greeting and "Hello" contain the same characters stored in the same memory location. ∗ ∗ ∗ The fact that variables hold references to objects, not objects themselves, has a couple of other consequences that you should be aware of. They follow logically, if you just keep in mind the basic fact that the object is not stored in the variable. The object is somewhere else; the variable points to it. Suppose that a variable that refers to an object is declared to be final. This means that the value stored in the variable can never be changed, once the variable has been initialized. The value stored in the variable is a reference to the object. So the variable will continue to refer to the same object as long as the variable exists. However, this does not prevent the data in the object from changing. The variable is final, not the object. It’s perfectly legal to say final Student stu = new Student(); stu.name = "John Doe"; // Change data in the object; // The value stored in stu is not changed! // It still refers to the same object. Next, suppose that obj is a variable that refers to an object. Let’s consider what happens when obj is passed as an actual parameter to a subroutine. The value of obj is assigned to a formal parameter in the subroutine, and the subroutine is executed. The subroutine has no power to change the value stored in the variable, obj. It only has a copy of that value. However, that value is a reference to an object. Since the subroutine has a reference to the object, it can change the data stored in the object. After the subroutine ends, obj still points to the same object, but the data stored in the object might have changed. Suppose x is a variable of type int and stu is a variable of type Student. Compare: void dontChange(int z) { void change(Student s) { z = 42; s.name = "Fred"; } } The lines: The lines: x = 17; stu.name = "Jane"; dontChange(x); change(stu); System.out.println(x); System.out.println(stu.name);
- 188. 172 CHAPTER 5. OBJECTS AND CLASSES output the value 17. output the value "Fred". The value of x is not The value of stu is not changed by the subroutine, changed, but stu.name is. which is equivalent to This is equivalent to z = x; s = stu; z = 42; s.name = "Fred"; 5.1.3 Getters and Setters When writing new classes, it’s a good idea to pay attention to the issue of access control. Recall that making a member of a class public makes it accessible from anywhere, including from other classes. On the other hand, a private member can only be used in the class where it is defined. In the opinion of many programmers, almost all member variables should be declared private. This gives you complete control over what can be done with the variable. Even if the variable itself is private, you can allow other classes to find out what its value is by pro- viding a public accessor method that returns the value of the variable. For example, if your class contains a private member variable, title, of type String, you can provide a method public String getTitle() { return title; } that returns the value of title. By convention, the name of an accessor method for a variable is obtained by capitalizing the name of variable and adding “get” in front of the name. So, for the variable title, we get an accessor method named “get” + “Title”, or getTitle(). Because of this naming convention, accessor methods are more often referred to as getter methods. A getter method provides “read access” to a variable. You might also want to allow “write access” to a private variable. That is, you might want to make it possible for other classes to specify a new value for the variable. This is done with a setter method. (If you don’t like simple, Anglo-Saxon words, you can use the fancier term mutator method.) The name of a setter method should consist of “set” followed by a capitalized copy of the variable’s name, and it should have a parameter with the same type as the variable. A setter method for the variable title could be written public void setTitle( String newTitle ) { title = newTitle; } It is actually very common to provide both a getter and a setter method for a private member variable. Since this allows other classes both to see and to change the value of the variable, you might wonder why not just make the variable public? The reason is that getters and setters are not restricted to simply reading and writing the variable’s value. In fact, they can take any action at all. For example, a getter method might keep track of the number of times that the variable has been accessed: public String getTitle() { titleAccessCount++; // Increment member variable titleAccessCount. return title; } and a setter method might check that the value that is being assigned to the variable is legal:
- 189. 5.2. CONSTRUCTORS AND OBJECT INITIALIZATION 173 public void setTitle( String newTitle ) { if ( newTitle == null ) // Don’t allow null strings as titles! title = "(Untitled)"; // Use an appropriate default value instead. else title = newTitle; } Even if you can’t think of any extra chores to do in a getter or setter method, you might change your mind in the future when you redesign and improve your class. If you’ve used a getter and setter from the beginning, you can make the modification to your class without affecting any of the classes that use your class. The private member variable is not part of the public interface of your class; only the public getter and setter methods are. If you haven’t used get and set from the beginning, you’ll have to contact everyone who uses your class and tell them, “Sorry guys, you’ll have to track down every use that you’ve made of this variable and change your code to use my new get and set methods instead.” A couple of final notes: Some advanced aspects of Java rely on the naming convention for getter and setter methods, so it’s a good idea to follow the convention rigorously. And though I’ve been talking about using getter and setter methods for a variable, you can define get and set methods even if there is no variable. A getter and/or setter method defines a property of the class, that might or might not correspond to a variable. For example, if a class includes a public void instance method with signature setValue(double), then the class has a “property” named value of type double, and it has this property whether or not the class has a member variable named value. 5.2 Constructors and Object Initialization Object types in Java are very different from the primitive types. Simply declaring a variable whose type is given as a class does not automatically create an object of that class. Objects must be explicitly constructed. For the computer, the process of constructing an object means, first, finding some unused memory in the heap that can be used to hold the object and, second, filling in the object’s instance variables. As a programmer, you don’t care where in memory the object is stored, but you will usually want to exercise some control over what initial values are stored in a new object’s instance variables. In many cases, you will also want to do more complicated initialization or bookkeeping every time an object is created. 5.2.1 Initializing Instance Variables An instance variable can be assigned an initial value in its declaration, just like any other variable. For example, consider a class named PairOfDice. An object of this class will represent a pair of dice. It will contain two instance variables to represent the numbers showing on the dice and an instance method for rolling the dice: public class PairOfDice { public int die1 = 3; // Number showing on the first die. public int die2 = 4; // Number showing on the second die. public void roll() { // Roll the dice by setting each of the dice to be // a random number between 1 and 6. die1 = (int)(Math.random()*6) + 1;
- 190. 174 CHAPTER 5. OBJECTS AND CLASSES die2 = (int)(Math.random()*6) + 1; } } // end class PairOfDice The instance variables die1 and die2 are initialized to the values 3 and 4 respectively. These initializations are executed whenever a PairOfDice object is constructed. It’s important to understand when and how this happens. There can be many PairOfDice objects. Each time one is created, it gets its own instance variables, and the assignments “die1 = 3” and “die2 = 4” are executed to fill in the values of those variables. To make this clearer, consider a variation of the PairOfDice class: public class PairOfDice { public int die1 = (int)(Math.random()*6) + 1; public int die2 = (int)(Math.random()*6) + 1; public void roll() { die1 = (int)(Math.random()*6) + 1; die2 = (int)(Math.random()*6) + 1; } } // end class PairOfDice Here, the dice are initialized to random values, as if a new pair of dice were being thrown onto the gaming table. Since the initialization is executed for each new object, a set of random initial values will be computed for each new pair of dice. Different pairs of dice can have different initial values. For initialization of static member variables, of course, the situation is quite different. There is only one copy of a static variable, and initialization of that variable is executed just once, when the class is first loaded. If you don’t provide any initial value for an instance variable, a default initial value is pro- vided automatically. Instance variables of numerical type (int, double, etc.) are automatically initialized to zero if you provide no other values; boolean variables are initialized to false; and char variables, to the Unicode character with code number zero. An instance variable can also be a variable of object type. For such variables, the default initial value is null. (In particular, since Strings are objects, the default initial value for String variables is null.) 5.2.2 Constructors Objects are created with the operator, new. For example, a program that wants to use a PairOfDice object could say: PairOfDice dice; // Declare a variable of type PairOfDice. dice = new PairOfDice(); // Construct a new object and store a // reference to it in the variable. In this example, “new PairOfDice()” is an expression that allocates memory for the object, initializes the object’s instance variables, and then returns a reference to the object. This reference is the value of the expression, and that value is stored by the assignment statement in the variable, dice, so that after the assignment statement is executed, dice refers to the newly created object. Part of this expression, “PairOfDice()”, looks like a subroutine call, and that is no accident. It is, in fact, a call to a special type of subroutine called a constructor. This might puzzle you, since there is no such subroutine in the class definition. However, every class has at least one constructor. If the programmer doesn’t write a constructor definition in a class,
- 191. 5.2. CONSTRUCTORS AND OBJECT INITIALIZATION 175 then the system will provide a default constructor for that class. This default constructor does nothing beyond the basics: allocate memory and initialize instance variables. If you want more than that to happen when an object is created, you can include one or more constructors in the class definition. The definition of a constructor looks much like the definition of any other subroutine, with three exceptions. A constructor does not have any return type (not even void). The name of the constructor must be the same as the name of the class in which it is defined. The only modifiers that can be used on a constructor definition are the access modifiers public, private, and protected. (In particular, a constructor can’t be declared static.) However, a constructor does have a subroutine body of the usual form, a block of statements. There are no restrictions on what statements can be used. And it can have a list of formal parameters. In fact, the ability to include parameters is one of the main reasons for using constructors. The parameters can provide data to be used in the construction of the object. For example, a constructor for the PairOfDice class could provide the values that are initially showing on the dice. Here is what the class would look like in that case: public class PairOfDice { public int die1; // Number showing on the first die. public int die2; // Number showing on the second die. public PairOfDice(int val1, int val2) { // Constructor. Creates a pair of dice that // are initially showing the values val1 and val2. die1 = val1; // Assign specified values die2 = val2; // to the instance variables. } public void roll() { // Roll the dice by setting each of the dice to be // a random number between 1 and 6. die1 = (int)(Math.random()*6) + 1; die2 = (int)(Math.random()*6) + 1; } } // end class PairOfDice The constructor is declared as “public PairOfDice(int val1, int val2) ...”, with no return type and with the same name as the name of the class. This is how the Java com- piler recognizes a constructor. The constructor has two parameters, and values for these parameters must be provided when the constructor is called. For example, the expression “new PairOfDice(3,4)” would create a PairOfDice object in which the values of the instance variables die1 and die2 are initially 3 and 4. Of course, in a program, the value returned by the constructor should be used in some way, as in PairOfDice dice; // Declare a variable of type PairOfDice. dice = new PairOfDice(1,1); // Let dice refer to a new PairOfDice // object that initially shows 1, 1. Now that we’ve added a constructor to the PairOfDice class, we can no longer create an object by saying “new PairOfDice()”! The system provides a default constructor for a class only if the class definition does not already include a constructor, so there is only one constructor in the class, and it requires two actual parameters. However, this is not a big
- 192. 176 CHAPTER 5. OBJECTS AND CLASSES problem, since we can add a second constructor to the class, one that has no parameters. In fact, you can have as many different constructors as you want, as long as their signatures are different, that is, as long as they have different numbers or types of formal parameters. In the PairOfDice class, we might have a constructor with no parameters which produces a pair of dice showing random numbers: public class PairOfDice { public int die1; // Number showing on the first die. public int die2; // Number showing on the second die. public PairOfDice() { // Constructor. Rolls the dice, so that they initially // show some random values. roll(); // Call the roll() method to roll the dice. } public PairOfDice(int val1, int val2) { // Constructor. Creates a pair of dice that // are initially showing the values val1 and val2. die1 = val1; // Assign specified values die2 = val2; // to the instance variables. } public void roll() { // Roll the dice by setting each of the dice to be // a random number between 1 and 6. die1 = (int)(Math.random()*6) + 1; die2 = (int)(Math.random()*6) + 1; } } // end class PairOfDice Now we have the option of constructing a PairOfDice object either with “new PairOfDice()” or with “new PairOfDice(x,y)”, where x and y are int-valued expressions. This class, once it is written, can be used in any program that needs to work with one or more pairs of dice. None of those programs will ever have to use the obscure incantation “(int)(Math.random()*6)+1”, because it’s done inside the PairOfDice class. And the pro- grammer, having once gotten the dice-rolling thing straight will never have to worry about it again. Here, for example, is a main program that uses the PairOfDice class to count how many times two pairs of dice are rolled before the two pairs come up showing the same value. This illustrates once again that you can create several instances of the same class: public class RollTwoPairs { public static void main(String[] args) { PairOfDice firstDice; // Refers to the first pair of dice. firstDice = new PairOfDice(); PairOfDice secondDice; // Refers to the second pair of dice. secondDice = new PairOfDice(); int countRolls; // Counts how many times the two pairs of // dice have been rolled. int total1; // Total showing on first pair of dice. int total2; // Total showing on second pair of dice.
- 193. 5.2. CONSTRUCTORS AND OBJECT INITIALIZATION 177 countRolls = 0; do { // Roll the two pairs of dice until totals are the same. firstDice.roll(); // Roll the first pair of dice. total1 = firstDice.die1 + firstDice.die2; // Get total. System.out.println("First pair comes up " + total1); secondDice.roll(); // Roll the second pair of dice. total2 = secondDice.die1 + secondDice.die2; // Get total. System.out.println("Second pair comes up " + total2); countRolls++; // Count this roll. System.out.println(); // Blank line. } while (total1 != total2); System.out.println("It took " + countRolls + " rolls until the totals were the same."); } // end main() } // end class RollTwoPairs ∗ ∗ ∗ Constructors are subroutines, but they are subroutines of a special type. They are certainly not instance methods, since they don’t belong to objects. Since they are responsible for creating objects, they exist before any objects have been created. They are more like static member subroutines, but they are not and cannot be declared to be static. In fact, according to the Java language specification, they are technically not members of the class at all! In particular, constructors are not referred to as “methods.” Unlike other subroutines, a constructor can only be called using the new operator, in an expression that has the form new hclass-namei ( hparameter-listi ) where the hparameter-listi is possibly empty. I call this an expression because it computes and returns a value, namely a reference to the object that is constructed. Most often, you will store the returned reference in a variable, but it is also legal to use a constructor call in other ways, for example as a parameter in a subroutine call or as part of a more complex expression. Of course, if you don’t save the reference in a variable, you won’t have any way of referring to the object that was just created. A constructor call is more complicated than an ordinary subroutine or function call. It is helpful to understand the exact steps that the computer goes through to execute a constructor call: 1. First, the computer gets a block of unused memory in the heap, large enough to hold an object of the specified type. 2. It initializes the instance variables of the object. If the declaration of an instance variable specifies an initial value, then that value is computed and stored in the instance variable. Otherwise, the default initial value is used. 3. The actual parameters in the constructor, if any, are evaluated, and the values are assigned to the formal parameters of the constructor.
- 194. 178 CHAPTER 5. OBJECTS AND CLASSES 4. The statements in the body of the constructor, if any, are executed. 5. A reference to the object is returned as the value of the constructor call. The end result of this is that you have a reference to a newly constructed object. You can use this reference to get at the instance variables in that object or to call its instance methods. ∗ ∗ ∗ For another example, let’s rewrite the Student class that was used in Section 1. I’ll add a constructor, and I’ll also take the opportunity to make the instance variable, name, private. public class Student { private String name; // Student’s name. public double test1, test2, test3; // Grades on three tests. Student(String theName) { // Constructor for Student objects; // provides a name for the Student. name = theName; } public String getName() { // Getter method for reading the value of the private // instance variable, name. return name; } public double getAverage() { // Compute average test grade. return (test1 + test2 + test3) / 3; } } // end of class Student An object of type Student contains information about some particular student. The con- structor in this class has a parameter of type String, which specifies the name of that student. Objects of type Student can be created with statements such as: std = new Student("John Smith"); std1 = new Student("Mary Jones"); In the original version of this class, the value of name had to be assigned by a program after it created the object of type Student. There was no guarantee that the programmer would always remember to set the name properly. In the new version of the class, there is no way to create a Student object except by calling the constructor, and that constructor automatically sets the name. The programmer’s life is made easier, and whole hordes of frustrating bugs are squashed before they even have a chance to be born. Another type of guarantee is provided by the private modifier. Since the instance variable, name, is private, there is no way for any part of the program outside the Student class to get at the name directly. The program sets the value of name, indirectly, when it calls the constructor. I’ve provided a function, getName(), that can be used from outside the class to find out the name of the student. But I haven’t provided any setter method or other way to change the name. Once a student object is created, it keeps the same name as long as it exists.
- 195. 5.3. PROGRAMMING WITH OBJECTS 179 5.2.3 Garbage Collection So far, this section has been about creating objects. What about destroying them? In Java, the destruction of objects takes place automatically. An object exists in the heap, and it can be accessed only through variables that hold references to the object. What should be done with an object if there are no variables that refer to it? Such things can happen. Consider the following two statements (though in reality, you’d never do anything like this): Student std = new Student("John Smith"); std = null; In the first line, a reference to a newly created Student object is stored in the variable std. But in the next line, the value of std is changed, and the reference to the Student object is gone. In fact, there are now no references whatsoever to that object stored in any variable. So there is no way for the program ever to use the object again. It might as well not exist. In fact, the memory occupied by the object should be reclaimed to be used for another purpose. Java uses a procedure called garbage collection to reclaim memory occupied by objects that are no longer accessible to a program. It is the responsibility of the system, not the programmer, to keep track of which objects are “garbage.” In the above example, it was very easy to see that the Student object had become garbage. Usually, it’s much harder. If an object has been used for a while, there might be several references to the object stored in several variables. The object doesn’t become garbage until all those references have been dropped. In many other programming languages, it’s the programmer’s responsibility to delete the garbage. Unfortunately, keeping track of memory usage is very error-prone, and many serious program bugs are caused by such errors. A programmer might accidently delete an object even though there are still references to that object. This is called a dangling pointer error, and it leads to problems when the program tries to access an object that is no longer there. Another type of error is a memory leak, where a programmer neglects to delete objects that are no longer in use. This can lead to filling memory with objects that are completely inaccessible, and the program might run out of memory even though, in fact, large amounts of memory are being wasted. Because Java uses garbage collection, such errors are simply impossible. Garbage collection is an old idea and has been used in some programming languages since the 1960s. You might wonder why all languages don’t use garbage collection. In the past, it was considered too slow and wasteful. However, research into garbage collection techniques combined with the incredible speed of modern computers have combined to make garbage collection feasible. Programmers should rejoice. 5.3 Programming with Objects There are several ways in which object-oriented concepts can be applied to the process of designing and writing programs. The broadest of these is object-oriented analysis and design which applies an object-oriented methodology to the earliest stages of program devel- opment, during which the overall design of a program is created. Here, the idea is to identify things in the problem domain that can be modeled as objects. On another level, object-oriented programming encourages programmers to produce generalized software components that can be used in a wide variety of programming projects.
- 196. 180 CHAPTER 5. OBJECTS AND CLASSES Of course, for the most part, you will experience “generalized software components” by using the standard classes that come along with Java. We begin this section by looking at some built-in classes that are used for creating objects. At the end of the section, we will get back to generalities. 5.3.1 Some Built-in Classes Although the focus of object-oriented programming is generally on the design and implementa- tion of new classes, it’s important not to forget that the designers of Java have already provided a large number of reusable classes. Some of these classes are meant to be extended to produce new classes, while others can be used directly to create useful objects. A true mastery of Java requires familiarity with a large number of built-in classes—something that takes a lot of time and experience to develop. In the next chapter, we will begin the study of Java’s GUI classes, and you will encounter other built-in classes throughout the remainder of this book. But let’s take a moment to look at a few built-in classes that you might find useful. A string can be built up from smaller pieces using the + operator, but this is not very efficient. If str is a String and ch is a character, then executing the command “str = str + ch;” involves creating a whole new string that is a copy of str, with the value of ch appended onto the end. Copying the string takes some time. Building up a long string letter by letter would require a surprising amount of processing. The class StringBuffer makes it possible to be efficient about building up a long string from a number of smaller pieces. To do this, you must make an object belonging to the StringBuffer class. For example: StringBuffer buffer = new StringBuffer(); (This statement both declares the variable buffer and initializes it to refer to a newly created StringBuffer object. Combining declaration with initialization was covered in Subsection 4.7.1 and works for objects just as it does for primitive types.) Like a String, a StringBuffer contains a sequence of characters. However, it is possible to add new characters onto the end of a StringBuffer without making a copy of the data that it already contains. If x is a value of any type and buffer is the variable defined above, then the command buffer.append(x) will add x, converted into a string representation, onto the end of the data that was already in the buffer. This command actually modifies the buffer, rather than making a copy, and that can be done efficiently. A long string can be built up in a StringBuffer using a sequence of append() commands. When the string is complete, the function buffer.toString() will return a copy of the string in the buffer as an ordinary value of type String. The StringBuffer class is in the standard package java.lang, so you can use its simple name without importing it. A number of useful classes are collected in the package java.util. For example, this package contains classes for working with collections of objects. We will study these collection classes in Chapter 10. Another class in this package, java.util.Date, is used to represent times. When a Date object is constructed without parameters, the result represents the current date and time, so an easy way to display this information is: System.out.println( new Date() ); Of course, to use the Date class in this way, you must make it available by importing it with one of the statements “import java.util.Date;” or “import java.util.*;” at the beginning of your program. (See Subsection 4.5.3 for a discussion of packages and import.) I will also mention the class java.util.Random. An object belonging to this class is a source of random numbers (or, more precisely pseudorandom numbers). The standard function
- 197. 5.3. PROGRAMMING WITH OBJECTS 181 Math.random() uses one of these objects behind the scenes to generate its random numbers. An object of type Random can generate random integers, as well as random real numbers. If randGen is created with the command: Random randGen = new Random(); and if N is a positive integer, then randGen.nextInt(N) generates a random integer in the range from 0 to N-1. For example, this makes it a little easier to roll a pair of dice. Instead of say- ing “die1 = (int)(6*Math.random())+1;”, one can say “die1 = randGen.nextInt(6)+1;”. (Since you also have to import the class java.util.Random and create the Random object, you might not agree that it is actually easier.) An object of type Random can also be used to generate so-called Gaussian distributed random real numbers. The main point here, again, is that many problems have already been solved, and the solutions are available in Java’s standard classes. If you are faced with a task that looks like it should be fairly common, it might be worth looking through a Java reference to see whether someone has already written a class that you can use. 5.3.2 Wrapper Classes and Autoboxing We have already encountered the classes Double and Integer in Subsection 2.5.7. These classes contain the static methods Double.parseDouble and Integer.parseInteger that are used to convert strings to numerical values. We have also encountered the Character class in some examples, and static methods such as Character.isLetter, which can be used to test whether a given value of type char is a letter. There is a similar class for each of the other primitive types, Long, Short, Byte, Float, and Boolean. These classes are called wrapper classes. Although they contain useful static members, they have another use as well: They are used for creating objects that represent primitive type values. Remember that the primitive types are not classes, and values of primitive type are not objects. However, sometimes it’s useful to treat a primitive value as if it were an object. You can’t do that literally, but you can “wrap” the primitive type value in an object belonging to one of the wrapper classes. For example, an object of type Double contains a single instance variable, of type double. The object is a wrapper for the double value. For example, you can create an object that wraps the double value 6.0221415e23 with Double d = new Double(6.0221415e23); The value of d contains the same information as the value of type double, but it is an object. If you want to retrieve the double value that is wrapped in the object, you can call the function d.doubleValue(). Similarly, you can wrap an int in an object of type Integer, a boolean value in an object of type Boolean, and so on. (As an example of where this would be useful, the collection classes that will be studied in Chapter 10 can only hold objects. If you want to add a primitive type value to a collection, it has to be put into a wrapper object first.) In Java 5.0, wrapper classes have become easier to use. Java 5.0 introduced automatic conversion between a primitive type and the corresponding wrapper class. For example, if you use a value of type int in a context that requires an object of type Integer, the int will automatically be wrapped in an Integer object. For example, you can say Integer answer = 42; and the computer will silently read this as if it were
- 198. 182 CHAPTER 5. OBJECTS AND CLASSES Integer answer = new Integer(42); This is called autoboxing. It works in the other direction, too. For example, if d refers to an object of type Double, you can use d in a numerical expression such as 2*d. The double value inside d is automatically unboxed and multiplied by 2. Autoboxing and unboxing also apply to subroutine calls. For example, you can pass an actual parameter of type int to a subroutine that has a formal parameter of type Integer. In fact, autoboxing and unboxing make it possible in many circumstances to ignore the difference between primitive types and objects. ∗ ∗ ∗ The wrapper classes contain a few other things that deserve to be mentioned. Integer, for example, contains constants Integer.MIN VALUE and Integer.MAX VALUE, which are equal to the largest and smallest possible values of type int, that is, to -2147483648 and 2147483647 respectively. It’s certainly easier to remember the names than the numerical values. There are similar named constants in Long, Short, and Byte. Double and Float also have constants named MIN VALUE and MAX VALUE. MAX VALUE still gives the largest number that can be represented in the given type, but MIN VALUE represents the smallest possible positive value. For type double, Double.MIN VALUE is 4.9 times 10−324. Since double values have only a finite accuracy, they can’t get arbitrarily close to zero. This is the closest they can get without actually being equal to zero. The class Double deserves special mention, since doubles are so much more complicated than integers. The encoding of real numbers into values of type double has room for a few special val- ues that are not real numbers at all in the mathematical sense. These values are given by named constants in class Double: Double.POSITIVE INFINITY, Double.NEGATIVE INFINITY, and Double.NaN. The infinite values can occur as the values of certain mathematical expressions. For example, dividing a positive number by zero will give the result Double.POSITIVE INFINITY. (It’s even more complicated than this, actually, because the double type includes a value called “negative zero”, written -0.0. Dividing a positive number by negative zero gives Double.NEGATIVE INFINITY.) You also get Double.POSITIVE INFINITY whenever the mathe- matical value of an expression is greater than Double.MAX VALUE. For example, 1e200*1e200 is considered to be infinite. The value Double.NaN is even more interesting. “NaN” stands for Not a Number, and it represents an undefined value such as the square root of a negative number or the result of dividing zero by zero. Because of the existence of Double.NaN, no math- ematical operation on real numbers will ever throw an exception; it simply gives Double.NaN as the result. You can test whether a value, x, of type double is infinite or undefined by calling the boolean-valued static functions Double.isInfinite(x) and Double.isNaN(x). (It’s especially important to use Double.isNaN() to test for undefined values, because Double.NaN has re- ally weird behavior when used with relational operators such as ==. In fact, the values of x == Double.NaN and x != Double.NaN are both false, no matter what the value of x, so you really can’t use these expressions to test whether x is Double.NaN.) 5.3.3 The class “Object” We have already seen that one of the major features of object-oriented programming is the ability to create subclasses of a class. The subclass inherits all the properties or behaviors of the class, but can modify and add to what it inherits. In Section 5.5, you’ll learn how to create subclasses. What you don’t know yet is that every class in Java (with just one exception) is a subclass of some other class. If you create a class and don’t explicitly make it a subclass of
- 199. 5.3. PROGRAMMING WITH OBJECTS 183 some other class, then it automatically becomes a subclass of the special class named Object. (Object is the one class that is not a subclass of any other class.) Class Object defines several instance methods that are inherited by every other class. These methods can be used with any object whatsoever. I will mention just one of them here. You will encounter more of them later in the book. The instance method toString() in class Object returns a value of type String that is supposed to be a string representation of the object. You’ve already used this method implicitly, any time you’ve printed out an object or concatenated an object onto a string. When you use an object in a context that requires a string, the object is automatically converted to type String by calling its toString() method. The version of toString that is defined in Object just returns the name of the class that the object belongs to, concatenated with a code number called the hash code of the object; this is not very useful. When you create a class, you can write a new toString() method for it, which will replace the inherited version. For example, we might add the following method to any of the PairOfDice classes from the previous section: public String toString() { // Return a String representation of a pair of dice, where die1 // and die2 are instance variables containing the numbers that are // showing on the two dice. if (die1 == die2) return "double " + die1; else return die1 + " and " + die2; } If dice refers to a PairOfDice object, then dice.toString() will return strings such as “3 and 6”, “5 and 1”, and “double 2”, depending on the numbers showing on the dice. This method would be used automatically to convert dice to type String in a statement such as System.out.println( "The dice came up " + dice ); so this statement might output, “The dice came up 5 and 1” or “The dice came up double 2”. You’ll see another example of a toString() method in the next section. 5.3.4 Object-oriented Analysis and Design Every programmer builds up a stock of techniques and expertise expressed as snippets of code that can be reused in new programs using the tried-and-true method of cut-and-paste: The old code is physically copied into the new program and then edited to customize it as necessary. The problem is that the editing is error-prone and time-consuming, and the whole enterprise is dependent on the programmer’s ability to pull out that particular piece of code from last year’s project that looks like it might be made to fit. (On the level of a corporation that wants to save money by not reinventing the wheel for each new project, just keeping track of all the old wheels becomes a major task.) Well-designed classes are software components that can be reused without editing. A well- designed class is not carefully crafted to do a particular job in a particular program. Instead, it is crafted to model some particular type of object or a single coherent concept. Since objects and concepts can recur in many problems, a well-designed class is likely to be reusable without modification in a variety of projects.
- 200. 184 CHAPTER 5. OBJECTS AND CLASSES Furthermore, in an object-oriented programming language, it is possible to make subclasses of an existing class. This makes classes even more reusable. If a class needs to be customized, a subclass can be created, and additions or modifications can be made in the subclass without making any changes to the original class. This can be done even if the programmer doesn’t have access to the source code of the class and doesn’t know any details of its internal, hidden implementation. ∗ ∗ ∗ The PairOfDice class in the previous section is already an example of a generalized software component, although one that could certainly be improved. The class represents a single, coherent concept, “a pair of dice.” The instance variables hold the data relevant to the state of the dice, that is, the number showing on each of the dice. The instance method represents the behavior of a pair of dice, that is, the ability to be rolled. This class would be reusable in many different programming projects. On the other hand, the Student class from the previous section is not very reusable. It seems to be crafted to represent students in a particular course where the grade will be based on three tests. If there are more tests or quizzes or papers, it’s useless. If there are two people in the class who have the same name, we are in trouble (one reason why numerical student ID’s are often used). Admittedly, it’s much more difficult to develop a general-purpose student class than a general-purpose pair-of-dice class. But this particular Student class is good mostly as an example in a programming textbook. ∗ ∗ ∗ A large programming project goes through a number of stages, starting with specification of the problem to be solved, followed by analysis of the problem and design of a program to solve it. Then comes coding, in which the program’s design is expressed in some actual programming language. This is followed by testing and debugging of the program. After that comes a long period of maintenance, which means fixing any new problems that are found in the program and modifying it to adapt it to changing requirements. Together, these stages form what is called the software life cycle. (In the real world, the ideal of consecutive stages is seldom if ever achieved. During the analysis stage, it might turn out that the specifications are incomplete or inconsistent. A problem found during testing requires at least a brief return to the coding stage. If the problem is serious enough, it might even require a new design. Maintenance usually involves redoing some of the work from previous stages. . . .) Large, complex programming projects are only likely to succeed if a careful, systematic approach is adopted during all stages of the software life cycle. The systematic approach to programming, using accepted principles of good design, is called software engineering. The software engineer tries to efficiently construct programs that verifiably meet their specifications and that are easy to modify if necessary. There is a wide range of “methodologies” that can be applied to help in the systematic design of programs. (Most of these methodologies seem to involve drawing little boxes to represent program components, with labeled arrows to represent relationships among the boxes.) We have been discussing object orientation in programming languages, which is relevant to the coding stage of program development. But there are also object-oriented methodologies for analysis and design. The question in this stage of the software life cycle is, How can one discover or invent the overall structure of a program? As an example of a rather simple object-oriented approach to analysis and design, consider this advice: Write down a description of the problem. Underline all the nouns in that description. The nouns should be considered as candidates for becoming classes or objects in the program design. Similarly, underline all the verbs. These
- 201. 5.4. PROGRAMMING EXAMPLE: CARD, HAND, DECK 185 are candidates for methods. This is your starting point. Further analysis might uncover the need for more classes and methods, and it might reveal that subclassing can be used to take advantage of similarities among classes. This is perhaps a bit simple-minded, but the idea is clear and the general approach can be effective: Analyze the problem to discover the concepts that are involved, and create classes to represent those concepts. The design should arise from the problem itself, and you should end up with a program whose structure reflects the structure of the problem in a natural way. 5.4 Programming Example: Card, Hand, Deck In this section, we look at some specific examples of object-oriented design in a domain that is simple enough that we have a chance of coming up with something reasonably reusable. Consider card games that are played with a standard deck of playing cards (a so-called “poker” deck, since it is used in the game of poker). 5.4.1 Designing the classes In a typical card game, each player gets a hand of cards. The deck is shuffled and cards are dealt one at a time from the deck and added to the players’ hands. In some games, cards can be removed from a hand, and new cards can be added. The game is won or lost depending on the value (ace, 2, . . . , king) and suit (spades, diamonds, clubs, hearts) of the cards that a player receives. If we look for nouns in this description, there are several candidates for objects: game, player, hand, card, deck, value, and suit. Of these, the value and the suit of a card are simple values, and they will just be represented as instance variables in a Card object. In a complete program, the other five nouns might be represented by classes. But let’s work on the ones that are most obviously reusable: card, hand, and deck. If we look for verbs in the description of a card game, we see that we can shuffle a deck and deal a card from a deck. This gives use us two candidates for instance methods in a Deck class: shuffle() and dealCard(). Cards can be added to and removed from hands. This gives two candidates for instance methods in a Hand class: addCard() and removeCard(). Cards are relatively passive things, but we need to be able to determine their suits and values. We will discover more instance methods as we go along. First, we’ll design the deck class in detail. When a deck of cards is first created, it contains 52 cards in some standard order. The Deck class will need a constructor to create a new deck. The constructor needs no parameters because any new deck is the same as any other. There will be an instance method called shuffle() that will rearrange the 52 cards into a random order. The dealCard() instance method will get the next card from the deck. This will be a function with a return type of Card, since the caller needs to know what card is being dealt. It has no parameters—when you deal the next card from the deck, you don’t provide any information to the deck; you just get the next card, whatever it is. What will happen if there are no more cards in the deck when its dealCard() method is called? It should probably be considered an error to try to deal a card from an empty deck, so the deck can throw an exception in that case. But this raises another question: How will the rest of the program know whether the deck is empty? Of course, the program could keep track of how many cards it has used. But the deck itself should know how many cards it has left, so the program should just be able to ask the deck object. We can make this possible by specifying another instance method, cardsLeft(), that returns the number of cards remaining in the deck. This leads to a full specification of all
- 202. 186 CHAPTER 5. OBJECTS AND CLASSES the subroutines in the Deck class: Constructor and instance methods in class Deck: public Deck() // Constructor. Create an unshuffled deck of cards. public void shuffle() // Put all the used cards back into the deck, // and shuffle it into a random order. public int cardsLeft() // As cards are dealt from the deck, the number of // cards left decreases. This function returns the // number of cards that are still left in the deck. public Card dealCard() // Deals one card from the deck and returns it. // Throws an exception if no more cards are left. This is everything you need to know in order to use the Deck class. Of course, it doesn’t tell us how to write the class. This has been an exercise in design, not in programming. In fact, writing the class involves a programming technique, arrays, which will not be covered until Chapter 7. Nevertheless, you can look at the source code, Deck.java, if you want. Even though you won’t understand the implementation, the Javadoc comments give you all the information that you need to understand the interface. With this information, you can use the class in your programs without understanding the implementation. We can do a similar analysis for the Hand class. When a hand object is first created, it has no cards in it. An addCard() instance method will add a card to the hand. This method needs a parameter of type Card to specify which card is being added. For the removeCard() method, a parameter is needed to specify which card to remove. But should we specify the card itself (“Remove the ace of spades”), or should we specify the card by its position in the hand (“Remove the third card in the hand”)? Actually, we don’t have to decide, since we can allow for both options. We’ll have two removeCard() instance methods, one with a parameter of type Card specifying the card to be removed and one with a parameter of type int specifying the position of the card in the hand. (Remember that you can have two methods in a class with the same name, provided they have different types of parameters.) Since a hand can contain a variable number of cards, it’s convenient to be able to ask a hand object how many cards it contains. So, we need an instance method getCardCount() that returns the number of cards in the hand. When I play cards, I like to arrange the cards in my hand so that cards of the same value are next to each other. Since this is a generally useful thing to be able to do, we can provide instance methods for sorting the cards in the hand. Here is a full specification for a reusable Hand class: Constructor and instance methods in class Hand: public Hand() { // Create a Hand object that is initially empty. public void clear() { // Discard all cards from the hand, making the hand empty. public void addCard(Card c) { // Add the card c to the hand. c should be non-null. // If c is null, a NullPointerException is thrown.
- 203. 5.4. PROGRAMMING EXAMPLE: CARD, HAND, DECK 187 public void removeCard(Card c) { // If the specified card is in the hand, it is removed. public void removeCard(int position) { // Remove the card in the specified position from the // hand. Cards are numbered counting from zero. If // the specified position does not exist, then an // exception is thrown. public int getCardCount() { // Return the number of cards in the hand. public Card getCard(int position) { // Get the card from the hand in given position, where // positions are numbered starting from 0. If the // specified position is not the position number of // a card in the hand, an exception is thrown. public void sortBySuit() { // Sorts the cards in the hand so that cards of the same // suit are grouped together, and within a suit the cards // are sorted by value. Note that aces are considered // to have the lowest value, 1. public void sortByValue() { // Sorts the cards in the hand so that cards are sorted into // order of increasing value. Cards with the same value // are sorted by suit. Note that aces are considered // to have the lowest value. Again, you don’t yet know enough to implement this class. But given the source code, Hand.java, you can use the class in your own programming projects. 5.4.2 The Card Class We have covered enough material to write a Card class. The class will have a constructor that specifies the value and suit of the card that is being created. There are four suits, which can be represented by the integers 0, 1, 2, and 3. It would be tough to remember which number represents which suit, so I’ve defined named constants in the Card class to represent the four possibilities. For example, Card.SPADES is a constant that represents the suit, spades. (These constants are declared to be public final static ints. It might be better to use an enumerated type, but for now we will stick to integer-valued constants. I’ll return to the question of using enumerated types in this example at the end of the chapter.) The possible values of a card are the numbers 1, 2, . . . , 13, with 1 standing for an ace, 11 for a jack, 12 for a queen, and 13 for a king. Again, I’ve defined some named constants to represent the values of aces and face cards. (When you read the Card class, you’ll see that I’ve also added support for Jokers.) A Card object can be constructed knowing the value and the suit of the card. For example, we can call the constructor with statements such as: card1 = new Card( Card.ACE, Card.SPADES ); // Construct ace of spades. card2 = new Card( 10, Card.DIAMONDS ); // Construct 10 of diamonds. card3 = new Card( v, s ); // This is OK, as long as v and s // are integer expressions.
- 204. 188 CHAPTER 5. OBJECTS AND CLASSES A Card object needs instance variables to represent its value and suit. I’ve made these private so that they cannot be changed from outside the class, and I’ve provided getter methods getSuit() and getValue() so that it will be possible to discover the suit and value from outside the class. The instance variables are initialized in the constructor, and are never changed after that. In fact, I’ve declared the instance variables suit and value to be final, since they are never changed after they are initialized. (An instance variable can be declared final provided it is either given an initial value in its declaration or is initialized in every constructor in the class.) Finally, I’ve added a few convenience methods to the class to make it easier to print out cards in a human-readable form. For example, I want to be able to print out the suit of a card as the word “Diamonds”, rather than as the meaningless code number 2, which is used in the class to represent diamonds. Since this is something that I’ll probably have to do in many programs, it makes sense to include support for it in the class. So, I’ve provided instance methods getSuitAsString() and getValueAsString() to return string representations of the suit and value of a card. Finally, I’ve defined the instance method toString() to return a string with both the value and suit, such as “Queen of Hearts”. Recall that this method will be used whenever a Card needs to be converted into a String, such as when the card is concatenated onto a string with the + operator. Thus, the statement System.out.println( "Your card is the " + card ); is equivalent to System.out.println( "Your card is the " + card.toString() ); If the card is the queen of hearts, either of these will print out “Your card is the Queen of Hearts”. Here is the complete Card class. It is general enough to be highly reusable, so the work that went into designing, writing, and testing it pays off handsomely in the long run. /** * An object of type Card represents a playing card from a * standard Poker deck, including Jokers. The card has a suit, which * can be spades, hearts, diamonds, clubs, or joker. A spade, heart, * diamond, or club has one of the 13 values: ace, 2, 3, 4, 5, 6, 7, * 8, 9, 10, jack, queen, or king. Note that "ace" is considered to be * the smallest value. A joker can also have an associated value; * this value can be anything and can be used to keep track of several * different jokers. */ public class Card { public final static int SPADES = 0; // Codes for the 4 suits, plus Joker. public final static int HEARTS = 1; public final static int DIAMONDS = 2; public final static int CLUBS = 3; public final static int JOKER = 4; public final static int ACE = 1; // Codes for the non-numeric cards. public final static int JACK = 11; // Cards 2 through 10 have their public final static int QUEEN = 12; // numerical values for their codes. public final static int KING = 13; /**
- 205. 5.4. PROGRAMMING EXAMPLE: CARD, HAND, DECK 189 * This card’s suit, one of the constants SPADES, HEARTS, DIAMONDS, * CLUBS, or JOKER. The suit cannot be changed after the card is * constructed. */ private final int suit; /** * The card’s value. For a normal cards, this is one of the values * 1 through 13, with 1 representing ACE. For a JOKER, the value * can be anything. The value cannot be changed after the card * is constructed. */ private final int value; /** * Creates a Joker, with 1 as the associated value. (Note that * "new Card()" is equivalent to "new Card(1,Card.JOKER)".) */ public Card() { suit = JOKER; value = 1; } /** * Creates a card with a specified suit and value. * @param theValue the value of the new card. For a regular card (non-joker), * the value must be in the range 1 through 13, with 1 representing an Ace. * You can use the constants Card.ACE, Card.JACK, Card.QUEEN, and Card.KING. * For a Joker, the value can be anything. * @param theSuit the suit of the new card. This must be one of the values * Card.SPADES, Card.HEARTS, Card.DIAMONDS, Card.CLUBS, or Card.JOKER. * @throws IllegalArgumentException if the parameter values are not in the * permissible ranges */ public Card(int theValue, int theSuit) { if (theSuit != SPADES && theSuit != HEARTS && theSuit != DIAMONDS && theSuit != CLUBS && theSuit != JOKER) throw new IllegalArgumentException("Illegal playing card suit"); if (theSuit != JOKER && (theValue < 1 || theValue > 13)) throw new IllegalArgumentException("Illegal playing card value"); value = theValue; suit = theSuit; } /** * Returns the suit of this card. * @returns the suit, which is one of the constants Card.SPADES, * Card.HEARTS, Card.DIAMONDS, Card.CLUBS, or Card.JOKER */ public int getSuit() { return suit; } /** * Returns the value of this card. * @return the value, which is one the numbers 1 through 13, inclusive for
- 206. 190 CHAPTER 5. OBJECTS AND CLASSES * a regular card, and which can be any value for a Joker. */ public int getValue() { return value; } /** * Returns a String representation of the card’s suit. * @return one of the strings "Spades", "Hearts", "Diamonds", "Clubs" * or "Joker". */ public String getSuitAsString() { switch ( suit ) { case SPADES: return "Spades"; case HEARTS: return "Hearts"; case DIAMONDS: return "Diamonds"; case CLUBS: return "Clubs"; default: return "Joker"; } } /** * Returns a String representation of the card’s value. * @return for a regular card, one of the strings "Ace", "2", * "3", ..., "10", "Jack", "Queen", or "King". For a Joker, the * string is always a numerical. */ public String getValueAsString() { if (suit == JOKER) return "" + value; else { switch ( value ) { case 1: return "Ace"; case 2: return "2"; case 3: return "3"; case 4: return "4"; case 5: return "5"; case 6: return "6"; case 7: return "7"; case 8: return "8"; case 9: return "9"; case 10: return "10"; case 11: return "Jack"; case 12: return "Queen"; default: return "King"; } } } /** * Returns a string representation of this card, including both * its suit and its value (except that for a Joker with value 1, * the return value is just "Joker"). Sample return values * are: "Queen of Hearts", "10 of Diamonds", "Ace of Spades", * "Joker", "Joker #2"
- 207. 5.4. PROGRAMMING EXAMPLE: CARD, HAND, DECK 191 */ public String toString() { if (suit == JOKER) { if (value == 1) return "Joker"; else return "Joker #" + value; } else return getValueAsString() + " of " + getSuitAsString(); } } // end class Card 5.4.3 Example: A Simple Card Game I will finish this section by presenting a complete program that uses the Card and Deck classes. The program lets the user play a very simple card game called HighLow. A deck of cards is shuffled, and one card is dealt from the deck and shown to the user. The user predicts whether the next card from the deck will be higher or lower than the current card. If the user predicts correctly, then the next card from the deck becomes the current card, and the user makes another prediction. This continues until the user makes an incorrect prediction. The number of correct predictions is the user’s score. My program has a subroutine that plays one game of HighLow. This subroutine has a return value that represents the user’s score in the game. The main() routine lets the user play several games of HighLow. At the end, it reports the user’s average score. I won’t go through the development of the algorithms used in this program, but I encourage you to read it carefully and make sure that you understand how it works. Note in particular that the subroutine that plays one game of HighLow returns the user’s score in the game as its return value. This gets the score back to the main program, where it is needed. Here is the program: /** * This program lets the user play HighLow, a simple card game * that is described in the output statements at the beginning of * the main() routine. After the user plays several games, * the user’s average score is reported. */ public class HighLow { public static void main(String[] args) { System.out.println("This program lets you play the simple card game,"); System.out.println("HighLow. A card is dealt from a deck of cards."); System.out.println("You have to predict whether the next card will be"); System.out.println("higher or lower. Your score in the game is the"); System.out.println("number of correct predictions you make before"); System.out.println("you guess wrong."); System.out.println(); int gamesPlayed = 0; // Number of games user has played. int sumOfScores = 0; // The sum of all the scores from
- 208. 192 CHAPTER 5. OBJECTS AND CLASSES // all the games played. double averageScore; // Average score, computed by dividing // sumOfScores by gamesPlayed. boolean playAgain; // Record user’s response when user is // asked whether he wants to play // another game. do { int scoreThisGame; // Score for one game. scoreThisGame = play(); // Play the game and get the score. sumOfScores += scoreThisGame; gamesPlayed++; TextIO.put("Play again? "); playAgain = TextIO.getlnBoolean(); } while (playAgain); averageScore = ((double)sumOfScores) / gamesPlayed; System.out.println(); System.out.println("You played " + gamesPlayed + " games."); System.out.printf("Your average score was %1.3f.n", averageScore); } // end main() /** * Lets the user play one game of HighLow, and returns the * user’s score on that game. The score is the number of * correct guesses that the user makes. */ private static int play() { Deck deck = new Deck(); // Get a new deck of cards, and // store a reference to it in // the variable, deck. Card currentCard; // The current card, which the user sees. Card nextCard; // The next card in the deck. The user tries // to predict whether this is higher or lower // than the current card. int correctGuesses ; // The number of correct predictions the // user has made. At the end of the game, // this will be the user’s score. char guess; // The user’s guess. ’H’ if the user predicts that // the next card will be higher, ’L’ if the user // predicts that it will be lower. deck.shuffle(); // Shuffle the deck into a random order before // starting the game. correctGuesses = 0; currentCard = deck.dealCard(); TextIO.putln("The first card is the " + currentCard); while (true) { // Loop ends when user’s prediction is wrong. /* Get the user’s prediction, ’H’ or ’L’ (or ’h’ or ’l’). */
- 209. 5.4. PROGRAMMING EXAMPLE: CARD, HAND, DECK 193 TextIO.put("Will the next card be higher (H) or lower (L)? "); do { guess = TextIO.getlnChar(); guess = Character.toUpperCase(guess); if (guess != ’H’ && guess != ’L’) TextIO.put("Please respond with H or L: "); } while (guess != ’H’ && guess != ’L’); /* Get the next card and show it to the user. */ nextCard = deck.dealCard(); TextIO.putln("The next card is " + nextCard); /* Check the user’s prediction. */ if (nextCard.getValue() == currentCard.getValue()) { TextIO.putln("The value is the same as the previous card."); TextIO.putln("You lose on ties. Sorry!"); break; // End the game. } else if (nextCard.getValue() > currentCard.getValue()) { if (guess == ’H’) { TextIO.putln("Your prediction was correct."); correctGuesses++; } else { TextIO.putln("Your prediction was incorrect."); break; // End the game. } } else { // nextCard is lower if (guess == ’L’) { TextIO.putln("Your prediction was correct."); correctGuesses++; } else { TextIO.putln("Your prediction was incorrect."); break; // End the game. } } /* To set up for the next iteration of the loop, the nextCard becomes the currentCard, since the currentCard has to be the card that the user sees, and the nextCard will be set to the next card in the deck after the user makes his prediction. */ currentCard = nextCard; TextIO.putln(); TextIO.putln("The card is " + currentCard); } // end of while loop TextIO.putln(); TextIO.putln("The game is over."); TextIO.putln("You made " + correctGuesses
- 210. 194 CHAPTER 5. OBJECTS AND CLASSES + " correct predictions."); TextIO.putln(); return correctGuesses; } // end play() } // end class 5.5 Inheritance, Polymorphism, and Abstract Classes A class represents a set of objects which share the same structure and behaviors. The class determines the structure of objects by specifying variables that are contained in each instance of the class, and it determines behavior by providing the instance methods that express the behavior of the objects. This is a powerful idea. However, something like this can be done in most programming languages. The central new idea in object-oriented programming—the idea that really distinguishes it from traditional programming—is to allow classes to express the similarities among objects that share some, but not all, of their structure and behavior. Such similarities can be expressed using inheritance and polymorphism. 5.5.1 Extending Existing Classes The topics covered later in this section are relatively advanced aspects of object-oriented pro- gramming. Any programmer should know what is meant by subclass, inheritance, and polymor- phism. However, it will probably be a while before you actually do anything with inheritance except for extending classes that already exist. In the first part of this section, we look at how that is done. In day-to-day programming, especially for programmers who are just beginning to work with objects, subclassing is used mainly in one situation: There is an existing class that can be adapted with a few changes or additions. This is much more common than designing groups of classes and subclasses from scratch. The existing class can be extended to make a subclass. The syntax for this is public class hsubclass-namei extends hexisting-class-namei { . . // Changes and additions. . } As an example, suppose you want to write a program that plays the card game, Blackjack. You can use the Card, Hand, and Deck classes developed in Section 5.4. However, a hand in the game of Blackjack is a little different from a hand of cards in general, since it must be possible to compute the “value” of a Blackjack hand according to the rules of the game. The rules are as follows: The value of a hand is obtained by adding up the values of the cards in the hand. The value of a numeric card such as a three or a ten is its numerical value. The value of a Jack, Queen, or King is 10. The value of an Ace can be either 1 or 11. An Ace should be counted as 11 unless doing so would put the total value of the hand over 21. Note that this means that the second, third, or fourth Ace in the hand will always be counted as 1. One way to handle this is to extend the existing Hand class by adding a method that computes the Blackjack value of the hand. Here’s the definition of such a class:
- 211. 5.5. INHERITANCE AND POLYMORPHISM 195 public class BlackjackHand extends Hand { /** * Computes and returns the value of this hand in the game * of Blackjack. */ public int getBlackjackValue() { int val; // The value computed for the hand. boolean ace; // This will be set to true if the // hand contains an ace. int cards; // Number of cards in the hand. val = 0; ace = false; cards = getCardCount(); for ( int i = 0; i < cards; i++ ) { // Add the value of the i-th card in the hand. Card card; // The i-th card; int cardVal; // The blackjack value of the i-th card. card = getCard(i); cardVal = card.getValue(); // The normal value, 1 to 13. if (cardVal > 10) { cardVal = 10; // For a Jack, Queen, or King. } if (cardVal == 1) { ace = true; // There is at least one ace. } val = val + cardVal; } // Now, val is the value of the hand, counting any ace as 1. // If there is an ace, and if changing its value from 1 to // 11 would leave the score less than or equal to 21, // then do so by adding the extra 10 points to val. if ( ace == true && val + 10 <= 21 ) val = val + 10; return val; } // end getBlackjackValue() } // end class BlackjackHand Since BlackjackHand is a subclass of Hand, an object of type BlackjackHand contains all the instance variables and instance methods defined in Hand, plus the new in- stance method named getBlackjackValue(). For example, if bjh is a variable of type BlackjackHand, then the following are all legal: bjh.getCardCount(), bjh.removeCard(0), and bjh.getBlackjackValue(). The first two methods are defined in Hand, but are inherited by BlackjackHand. Inherited variables and methods from the Hand class can also be used in the definition of BlackjackHand (except for any that are declared to be private, which prevents access even by subclasses). The statement “cards = getCardCount();” in the above definition of getBlackjackValue() calls the instance method getCardCount(), which was defined in Hand.
- 212. 196 CHAPTER 5. OBJECTS AND CLASSES Extending existing classes is an easy way to build on previous work. We’ll see that many standard classes have been written specifically to be used as the basis for making subclasses. ∗ ∗ ∗ Access modifiers such as public and private are used to control access to members of a class. There is one more access modifier, protected, that comes into the picture when subclasses are taken into consideration. When protected is applied as an access modifier to a method or member variable in a class, that member can be used in subclasses—direcct or indirect—of the class in which it is defined, but it cannot be used in non-subclasses. (There is one exception: A protected member can also be accessed by any class in the same package as the class that contains the protected member. Recall that using no access modifier makes a member accessible to classes in the same package, and nowhere else. Using the protected modifier is strictly more liberal than using no modifier at all: It allows access from classes in the same package and from subclasses that are not in the same package.) When you declare a method or member variable to be protected, you are saying that it is part of the implementation of the class, rather than part of the public interface of the class. However, you are allowing subclasses to use and modify that part of the implementation. For example, consider a PairOfDice class that has instance variables die1 and die2 to represent the numbers appearing on the two dice. We could make those variables private to make it impossible to change their values from outside the class, while still allowing read access through getter methods. However, if we think it possible that PairOfDice will be used to create subclasses, we might want to make it possible for subclasses to change the numbers on the dice. For example, a GraphicalDice subclass that draws the dice might want to change the numbers at other times besides when the dice are rolled. In that case, we could make die1 and die2 protected, which would allow the subclass to change their values without making them public to the rest of the world. (An even better idea would be to define protected setter methods for the variables. A setter method could, for example, ensure that the value that is being assigned to the variable is in the legal range 1 through 6.) 5.5.2 Inheritance and Class Hierarchy The term inheritance refers to the fact that one class can inherit part or all of its structure and behavior from another class. The class that does the inheriting is said to be a subclass of the class from which it inherits. If class B is a subclass of class A, we also say that class A is a superclass of class B. (Sometimes the terms derived class and base class are used instead of subclass and superclass; this is the common terminology in C++.) A subclass can add to the structure and behavior that it inherits. It can also replace or modify inherited behavior (though not inherited structure). The relationship between subclass and superclass is sometimes shown by a diagram in which the subclass is shown below, and connected to, its superclass, as shown here on the left.
- 213. 5.5. INHERITANCE AND POLYMORPHISM 197 In Java, to create a class named “B” as a subclass of a class named “A”, you would write class B extends A { . . // additions to, and modifications of, . // stuff inherited from class A . } Several classes can be declared as subclasses of the same superclass. The subclasses, which might be referred to as “sibling classes,” share some structures and behaviors—namely, the ones they inherit from their common superclass. The superclass expresses these shared structures and behaviors. In the diagram shown on the right, above, classes B, C, and D are sibling classes. Inheritance can also extend over several “generations” of classes. This is shown in the diagram, where class E is a subclass of class D which is itself a subclass of class A. In this case, class E is considered to be a subclass of class A, even though it is not a direct subclass. This whole set of classes forms a small class hierarchy. 5.5.3 Example: Vehicles Let’s look at an example. Suppose that a program has to deal with motor vehicles, including cars, trucks, and motorcycles. (This might be a program used by a Department of Motor Vehicles to keep track of registrations.) The program could use a class named Vehicle to represent all types of vehicles. Since cars, trucks, and motorcycles are types of vehicles, they would be represented by subclasses of the Vehicle class, as shown in this class hierarchy diagram: The Vehicle class would include instance variables such as registrationNumber and owner and instance methods such as transferOwnership(). These are variables and methods common to all vehicles. The three subclasses of Vehicle—Car, Truck, and Motorcycle—could then be used to hold variables and methods specific to particular types of vehicles. The Car class might add an instance variable numberOfDoors, the Truck class might have numberOfAxles,
- 214. 198 CHAPTER 5. OBJECTS AND CLASSES and the Motorcycle class could have a boolean variable hasSidecar. (Well, it could in theory at least, even if it might give a chuckle to the people at the Department of Motor Vehicles.) The declarations of these classes in a Java program would look, in outline, like this (although in practice, they would probably be public classes, defined in separate files): class Vehicle { int registrationNumber; Person owner; // (Assuming that a Person class has been defined!) void transferOwnership(Person newOwner) { . . . } . . . } class Car extends Vehicle { int numberOfDoors; . . . } class Truck extends Vehicle { int numberOfAxles; . . . } class Motorcycle extends Vehicle { boolean hasSidecar; . . . } Suppose that myCar is a variable of type Car that has been declared and initialized with the statement Car myCar = new Car(); Given this declaration, a program could refer to myCar.numberOfDoors, since numberOfDoors is an instance variable in the class Car. But since class Car extends class Vehicle, a car also has all the structure and behavior of a vehicle. This means that myCar.registrationNumber, myCar.owner, and myCar.transferOwnership() also exist. Now, in the real world, cars, trucks, and motorcycles are in fact vehicles. The same is true in a program. That is, an object of type Car or Truck or Motorcycle is automatically an object of type Vehicle too. This brings us to the following Important Fact: A variable that can hold a reference to an object of class A can also hold a reference to an object belonging to any subclass of A. The practical effect of this in our example is that an object of type Car can be assigned to a variable of type Vehicle. That is, it would be legal to say Vehicle myVehicle = myCar; or even Vehicle myVehicle = new Car();
- 215. 5.5. INHERITANCE AND POLYMORPHISM 199 After either of these statements, the variable myVehicle holds a reference to a Vehicle object that happens to be an instance of the subclass, Car. The object “remembers” that it is in fact a Car, and not just a Vehicle. Information about the actual class of an object is stored as part of that object. It is even possible to test whether a given object belongs to a given class, using the instanceof operator. The test: if (myVehicle instanceof Car) ... determines whether the object referred to by myVehicle is in fact a car. On the other hand, the assignment statement myCar = myVehicle; would be illegal because myVehicle could potentially refer to other types of vehicles that are not cars. This is similar to a problem we saw previously in Subsection 2.5.6: The computer will not allow you to assign an int value to a variable of type short, because not every int is a short. Similarly, it will not allow you to assign a value of type Vehicle to a variable of type Car because not every vehicle is a car. As in the case of ints and shorts, the solution here is to use type-casting. If, for some reason, you happen to know that myVehicle does in fact refer to a Car, you can use the type cast (Car)myVehicle to tell the computer to treat myVehicle as if it were actually of type Car. So, you could say myCar = (Car)myVehicle; and you could even refer to ((Car)myVehicle).numberOfDoors. As an example of how this could be used in a program, suppose that you want to print out relevant data about a vehicle. You could say: System.out.println("Vehicle Data:"); System.out.println("Registration number: " + myVehicle.registrationNumber); if (myVehicle instanceof Car) { System.out.println("Type of vehicle: Car"); Car c; c = (Car)myVehicle; System.out.println("Number of doors: " + c.numberOfDoors); } else if (myVehicle instanceof Truck) { System.out.println("Type of vehicle: Truck"); Truck t; t = (Truck)myVehicle; System.out.println("Number of axles: " + t.numberOfAxles); } else if (myVehicle instanceof Motorcycle) { System.out.println("Type of vehicle: Motorcycle"); Motorcycle m; m = (Motorcycle)myVehicle; System.out.println("Has a sidecar: " + m.hasSidecar); } Note that for object types, when the computer executes a program, it checks whether type-casts are valid. So, for example, if myVehicle refers to an object of type Truck, then the type cast (Car)myVehicle would be an error. When this happes, an exception of type ClassCastException is thrown.
- 216. 200 CHAPTER 5. OBJECTS AND CLASSES 5.5.4 Polymorphism As another example, consider a program that deals with shapes drawn on the screen. Let’s say that the shapes include rectangles, ovals, and roundrects of various colors. (A “roundrect” is just a rectangle with rounded corners.) Three classes, Rectangle, Oval, and RoundRect, could be used to represent the three types of shapes. These three classes would have a common superclass, Shape, to represent features that all three shapes have in common. The Shape class could include instance variables to represent the color, position, and size of a shape, and it could include instance methods for changing the color, position, and size. Changing the color, for example, might involve changing the value of an instance variable, and then redrawing the shape in its new color: class Shape { Color color; // Color of the shape. (Recall that class Color // is defined in package java.awt. Assume // that this class has been imported.) void setColor(Color newColor) { // Method to change the color of the shape. color = newColor; // change value of instance variable redraw(); // redraw shape, which will appear in new color } void redraw() { // method for drawing the shape ? ? ? // what commands should go here? } . . . // more instance variables and methods } // end of class Shape Now, you might see a problem here with the method redraw(). The problem is that each different type of shape is drawn differently. The method setColor() can be called for any type of shape. How does the computer know which shape to draw when it executes the redraw()? Informally, we can answer the question like this: The computer executes redraw() by asking the shape to redraw itself. Every shape object knows what it has to do to redraw itself. In practice, this means that each of the specific shape classes has its own redraw() method: class Rectangle extends Shape { void redraw() { . . . // commands for drawing a rectangle
- 217. 5.5. INHERITANCE AND POLYMORPHISM 201 } . . . // possibly, more methods and variables } class Oval extends Shape { void redraw() { . . . // commands for drawing an oval } . . . // possibly, more methods and variables } class RoundRect extends Shape { void redraw() { . . . // commands for drawing a rounded rectangle } . . . // possibly, more methods and variables } If oneShape is a variable of type Shape, it could refer to an object of any of the types, Rectangle, Oval, or RoundRect. As a program executes, and the value of oneShape changes, it could even refer to objects of different types at different times! Whenever the statement oneShape.redraw(); is executed, the redraw method that is actually called is the one appropriate for the type of object to which oneShape actually refers. There may be no way of telling, from looking at the text of the program, what shape this statement will draw, since it depends on the value that oneShape happens to have when the program is executed. Even more is true. Suppose the statement is in a loop and gets executed many times. If the value of oneShape changes as the loop is executed, it is possible that the very same statement “oneShape.redraw();” will call different methods and draw different shapes as it is executed over and over. We say that the redraw() method is polymorphic. A method is polymorphic if the action performed by the method depends on the actual type of the object to which the method is applied. Polymorphism is one of the major distinguishing features of object-oriented programming. Perhaps this becomes more understandable if we change our terminology a bit: In object- oriented programming, calling a method is often referred to as sending a message to an object. The object responds to the message by executing the appropriate method. The statement “oneShape.redraw();” is a message to the object referred to by oneShape. Since that object knows what type of object it is, it knows how it should respond to the message. From this point of view, the computer always executes “oneShape.redraw();” in the same way: by sending a message. The response to the message depends, naturally, on who receives it. From this point of view, objects are active entities that send and receive messages, and polymorphism is a natural, even necessary, part of this view. Polymorphism just means that different objects can respond to the same message in different ways. One of the most beautiful things about polymorphism is that it lets code that you write do things that you didn’t even conceive of, at the time you wrote it. Suppose that I decide to add beveled rectangles to the types of shapes my program can deal with. A beveled rectangle has a triangle cut off each corner:
- 218. 202 CHAPTER 5. OBJECTS AND CLASSES To implement beveled rectangles, I can write a new subclass, BeveledRect, of class Shape and give it its own redraw() method. Automatically, code that I wrote previously—such as the statement oneShape.redraw()—can now suddenly start drawing beveled rectangles, even though the beveled rectangle class didn’t exist when I wrote the statement! In the statement “oneShape.redraw();”, the redraw message is sent to the object oneShape. Look back at the method from the Shape class for changing the color of a shape: void setColor(Color newColor) { color = newColor; // change value of instance variable redraw(); // redraw shape, which will appear in new color } A redraw message is sent here, but which object is it sent to? Well, the setColor method is itself a message that was sent to some object. The answer is that the redraw message is sent to that same object, the one that received the setColor message. If that object is a rectangle, then it is the redraw() method from the Rectangle class that is executed. If the object is an oval, then it is the redraw() method from the Oval class. This is what you should expect, but it means that the “redraw();” statement in the setColor() method does not necessarily call the redraw() method in the Shape class! The redraw() method that is executed could be in any subclass of Shape. Again, this is not a real surprise if you think about it in the right way. Remember that an instance method is always contained in an object. The class only contains the source code for the method. When a Rectangle object is created, it contains a redraw() method. The source code for that method is in the Rectangle class. The object also contains a setColor() method. Since the Rectangle class does not define a setColor() method, the source code for the rectangle’s setColor() method comes from the superclass, Shape, but the method itself is in the object of type Rectangle. Even though the source codes for the two methods are in different classes, the methods themselves are part of the same object. When the rectangle’s setColor() method is executed and calls redraw(), the redraw() method that is executed is the one in the same object. 5.5.5 Abstract Classes Whenever a Rectangle, Oval, or RoundRect object has to draw itself, it is the redraw() method in the appropriate class that is executed. This leaves open the question, What does the redraw() method in the Shape class do? How should it be defined? The answer may be surprising: We should leave it blank! The fact is that the class Shape represents the abstract idea of a shape, and there is no way to draw such a thing. Only particular, concrete shapes like rectangles and ovals can be drawn. So, why should there
- 219. 5.5. INHERITANCE AND POLYMORPHISM 203 even be a redraw() method in the Shape class? Well, it has to be there, or it would be illegal to call it in the setColor() method of the Shape class, and it would be illegal to write “oneShape.redraw();”, where oneShape is a variable of type Shape. The compiler would complain that oneShape is a variable of type Shape and there’s no redraw() method in the Shape class. Nevertheless the version of redraw() in the Shape class itself will never actually be called. In fact, if you think about it, there can never be any reason to construct an actual object of type Shape! You can have variables of type Shape, but the objects they refer to will always belong to one of the subclasses of Shape. We say that Shape is an abstract class. An abstract class is one that is not used to construct objects, but only as a basis for making subclasses. An abstract class exists only to express the common properties of all its subclasses. A class that is not abstract is said to be concrete. You can create objects belonging to a concrete class, but not to an abstract class. A variable whose type is given by an abstract class can only refer to objects that belong to concrete subclasses of the abstract class. Similarly, we say that the redraw() method in class Shape is an abstract method, since it is never meant to be called. In fact, there is nothing for it to do—any actual redrawing is done by redraw() methods in the subclasses of Shape. The redraw() method in Shape has to be there. But it is there only to tell the computer that all Shapes understand the redraw message. As an abstract method, it exists merely to specify the common interface of all the actual, concrete versions of redraw() in the subclasses of Shape. There is no reason for the abstract redraw() in class Shape to contain any code at all. Shape and its redraw() method are semantically abstract. You can also tell the computer, syntactically, that they are abstract by adding the modifier “abstract” to their definitions. For an abstract method, the block of code that gives the implementation of an ordinary method is replaced by a semicolon. An implementation must be provided for the abstract method in any concrete subclass of the abstract class. Here’s what the Shape class would look like as an abstract class: public abstract class Shape { Color color; // color of shape. void setColor(Color newColor) { // method to change the color of the shape color = newColor; // change value of instance variable redraw(); // redraw shape, which will appear in new color } abstract void redraw(); // abstract method---must be defined in // concrete subclasses . . . // more instance variables and methods } // end of class Shape Once you have declared the class to be abstract, it becomes illegal to try to create actual objects of type Shape, and the computer will report a syntax error if you try to do so. ∗ ∗ ∗ Recall from Subsection 5.3.3 that a class that is not explicitly declared to be a subclass of some other class is automatically made a subclass of the standard class Object. That is, a class declaration with no “extends” part such as
- 220. 204 CHAPTER 5. OBJECTS AND CLASSES public class myClass { . . . is exactly equivalent to public class myClass extends Object { . . . This means that class Object is at the top of a huge class hierarchy that includes every other class. (Semantially, Object is an abstract class, in fact the most abstract class of all. Curiously, however, it is not declared to be abstract syntactially, which means that you can create objects of type Object. What you would do with them, however, I have no idea.) Since every class is a subclass of Object, a variable of type Object can refer to any object whatsoever, of any type. Java has several standard data structures that are designed to hold Objects, but since every object is an instance of class Object, these data structures can actually hold any object whatsoever. One example is the “ArrayList” data structure, which is defined by the class ArrayList in the package java.util. (ArrayList is discussed more fully in Section 7.3.) An ArrayList is simply a list of Objects. This class is very convenient, because an ArrayList can hold any number of objects, and it will grow, when necessary, as objects are added to it. Since the items in the list are of type Object, the list can actually hold objects of any type. A program that wants to keep track of various Shapes that have been drawn on the screen can store those shapes in an ArrayList. Suppose that the ArrayList is named listOfShapes. A shape, oneShape, can be added to the end of the list by calling the instance method “listOfShapes.add(oneShape);”. The shape can be removed from the list with the instance method “listOfShapes.remove(oneShape);”. The number of shapes in the list is given by the function “listOfShapes.size()”. And it is possible to retrieve the i-th object from the list with the function call “listOfShapes.get(i)”. (Items in the list are numbered from 0 to listOfShapes.size() - 1.) However, note that this method returns an Object, not a Shape. (Of course, the people who wrote the ArrayList class didn’t even know about Shapes, so the method they wrote could hardly have a return type of Shape!) Since you know that the items in the list are, in fact, Shapes and not just Objects, you can type-cast the Object returned by listOfShapes.get(i) to be a value of type Shape: oneShape = (Shape)listOfShapes.get(i); Let’s say, for example, that you want to redraw all the shapes in the list. You could do this with a simple for loop, which is lovely example of object-oriented programming and of polymorphism: for (int i = 0; i < listOfShapes.size(); i++) { Shape s; // i-th element of the list, considered as a Shape s = (Shape)listOfShapes.get(i); s.redraw(); // What is drawn here depends on what type of shape s is! } ∗ ∗ ∗ The sample source code file ShapeDraw.java uses an abstract Shape class and an ArrayList to hold a list of shapes. The file defines an applet in which the user can add various shapes to a drawing area. Once a shape is in the drawing area, the user can use the mouse to drag it around. You might want to look at this file, even though you won’t be able to understand all of it at this time. Even the definitions of the shape classes are somewhat different from those that I have described in this section. (For example, the draw() method has a parameter of type Graphics. This parameter is required because of the way Java handles all drawing.) I’ll return
- 221. 5.6. THIS AND SUPER 205 to this example in later chapters when you know more about GUI programming. However, it would still be worthwhile to look at the definition of the Shape class and its subclasses in the source code. You might also check how an ArrayList is used to hold the list of shapes. In the applet the only time when the actual class of a shape is used is when that shape is added to the screen. Once the shape has been created, it is manipulated entirely as an abstract shape. The routine that implements dragging, for example, works only with variables of type Shape. As the Shape is being dragged, the dragging routine just calls the Shape’s draw method each time the shape has to be drawn, so it doesn’t have to know how to draw the shape or even what type of shape it is. The object is responsible for drawing itself. If I wanted to add a new type of shape to the program, I would define a new subclass of Shape, add another button to the applet, and program the button to add the correct type of shape to the screen. No other changes in the programming would be necessary. If you want to try out the applet, you can find it at the end of the on-line version of this section. 5.6 this and super Although the basic ideas of object-oriented programming are reasonably simple and clear, they are subtle, and they take time to get used to. And unfortunately, beyond the basic ideas there are a lot of details. This section and the next cover more of those annoying details. You should not necessarily master everything in these two sections the first time through, but you should read it to be aware of what is possible. For the most part, when I need to use this material later in the text, I will explain it again briefly, or I will refer you back to it. In this section, we’ll look at two variables, this and super, that are automatically defined in any instance method. 5.6.1 The Special Variable this A static member of a class has a simple name, which can only be used inside the class defi- nition. For use outside the class, it has a full name of the form hclass-namei.hsimple-namei. For example, “System.out” is a static member variable with simple name “out” in the class “System”. It’s always legal to use the full name of a static member, even within the class where it’s defined. Sometimes it’s even necessary, as when the simple name of a static member variable is hidden by a local variable of the same name. Instance variables and instance methods also have simple names. The simple name of such an instance member can be used in instance methods in the class where the instance member is defined. Instance members also have full names, but remember that instance variables and methods are actually contained in objects, not classes. The full name of an instance member has to contain a reference to the object that contains the instance member. To get at an instance variable or method from outside the class definition, you need a variable that refers to the object. Then the full name is of the form hvariable-namei.hsimple-namei. But suppose you are writing the definition of an instance method in some class. How can you get a reference to the object that contains that instance method? You might need such a reference, for example, if you want to use the full name of an instance variable, because the simple name of the instance variable is hidden by a local variable or parameter. Java provides a special, predefined variable named “this” that you can use for such pur- poses. The variable, this, is used in the source code of an instance method to refer to the
- 222. 206 CHAPTER 5. OBJECTS AND CLASSES object that contains the method. This intent of the name, this, is to refer to “this object,” the one right here that this very method is in. If x is an instance variable in the same object, then this.x can be used as a full name for that variable. If otherMethod() is an instance method in the same object, then this.otherMethod() could be used to call that method. Whenever the computer executes an instance method, it automatically sets the variable, this, to refer to the object that contains the method. One common use of this is in constructors. For example: public class Student { private String name; // Name of the student. public Student(String name) { // Constructor. Create a student with specified name. this.name = name; } . . // More variables and methods. . } In the constructor, the instance variable called name is hidden by a formal parameter. How- ever, the instance variable can still be referred to by its full name, this.name. In the assign- ment statement, the value of the formal parameter, name, is assigned to the instance variable, this.name. This is considered to be acceptable style: There is no need to dream up cute new names for formal parameters that are just used to initialize instance variables. You can use the same name for the parameter as for the instance variable. There are other uses for this. Sometimes, when you are writing an instance method, you need to pass the object that contains the method to a subroutine, as an actual parameter. In that case, you can use this as the actual parameter. For example, if you wanted to print out a string representation of the object, you could say “System.out.println(this);”. Or you could assign the value of this to another variable in an assignment statement. In fact, you can do anything with this that you could do with any other variable, except change its value. 5.6.2 The Special Variable super Java also defines another special variable, named “super”, for use in the definitions of instance methods. The variable super is for use in a subclass. Like this, super refers to the object that contains the method. But it’s forgetful. It forgets that the object belongs to the class you are writing, and it remembers only that it belongs to the superclass of that class. The point is that the class can contain additions and modifications to the superclass. super doesn’t know about any of those additions and modifications; it can only be used to refer to methods and variables in the superclass. Let’s say that the class that you are writing contains an instance method named doSomething(). Consider the subroutine call statement super.doSomething(). Now, super doesn’t know anything about the doSomething() method in the subclass. It only knows about things in the superclass, so it tries to execute a method named doSomething() from the superclass. If there is none—if the doSomething() method was an addition rather than a modification—you’ll get a syntax error. The reason super exists is so you can get access to things in the superclass that are hidden by things in the subclass. For example, super.x always refers to an instance variable named
- 223. 5.6. THIS AND SUPER 207 x in the superclass. This can be useful for the following reason: If a class contains an instance variable with the same name as an instance variable in its superclass, then an object of that class will actually contain two variables with the same name: one defined as part of the class itself and one defined as part of the superclass. The variable in the subclass does not replace the variable of the same name in the superclass; it merely hides it. The variable from the superclass can still be accessed, using super. When you write a method in a subclass that has the same signature as a method in its superclass, the method from the superclass is hidden in the same way. We say that the method in the subclass overrides the method from the superclass. Again, however, super can be used to access the method from the superclass. The major use of super is to override a method with a new method that extends the behavior of the inherited method, instead of replacing that behavior entirely. The new method can use super to call the method from the superclass, and then it can add additional code to provide additional behavior. As an example, suppose you have a PairOfDice class that includes a roll() method. Suppose that you want a subclass, GraphicalDice, to represent a pair of dice drawn on the computer screen. The roll() method in the GraphicalDice class should do everything that the roll() method in the PairOfDice class does. We can express this with a call to super.roll(), which calls the method in the superclass. But in addition to that, the roll() method for a GraphicalDice object has to redraw the dice to show the new values. The GraphicalDice class might look something like this: public class GraphicalDice extends PairOfDice { public void roll() { // Roll the dice, and redraw them. super.roll(); // Call the roll method from PairOfDice. redraw(); // Call a method to draw the dice. } . . // More stuff, including definition of redraw(). . } Note that this allows you to extend the behavior of the roll() method even if you don’t know how the method is implemented in the superclass! Here is a more complete example. The applet at the end of Section 4.7 in the on-line version of this book shows a disturbance that moves around in a mosaic of little squares. As it moves, each square it visits become a brighter shade of red. The result looks interesting, but I think it would be prettier if the pattern were symmetric. A symmetric version of the applet is shown at the bottom of the Section 5.7 (in the on-line version). The symmetric applet can be programmed as an easy extension of the original applet. In the symmetric version, each time a square is brightened, the squares that can be obtained from that one by horizontal and vertical reflection through the center of the mosaic are also brightened. This picture might make the symmetry idea clearer:
- 224. 208 CHAPTER 5. OBJECTS AND CLASSES The four red squares in the picture, for example, form a set of such symmetrically placed squares, as do the purple squares and the green squares. (The blue square is at the center of the mosaic, so reflecting it doesn’t produce any other squares; it’s its own reflection.) The original applet is defined by the class RandomBrighten. In that class, the actual task of brightening a square is done by a method called brighten(). If row and col are the row and column numbers of a square, then “brighten(row,col);” increases the brightness of that square. All we need is a subclass of RandomBrighten with a modified brighten() routine. Instead of just brightening one square, the modified routine will also brighten the horizontal and vertical reflections of that square. But how will it brighten each of the four individual squares? By calling the brighten() method from the original class. It can do this by calling super.brighten(). There is still the problem of computing the row and column numbers of the horizontal and vertical reflections. To do this, you need to know the number of rows and the number of columns. The RandomBrighten class has instance variables named ROWS and COLUMNS to represent these quantities. Using these variables, it’s possible to come up with formulas for the reflections, as shown in the definition of the brighten() method below. Here’s the complete definition of the new class: public class SymmetricBrighten extends RandomBrighten { void brighten(int row, int col) { // Brighten the specified square and its horizontal // and vertical reflections. This overrides the brighten // method from the RandomBrighten class, which just // brightens one square. super.brighten(row, col); super.brighten(ROWS - 1 - row, col); super.brighten(row, COLUMNS - 1 - col); super.brighten(ROWS - 1 - row, COLUMNS - 1 - col); } } // end class SymmetricBrighten This is the entire source code for the applet! 5.6.3 Constructors in Subclasses Constructors are not inherited. That is, if you extend an existing class to make a subclass, the constructors in the superclass do not become part of the subclass. If you want constructors in the subclass, you have to define new ones from scratch. If you don’t define any constructors in the subclass, then the computer will make up a default constructor, with no parameters, for you.
- 225. 5.7. INTERFACES, NESTED CLASSES, AND OTHER DETAILS 209 This could be a problem, if there is a constructor in the superclass that does a lot of necessary work. It looks like you might have to repeat all that work in the subclass! This could be a real problem if you don’t have the source code to the superclass, and don’t know how it works, or if the constructor in the superclass initializes private member variables that you don’t even have access to in the subclass! Obviously, there has to be some fix for this, and there is. It involves the special variable, super. As the very first statement in a constructor, you can use super to call a constructor from the superclass. The notation for this is a bit ugly and misleading, and it can only be used in this one particular circumstance: It looks like you are calling super as a subroutine (even though super is not a subroutine and you can’t call constructors the same way you call other subroutines anyway). As an example, assume that the PairOfDice class has a constructor that takes two integers as parameters. Consider a subclass: public class GraphicalDice extends PairOfDice { public GraphicalDice() { // Constructor for this class. super(3,4); // Call the constructor from the // PairOfDice class, with parameters 3, 4. initializeGraphics(); // Do some initialization specific // to the GraphicalDice class. } . . // More constructors, methods, variables... . } The statement “super(3,4);” calls the constructor from the superclass. This call must be the first line of the constructor in the subclass. Note that if you don’t explicitly call a constructor from the superclass in this way, then the default constructor from the superclass, the one with no parameters, will be called automatically. This might seem rather technical, but unfortunately it is sometimes necessary. By the way, you can use the special variable this in exactly the same way to call another constructor in the same class. This can be useful since it can save you from repeating the same code in several constructors. 5.7 Interfaces, Nested Classes, and Other Details THIS SECTION simply pulls together a few more miscellaneous features of object oriented programming in Java. Read it now, or just look through it and refer back to it later when you need this material. (You will need to know about the first topic, interfaces, almost as soon as we begin GUI programming.) 5.7.1 Interfaces Some object-oriented programming languages, such as C++, allow a class to extend two or more superclasses. This is called multiple inheritance. In the illustration below, for example, class E is shown as having both class A and class B as direct superclasses, while class F has three direct superclasses.
- 226. 210 CHAPTER 5. OBJECTS AND CLASSES Such multiple inheritance is not allowed in Java. The designers of Java wanted to keep the language reasonably simple, and felt that the benefits of multiple inheritance were not worth the cost in increased complexity. However, Java does have a feature that can be used to accomplish many of the same goals as multiple inheritance: interfaces. We’ve encountered the term “interface” before, in connection with black boxes in general and subroutines in particular. The interface of a subroutine consists of the name of the subroutine, its return type, and the number and types of its parameters. This is the information you need to know if you want to call the subroutine. A subroutine also has an implementation: the block of code which defines it and which is executed when the subroutine is called. In Java, interface is a reserved word with an additional, technical meaning. An “interface” in this sense consists of a set of instance method interfaces, without any as- sociated implementations. (Actually, a Java interface can contain other things as well, but we won’t discuss them here.) A class can implement an interface by providing an implemen- tation for each of the methods specified by the interface. Here is an example of a very simple Java interface: public interface Drawable { public void draw(Graphics g); } This looks much like a class definition, except that the implementation of the draw() method is omitted. A class that implements the interface Drawable must provide an implementation for this method. Of course, the class can also include other methods and variables. For example, public class Line implements Drawable { public void draw(Graphics g) { . . . // do something---presumably, draw a line } . . . // other methods and variables } Note that to implement an interface, a class must do more than simply provide an implementa- tion for each method in the interface; it must also state that it implements the interface, using the reserved word implements as in this example: “public class Line implements Drawable”. Any class that implements the Drawable interface defines a draw() instance method. Any ob- ject created from such a class includes a draw() method. We say that an object implements
- 227. 5.7. INTERFACES, NESTED CLASSES, AND OTHER DETAILS 211 an interface if it belongs to a class that implements the interface. For example, any object of type Line implements the Drawable interface. While a class can extend only one other class, it can implement any number of interfaces. In fact, a class can both extend one other class and implement one or more interfaces. So, we can have things like class FilledCircle extends Circle implements Drawable, Fillable { . . . } The point of all this is that, although interfaces are not classes, they are something very similar. An interface is very much like an abstract class, that is, a class that can never be used for constructing objects, but can be used as a basis for making subclasses. The subroutines in an interface are abstract methods, which must be implemented in any concrete class that implements the interface. And as with abstract classes, even though you can’t construct an object from an interface, you can declare a variable whose type is given by the interface. For example, if Drawable is an interface, and if Line and FilledCircle are classes that implement Drawable, then you could say: Drawable figure; // Declare a variable of type Drawable. It can // refer to any object that implements the // Drawable interface. figure = new Line(); // figure now refers to an object of class Line figure.draw(g); // calls draw() method from class Line figure = new FilledCircle(); // Now, figure refers to an object // of class FilledCircle. figure.draw(g); // calls draw() method from class FilledCircle A variable of type Drawable can refer to any object of any class that implements the Drawable interface. A statement like figure.draw(g), above, is legal because figure is of type Drawable, and any Drawable object has a draw() method. So, whatever object figure refers to, that object must have a draw() method. Note that a type is something that can be used to declare variables. A type can also be used to specify the type of a parameter in a subroutine, or the return type of a function. In Java, a type can be either a class, an interface, or one of the eight built-in primitive types. These are the only possibilities. Of these, however, only classes can be used to construct new objects. You are not likely to need to write your own interfaces until you get to the point of writing fairly complex programs. However, there are a few interfaces that are used in important ways in Java’s standard packages. You’ll learn about some of these standard interfaces in the next few chapters. 5.7.2 Nested Classes A class seems like it should be a pretty important thing. A class is a high-level building block of a program, representing a potentially complex idea and its associated data and behaviors. I’ve always felt a bit silly writing tiny little classes that exist only to group a few scraps of data together. However, such trivial classes are often useful and even essential. Fortunately, in Java, I can ease the embarrassment, because one class can be nested inside another class. My trivial
- 228. 212 CHAPTER 5. OBJECTS AND CLASSES little class doesn’t have to stand on its own. It becomes part of a larger more respectable class. This is particularly useful when you want to create a little class specifically to support the work of a larger class. And, more seriously, there are other good reasons for nesting the definition of one class inside another class. In Java, a nested class is any class whose definition is inside the definition of another class. Nested classes can be either named or anonymous. I will come back to the topic of anonymous classes later in this section. A named nested class, like most other things that occur in classes, can be either static or non-static. The definition of a static nested class looks just like the definition of any other class, except that it is nested inside another class and it has the modifier static as part of its declaration. A static nested class is part of the static structure of the containing class. It can be used inside that class to create objects in the usual way. If it has not been declared private, then it can also be used outside the containing class, but when it is used outside the class, its name must indicate its membership in the containing class. This is similar to other static components of a class: A static nested class is part of the class itself in the same way that static member variables are parts of the class itself. For example, suppose a class named WireFrameModel represents a set of lines in three- dimensional space. (Such models are used to represent three-dimensional objects in graphics programs.) Suppose that the WireFrameModel class contains a static nested class, Line, that represents a single line. Then, outside of the class WireFrameModel, the Line class would be referred to as WireFrameModel.Line. Of course, this just follows the normal naming convention for static members of a class. The definition of the WireFrameModel class with its nested Line class would look, in outline, like this: public class WireFrameModel { . . . // other members of the WireFrameModel class static public class Line { // Represents a line from the point (x1,y1,z1) // to the point (x2,y2,z2) in 3-dimensional space. double x1, y1, z1; double x2, y2, z2; } // end class Line . . . // other members of the WireFrameModel class } // end WireFrameModel Inside the WireFrameModel class, a Line object would be created with the constructor “new Line()”. Outside the class, “new WireFrameModel.Line()” would be used. A static nested class has full access to the static members of the containing class, even to the private members. Similarly, the containing class has full access to the members of the nested class. This can be another motivation for declaring a nested class, since it lets you give one class access to the private members of another class without making those members generally available to other classes. When you compile the above class definition, two class files will be created. Even though the definition of Line is nested inside WireFrameModel, the compiled Line class is stored in a separate file. The name of the class file for Line will be WireFrameModel$Line.class. ∗ ∗ ∗
- 229. 5.7. INTERFACES, NESTED CLASSES, AND OTHER DETAILS 213 Non-static nested classes are referred to as inner classes. Inner classes are not, in practice, very different from static nested classes, but a non-static nested class is actually associated with an object rather than to the class in which it is nested. This can take some getting used to. Any non-static member of a class is not really part of the class itself (although its source code is contained in the class definition). This is true for inner classes, just as it is for any other non-static part of a class. The non-static members of a class specify what will be contained in objects that are created from that class. The same is true—at least logically—for inner classes. It’s as if each object that belongs to the containing class has its own copy of the nested class. This copy has access to all the instance methods and instance variables of the object, even to those that are declared private. The two copies of the inner class in two different objects differ because the instance variables and methods they refer to are in different objects. In fact, the rule for deciding whether a nested class should be static or non-static is simple: If the nested class needs to use any instance variable or instance method from the containing class, make the nested class non-static. Otherwise, it might as well be static. From outside the containing class, a non-static nested class has to be referred to using a name of the form hvariableNamei.hNestedClassNamei, where hvariableNamei is a variable that refers to the object that contains the class. This is actually rather rare, however. A non-static nested class is generally used only inside the class in which it is nested, and there it can be referred to by its simple name. In order to create an object that belongs to an inner class, you must first have an object that belongs to the containing class. (When working inside the class, the object “this” is used implicitly.) The inner class object is permanently associated with the containing class object, and it has complete access to the members of the containing class object. Looking at an example will help, and will hopefully convince you that inner classes are really very natural. Consider a class that represents poker games. This class might include a nested class to represent the players of the game. This structure of the PokerGame class could be: public class PokerGame { // Represents a game of poker. private class Player { // Represents one of the players in this game. . . . } // end class Player private Deck deck; // A deck of cards for playing the game. private int pot; // The amount of money that has been bet. . . . } // end class PokerGame If game is a variable of type PokerGame, then, conceptually, game contains its own copy of the Player class. In an an instance method of a PokerGame object, a new Player object would be created by saying “new Player()”, just as for any other class. (A Player object could be created outside the PokerGame class with an expression such as “game.new Player()”. Again, however, this is very rare.) The Player object will have access to the deck and pot instance variables in the PokerGame object. Each PokerGame object has its own deck and pot and Players. Players of that poker game use the deck and pot for that game; players of another poker game use the other game’s deck and pot. That’s the effect of making the Player class
- 230. 214 CHAPTER 5. OBJECTS AND CLASSES non-static. This is the most natural way for players to behave. A Player object represents a player of one particular poker game. If Player were a static nested class, on the other hand, it would represent the general idea of a poker player, independent of a particular poker game. 5.7.3 Anonymous Inner Classes In some cases, you might find yourself writing an inner class and then using that class in just a single line of your program. Is it worth creating such a class? Indeed, it can be, but for cases like this you have the option of using an anonymous inner class. An anonymous class is created with a variation of the new operator that has the form new hsuperclass-or-interfacei ( hparameter-listi ) { hmethods-and-variablesi } This constructor defines a new class, without giving it a name, and it simultaneously creates an object that belongs to that class. This form of the new operator can be used in any statement where a regular “new” could be used. The intention of this expression is to create: “a new object belonging to a class that is the same as hsuperclass-or-interfacei but with these hmethods-and- variablesi added.” The effect is to create a uniquely customized object, just at the point in the program where you need it. Note that it is possible to base an anonymous class on an interface, rather than a class. In this case, the anonymous class must implement the interface by defining all the methods that are declared in the interface. If an interface is used as a base, the hparameter-listi must be empty. Otherwise, it can contain parameters for a constructor in the hsuperclassi. Anonymous classes are often used for handling events in graphical user interfaces, and we will encounter them several times in the chapters on GUI programming. For now, we will look at one not-very-plausible example. Consider the Drawable interface, which is defined earlier in this section. Suppose that we want a Drawable object that draws a filled, red, 100-pixel square. Rather than defining a new, separate class and then using that class to create the object, we can use an anonymous class to create the object in one statement: Drawable redSquare = new Drawable() { void draw(Graphics g) { g.setColor(Color.red); g.fillRect(10,10,100,100); } }; The semicolon at the end of this statement is not part of the class definition. It’s the semicolon that is required at the end of every declaration statement. When a Java class is compiled, each anonymous nested class will produce a separate class file. If the name of the main class is MainClass, for example, then the names of the class files for the anonymous nested classes will be MainClass$1.class, MainClass$2.class, MainClass$3.class, and so on. 5.7.4 Mixing Static and Non-static Classes, as I’ve said, have two very distinct purposes. A class can be used to group together a set of static member variables and static member subroutines. Or it can be used as a factory for making objects. The non-static variables and subroutines in the class definition specify the
- 231. 5.7. INTERFACES, NESTED CLASSES, AND OTHER DETAILS 215 instance variables and methods of the objects. In most cases, a class performs one or the other of these roles, not both. Sometimes, however, static and non-static members are mixed in a single class. In this case, the class plays a dual role. Sometimes, these roles are completely separate. It is also possible for the static and non-static parts of a class to interact. This happens when instance methods use static member variables or call static member subroutines. An instance method belongs to an object, not to the class itself, and there can be many objects with their own versions of the instance method. But there is only one copy of a static member variable. So, effectively, we have many objects sharing that one variable. Suppose, for example, that we want to write a PairOfDice class that uses the Random class mentioned in Section 5.3 for rolling the dice. To do this, a PairOfDice object needs access to an object of type Random. But there is no need for each PairOfDice object to have a separate Random object. (In fact, it would not even be a good idea: Because of the way random number generators work, a program should, in general, use only one source of random numbers.) A nice solution is to have a single Random variable as a static member of the PairOfDice class, so that it can be shared by all PairOfDice objects. For example: import java.util.Random; public class PairOfDice { private static Random randGen = new Random(); public int die1; // Number showing on the first die. public int die2; // Number showing on the second die. public PairOfDice() { // Constructor. Creates a pair of dice that // initially shows random values. roll(); } public void roll() { // Roll the dice by setting each of the dice to be // a random number between 1 and 6. die1 = randGen.nextInt(6) + 1; die2 = randGen.nextInt(6) + 1; } } // end class PairOfDice As another example, let’s rewrite the Student class that was used in Section 5.2. I’ve added an ID for each student and a static member called nextUniqueID. Although there is an ID variable in each student object, there is only one nextUniqueID variable. public class Student { private String name; // Student’s name. private int ID; // Unique ID number for this student. public double test1, test2, test3; // Grades on three tests. private static int nextUniqueID = 0; // keep track of next available unique ID number Student(String theName) { // Constructor for Student objects; provides a name for the Student,
- 232. 216 CHAPTER 5. OBJECTS AND CLASSES // and assigns the student a unique ID number. name = theName; nextUniqueID++; ID = nextUniqueID; } public String getName() { // Accessor method for reading value of private // instance variable, name. return name; } public int getID() { // Accessor method for reading value of ID. return ID; } public double getAverage() { // Compute average test grade. return (test1 + test2 + test3) / 3; } } // end of class Student The initialization “nextUniqueID = 0” is done only once, when the class is first loaded. Whenever a Student object is constructed and the constructor says “nextUniqueID++;”, it’s always the same static member variable that is being incremented. When the very first Student object is created, nextUniqueID becomes 1. When the second object is created, nextUniqueID becomes 2. After the third object, it becomes 3. And so on. The constructor stores the new value of nextUniqueID in the ID variable of the object that is being created. Of course, ID is an instance variable, so every object has its own individual ID variable. The class is constructed so that each student will automatically get a different value for its ID variable. Furthermore, the ID variable is private, so there is no way for this variable to be tampered with after the object has been created. You are guaranteed, just by the way the class is designed, that every student object will have its own permanent, unique identification number. Which is kind of cool if you think about it. 5.7.5 Static Import The import directive makes it possible to refer to a class such as java.awt.Color using its simple name, Color. All you have to do is say import java.awt.Color or import java.awt.*. But you still have to use compound names to refer to static member variables such as System.out and to static methods such as Math.sqrt. Java 5.0 introduced a new form of the import directive that can be used to import static members of a class in the same way that the ordinary import directive imports classes from a package. The new form of the directive is called a static import, and it has syntax import static hpackage-namei.hclass-namei.hstatic-member-namei; to import one static member name from a class, or import static hpackage-namei.hclass-namei.*; to import all the public static members from a class. For example, if you preface a class definition with
- 233. 5.7. INTERFACES, NESTED CLASSES, AND OTHER DETAILS 217 import static java.lang.System.out; then you can use the simple name out instead of the compound name System.out. This means you can use out.println instead of System.out.println. If you are going to work extensively with the Math class, you can preface your class definition with import static java.lang.Math.*; This would allow you to say sqrt instead of Math.sqrt, log instead of Math.log, PI instead of Math.PI, and so on. Note that the static import directive requires a hpackage-namei, even for classes in the standard package java.lang. One consequence of this is that you can’t do a static import from a class in the default package. In particular, it is not possible to do a static import from my TextIO class—if you wanted to do that, you would have to move TextIO into a package. 5.7.6 Enums as Classes Enumerated types were introduced in Subsection 2.3.3. Now that we have covered more material on classes and objects, we can revisit the topic (although still not covering enumerated types in their full complexity). Enumerated types are actually classes, and each enumerated type constant is a public, final, static member variable in that class (even though they are not declared with these modifiers). The value of the variable is an object belonging to the enumerated type class. There is one such object for each enumerated type constant, and these are the only objects of the class that can ever be created. It is really these objects that represent the possible values of the enumerated type. The enumerated type constants are actually variables that refer to these objects. When an enumerated type is defined inside another class, it is a nested class inside the enclosing class. In fact, it is a static nested class, whether you declare it to be static or not. But it can also be declared as a non-nested class, in a file of its own. For example, we could define the following enumerated type in a file named Suit.java: public enum Suit { SPADES, HEARTS, DIAMONDS, CLUBS } This enumerated type represents the four possible suits for a playing card, and it could have been used in the example Card.java from Subsection 5.4.2. Furthermore, in addition to its list of values, an enumerated type can contain some of the other things that a regular class can contain, including methods and additional member variables. Just add a semicolon (;) at the end of the list of values, and then add definitions of the methods and variables in the usual way. For example, we might make an enumerated type to represent the possible values of a playing card. It might be useful to have a method that returns the corresponding value in the game of Blackjack. As another example, suppose that when we print out one of the values, we’d like to see something different from the default string representation (the identifier that names the constant). In that case, we can override the toString() method in the class to print out a different string representation. This would gives something like: public enum CardValue {
- 234. 218 CHAPTER 5. OBJECTS AND CLASSES ACE, TWO, THREE, FOUR, FIVE, SIX, SEVEN, EIGHT, NINE, TEN, JACK, QUEEN, KING; /** * Return the value of this CardValue in the game of Blackjack. * Note that the value returned for an ace is 1. */ public int blackJackValue() { if (this == JACK || this == QUEEN || this == KING) return 10; else return 1 + ordinal(); } /** * Return a String representation of this CardValue, using numbers * for the numerical cards and names for the ace and face cards. */ public String toString() { switch (this) { // "this" is one of the enumerated type values case ACE: // ordinal number of ACE return "Ace"; case JACK: // ordinal number of JACK return "Jack"; case QUEEN: // ordinal number of QUEEN return "Queen"; case KING: // ordinal number of KING return "King"; default: // it’s a numeric card value int numericValue = 1 + ordinal(); return "" + numericValue; } } // end CardValue The methods blackjackValue() and toString() are instance methods in Card- Value. Since CardValue.JACK is an object belonging to that class, you can call CardValue.JACK.blackjackValue(). Suppose that cardVal is declared to be a variable of type CardValue, so that it can refer to any of the values in the enumerated type. We can call cardVal.blackjackValue() to find the Blackjack value of the CardValue object to which cardVal refers, and System.out.println(cardVal) will implicitly call the method cardVal.toString() to obtain the print representation of that CardValue. (One other thing to keep in mind is that since CardValue is a class, the value of cardVal can be null, which means it does not refer to any object.) Remember that ACE, TWO, . . . , KING are the only possible objects of type CardValue, so in an instance method in that class, this will refer to one of those values. Recall that the instance method ordinal() is defined in any enumerated type and gives the position of the enumerated type value in the list of possible values, with counting starting from zero. (If you find it annoying to use the class name as part of the name of every enumerated type constant, you can use static import to make the simple names of the constants directly available—but only if you put the enumerated type into a package. For example, if the enu- merated type CardValue is defined in a package named cardgames, then you could place import static cardgames.CardValue.*;
- 235. 5.7. INTERFACES, NESTED CLASSES, AND OTHER DETAILS 219 at the beginning of a source code file. This would allow you, for example, to use the name JACK in that file instead of CardValue.JACK.)
- 236. 220 CHAPTER 5. OBJECTS AND CLASSES Exercises for Chapter 5 1. In all versions of the PairOfDice class in Section 5.2, the instance variables die1 and die2 are declared to be public. They really should be private, so that they are protected from being changed from outside the class. Write another version of the PairOfDice class in which the instance variables die1 and die2 are private. Your class will need “getter” methods that can be used to find out the values of die1 and die2. (The idea is to protect their values from being changed from outside the class, but still to allow the values to be read.) Include other improvements in the class, if you can think of any. Test your class with a short program that counts how many times a pair of dice is rolled, before the total of the two dice is equal to two. 2. A common programming task is computing statistics of a set of numbers. (A statistic is a number that summarizes some property of a set of data.) Common statistics include the mean (also known as the average) and the standard deviation (which tells how spread out the data are from the mean). I have written a little class called StatCalc that can be used to compute these statistics, as well as the sum of the items in the dataset and the number of items in the dataset. You can read the source code for this class in the file StatCalc.java. If calc is a variable of type StatCalc, then the following methods are defined: • calc.enter(item); where item is a number, adds the item to the dataset. • calc.getCount() is a function that returns the number of items that have been added to the dataset. • calc.getSum() is a function that returns the sum of all the items that have been added to the dataset. • calc.getMean() is a function that returns the average of all the items. • calc.getStandardDeviation() is a function that returns the standard deviation of the items. Typically, all the data are added one after the other by calling the enter() method over and over, as the data become available. After all the data have been entered, any of the other methods can be called to get statistical information about the data. The methods getMean() and getStandardDeviation() should only be called if the number of items is greater than zero. Modify the current source code, StatCalc.java, to add instance methods getMax() and getMin(). The getMax() method should return the largest of all the items that have been added to the dataset, and getMin() should return the smallest. You will need to add two new instance variables to keep track of the largest and smallest items that have been seen so far. Test your new class by using it in a program to compute statistics for a set of non-zero numbers entered by the user. Start by creating an object of type StatCalc: StatCalc calc; // Object to be used to process the data. calc = new StatCalc(); Read numbers from the user and add them to the dataset. Use 0 as a sentinel value (that is, stop reading numbers when the user enters 0). After all the user’s non-zero
- 237. Exercises 221 numbers have been entered, print out each of the six statistics that are available from calc. 3. This problem uses the PairOfDice class from Exercise 5.1 and the StatCalc class from Exercise 5.2. The program in Exercise 4.4 performs the experiment of counting how many times a pair of dice is rolled before a given total comes up. It repeats this experiment 10000 times and then reports the average number of rolls. It does this whole process for each possible total (2, 3, . . . , 12). Redo that exercise. But instead of just reporting the average number of rolls, you should also report the standard deviation and the maximum number of rolls. Use a PairOfDice object to represent the dice. Use a StatCalc object to compute the statistics. (You’ll need a new StatCalc object for each possible total, 2, 3, . . . , 12. You can use a new pair of dice if you want, but it’s not necessary.) 4. The BlackjackHand class from Subsection 5.5.1 is an extension of the Hand class from Sec- tion 5.4. The instance methods in the Hand class are discussed in that section. In addition to those methods, BlackjackHand includes an instance method, getBlackjackValue(), that returns the value of the hand for the game of Blackjack. For this exercise, you will also need the Deck and Card classes from Section 5.4. A Blackjack hand typically contains from two to six cards. Write a program to test the BlackjackHand class. You should create a BlackjackHand object and a Deck object. Pick a random number between 2 and 6. Deal that many cards from the deck and add them to the hand. Print out all the cards in the hand, and then print out the value computed for the hand by getBlackjackValue(). Repeat this as long as the user wants to continue. In addition to TextIO.java, your program will depend on Card.java, Deck.java, Hand.java, and BlackjackHand.java. 5. Write a program that lets the user play Blackjack. The game will be a simplified version of Blackjack as it is played in a casino. The computer will act as the dealer. As in the previous exercise, your program will need the classes defined in Card.java, Deck.java, Hand.java, and BlackjackHand.java. (This is the longest and most complex program that has come up so far in the exercises.) You should first write a subroutine in which the user plays one game. The subroutine should return a boolean value to indicate whether the user wins the game or not. Return true if the user wins, false if the dealer wins. The program needs an object of class Deck and two objects of type BlackjackHand, one for the dealer and one for the user. The general object in Blackjack is to get a hand of cards whose value is as close to 21 as possible, without going over. The game goes like this. • First, two cards are dealt into each player’s hand. If the dealer’s hand has a value of 21 at this point, then the dealer wins. Otherwise, if the user has 21, then the user wins. (This is called a “Blackjack”.) Note that the dealer wins on a tie, so if both players have Blackjack, then the dealer wins. • Now, if the game has not ended, the user gets a chance to add some cards to her hand. In this phase, the user sees her own cards and sees one of the dealer’s two cards. (In a casino, the dealer deals himself one card face up and one card face down. All the user’s cards are dealt face up.) The user makes a decision whether to “Hit”,
- 238. 222 CHAPTER 5. OBJECTS AND CLASSES which means to add another card to her hand, or to “Stand”, which means to stop taking cards. • If the user Hits, there is a possibility that the user will go over 21. In that case, the game is over and the user loses. If not, then the process continues. The user gets to decide again whether to Hit or Stand. • If the user Stands, the game will end, but first the dealer gets a chance to draw cards. The dealer only follows rules, without any choice. The rule is that as long as the value of the dealer’s hand is less than or equal to 16, the dealer Hits (that is, takes another card). The user should see all the dealer’s cards at this point. Now, the winner can be determined: If the dealer has gone over 21, the user wins. Otherwise, if the dealer’s total is greater than or equal to the user’s total, then the dealer wins. Otherwise, the user wins. Two notes on programming: At any point in the subroutine, as soon as you know who the winner is, you can say “return true;” or “return false;” to end the subroutine and return to the main program. To avoid having an overabundance of variables in your subroutine, remember that a function call such as userHand.getBlackjackValue() can be used anywhere that a number could be used, including in an output statement or in the condition of an if statement. Write a main program that lets the user play several games of Blackjack. To make things interesting, give the user 100 dollars, and let the user make bets on the game. If the user loses, subtract the bet from the user’s money. If the user wins, add an amount equal to the bet to the user’s money. End the program when the user wants to quit or when she runs out of money. An applet version of this program can be found in the on-line version of this exercise. You might want to try it out before you work on the program. 6. Subsection 5.7.6 discusses the possibility of representing the suits and values of playing cards as enumerated types. Rewrite the Card class from Subsection 5.4.2 to use these enumerated types. Test your class with a program that prints out the 52 possible playing cards. Suggestions: You can modify the source code file Card.java, but you should leave out support for Jokers. In your main program, use nested for loops to generated cards of all possible suits and values; the for loops will be “for-each” loops of the type discussed in Subsection 3.4.4. It would be nice to add a toString() method to the Suit class from Subsection 5.7.6, so that a suit prints out as “Spades” or “Hearts” instead of “SPADES” or “HEARTS”.
- 239. Quiz 223 Quiz on Chapter 5 1. Object-oriented programming uses classes and objects. What are classes and what are objects? What is the relationship between classes and objects? 2. Explain carefully what null means in Java, and why this special value is necessary. 3. What is a constructor? What is the purpose of a constructor in a class? 4. Suppose that Kumquat is the name of a class and that fruit is a variable of type Kumquat. What is the meaning of the statement “fruit = new Kumquat();”? That is, what does the computer do when it executes this statement? (Try to give a complete answer. The computer does several things.) 5. What is meant by the terms instance variable and instance method? 6. Explain what is meant by the terms subclass and superclass. 7. Modify the following class so that the two instance variables are private and there is a getter method and a setter method for each instance variable: public class Player { String name; int score; } 8. Explain why the class Player that is defined in the previous question has an instance method named toString(), even though no definition of this method appears in the definition of the class. 9. Explain the term polymorphism. 10. Java uses “garbage collection” for memory management. Explain what is meant here by garbage collection. What is the alternative to garbage collection? 11. For this problem, you should write a very simple but complete class. The class represents a counter that counts 0, 1, 2, 3, 4, . . . . The name of the class should be Counter. It has one private instance variable representing the value of the counter. It has two instance methods: increment() adds one to the counter value, and getValue() returns the current counter value. Write a complete definition for the class, Counter. 12. This problem uses the Counter class from the previous question. The following program segment is meant to simulate tossing a coin 100 times. It should use two Counter objects, headCount and tailCount, to count the number of heads and the number of tails. Fill in the blanks so that it will do so:
- 240. 224 CHAPTER 5. OBJECTS AND CLASSES Counter headCount, tailCount; tailCount = new Counter(); headCount = new Counter(); for ( int flip = 0; flip < 100; flip++ ) { if (Math.random() < 0.5) // There’s a 50/50 chance that this is true. ; // Count a "head". else ; // Count a "tail". } System.out.println("There were " + + " heads."); System.out.println("There were " + + " tails.");
- 241. Chapter 6 Introduction to GUI Programming Computer users today expect to interact with their computers using a graphical user interface (GUI). Java can be used to write GUI programs ranging from simple applets which run on a Web page to sophisticated stand-alone applications. GUI programs differ from traditional “straight-through” programs that you have encoun- tered in the first few chapters of this book. One big difference is that GUI programs are event-driven. That is, user actions such as clicking on a button or pressing a key on the keyboard generate events, and the program must respond to these events as they occur. Event- driven programming builds on all the skills you have learned in the first five chapters of this text. You need to be able to write the subroutines that respond to events. Inside these subrou- tines, you are doing the kind of programming-in-the-small that was covered in Chapter 2 and Chapter 3. And of course, objects are everywhere in GUI programming. Events are objects. Colors and fonts are objects. GUI components such as buttons and menus are objects. Events are handled by instance methods contained in objects. In Java, GUI programming is object-oriented programming. This chapter covers the basics of GUI programming. The discussion will continue in Chap- ter 12 with more details and with more advanced techniques. 6.1 The Basic GUI Application There are two basic types of GUI program in Java: stand-alone applications and applets. An applet is a program that runs in a rectangular area on a Web page. Applets are generally small programs, meant to do fairly simple things, although there is nothing to stop them from being very complex. Applets were responsible for a lot of the initial excitement about Java when it was introduced, since they could do things that could not otherwise be done on Web pages. However, there are now easier ways to do many of the more basic things that can be done with applets, and they are no longer the main focus of interest in Java. Nevertheless, there are still some things that can be done best with applets, and they are still fairly common on the Web. We will look at applets in the next section. A stand-alone application is a program that runs on its own, without depending on a Web browser. You’ve been writing stand-alone applications all along. Any class that has a main() routine defines a stand-alone application; running the program just means executing this main() routine. However, the programs that you’ve seen up till now have been “command- line” programs, where the user and computer interact by typing things back and forth to each 225
- 242. 226 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING other. A GUI program offers a much richer type of user interface, where the user uses a mouse and keyboard to interact with GUI components such as windows, menus, buttons, check boxes, text input boxes, scroll bars, and so on. The main routine of a GUI program creates one or more such components and displays them on the computer screen. Very often, that’s all it does. Once a GUI component has been created, it follows its own programming—programming that tells it how to draw itself on the screen and how to respond to events such as being clicked on by the user. A GUI program doesn’t have to be immensely complex. We can, for example, write a very simple GUI “Hello World” program that says “Hello” to the user, but does it by opening a window where the the greeting is displayed: import javax.swing.JOptionPane; public class HelloWorldGUI1 { public static void main(String[] args) { JOptionPane.showMessageDialog( null, "Hello World!" ); } } When this program is run, a window appears on the screen that contains the message “Hello World!”. The window also contains an “OK” button for the user to click after reading the message. When the user clicks this button, the window closes and the program ends. By the way, this program can be placed in a file named HelloWorldGUI1.java, compiled, and run just like any other Java program. Now, this program is already doing some pretty fancy stuff. It creates a window, it draws the contents of that window, and it handles the event that is generated when the user clicks the button. The reason the program was so easy to write is that all the work is done by showMessageDialog(), a static method in the built-in class JOptionPane. (Note that the source code “imports” the class javax.swing.JOptionPane to make it possible to refer to the JOptionPane class using its simple name. See Subsection 4.5.3 for information about importing classes from Java’s standard packages.) If you want to display a message to the user in a GUI program, this is a good way to do it: Just use a standard class that already knows how to do the work! And in fact, JOptionPane is regularly used for just this purpose (but as part of a larger program, usually). Of course, if you want to do anything serious in a GUI program, there is a lot more to learn. To give you an idea of the types of things that are involved, we’ll look at a short GUI program that does the same things as the previous program—open a window containing a message and an OK button, and respond to a click on the button by ending the program—but does it all by hand instead of by using the built-in JOptionPane class. Mind you, this is not a good way to write the program, but it will illustrate some important aspects of GUI programming in Java. Here is the source code for the program. You are not expected to understand it yet. I will explain how it works below, but it will take the rest of the chapter before you will really understand completely. In this section, you will just get a brief overview of GUI programming. import java.awt.*; import java.awt.event.*; import javax.swing.*; public class HelloWorldGUI2 { private static class HelloWorldDisplay extends JPanel {
- 243. 6.1. THE BASIC GUI APPLICATION 227 public void paintComponent(Graphics g) { super.paintComponent(g); g.drawString( "Hello World!", 20, 30 ); } } private static class ButtonHandler implements ActionListener { public void actionPerformed(ActionEvent e) { System.exit(0); } } public static void main(String[] args) { HelloWorldDisplay displayPanel = new HelloWorldDisplay(); JButton okButton = new JButton("OK"); ButtonHandler listener = new ButtonHandler(); okButton.addActionListener(listener); JPanel content = new JPanel(); content.setLayout(new BorderLayout()); content.add(displayPanel, BorderLayout.CENTER); content.add(okButton, BorderLayout.SOUTH); JFrame window = new JFrame("GUI Test"); window.setContentPane(content); window.setSize(250,100); window.setLocation(100,100); window.setVisible(true); } } 6.1.1 JFrame and JPanel In a Java GUI program, each GUI component in the interface is represented by an object in the program. One of the most fundamental types of component is the window. Windows have many behaviors. They can be opened and closed. They can be resized. They have “titles” that are displayed in the title bar above the window. And most important, they can contain other GUI components such as buttons and menus. Java, of course, has a built-in class to represent windows. There are actually several different types of window, but the most common type is represented by the JFrame class (which is included in the package javax.swing). A JFrame is an independent window that can, for example, act as the main window of an application. One of the most important things to understand is that a JFrame object comes with many of the behaviors of windows already programmed in. In particular, it comes with the basic properties shared by all windows, such as a titlebar and the ability to be opened and closed. Since a JFrame comes with these behaviors, you don’t have to program them yourself! This is, of course, one of the central ideas of object- oriented programming. What a JFrame doesn’t come with, of course, is content, the stuff that is contained in the window. If you don’t add any other content to a JFrame, it will just display a large blank area. You can add content either by creating a JFrame object and then adding the content to it or by creating a subclass of JFrame and adding the content in the constructor of that subclass.
- 244. 228 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING The main program above declares a variable, window, of type JFrame and sets it to refer to a new window object with the statement: JFrame window = new JFrame("GUI Test"); The parameter in the constructor, “GUI Test”, specifies the title that will be displayed in the titlebar of the window. This line creates the window object, but the window itself is not yet visible on the screen. Before making the window visible, some of its properties are set with these statements: window.setContentPane(content); window.setSize(250,100); window.setLocation(100,100); The first line here sets the content of the window. (The content itself was created earlier in the main program.) The second line says that the window will be 250 pixels wide and 100 pixels high. The third line says that the upper left corner of the window will be 100 pixels over from the left edge of the screen and 100 pixels down from the top. Once all this has been set up, the window is actually made visible on the screen with the command: window.setVisible(true); It might look as if the program ends at that point, and, in fact, the main() routine does end. However, the the window is still on the screen and the program as a whole does not end until the user clicks the OK button. ∗ ∗ ∗ The content that is displayed in a JFrame is called its content pane. (In addition to its content pane, a JFrame can also have a menu bar, which is a separate thing that I will talk about later.) A basic JFrame already has a blank content pane; you can either add things to that pane or you can replace the basic content pane entirely. In my sample program, the line window.setContentPane(content) replaces the original blank content pane with a different component. (Remember that a “component” is just a visual element of a graphical user interface). In this case, the new content is a component of type JPanel. JPanel is another of the fundamental classes in Swing. The basic JPanel is, again, just a blank rectangle. There are two ways to make a useful JPanel: The first is to add other components to the panel; the second is to draw something in the panel. Both of these techniques are illustrated in the sample program. In fact, you will find two JPanels in the program: content, which is used to contain other components, and displayPanel, which is used as a drawing surface. Let’s look more closely at displayPanel. This variable is of type HelloWorldDisplay, which is a nested static class inside the HelloWorldGUI2 class. (Nested classes were introduced in Subsection 5.7.2.) This class defines just one instance method, paintComponent(), which overrides a method of the same name in the JPanel class: private static class HelloWorldDisplay extends JPanel { public void paintComponent(Graphics g) { super.paintComponent(g); g.drawString( "Hello World!", 20, 30 ); } } The paintComponent() method is called by the system when a component needs to be painted on the screen. In the JPanel class, the paintComponent method simply fills the panel with the
- 245. 6.1. THE BASIC GUI APPLICATION 229 panel’s background color. The paintComponent() method in HelloWorldDisplay begins by call- ing super.paintComponent(g). This calls the version of paintComponent() that is defined in the superclass, JPanel; that is, it fills the panel with the background color. (See Subsection 5.6.2 for a discussion of the special variable super.) Then it calls g.drawString() to paint the string “Hello World!” onto the panel. The net result is that whenever a HelloWorldDisplay is shown on the screen, it displays the string “Hello World!”. We will often use JPanels in this way, as drawing surfaces. Usually, when we do this, we will define a nested class that is a subclass of JPanel and we will write a paintComponent method in that class to draw the desired content in the panel. 6.1.2 Components and Layout Another way of using a JPanel is as a container to hold other components. Java has many classes that define GUI components. Before these components can appear on the screen, they must be added to a container. In this program, the variable named content refers to a JPanel that is used as a container, and two other components are added to that container. This is done in the statements: content.add(displayPanel, BorderLayout.CENTER); content.add(okButton, BorderLayout.SOUTH); Here, content refers to an object of type JPanel; later in the program, this panel becomes the content pane of the window. The first component that is added to content is displayPanel which, as discussed above, displays the message, “Hello World!”. The second is okButton which represents the button that the user clicks to close the window. The variable okButton is of type JButton, the Java class that represents push buttons. The “BorderLayout” stuff in these statements has to do with how the two components are arranged in the container. When components are added to a container, there has to be some way of deciding how those components are arranged inside the container. This is called “laying out” the components in the container, and the most common technique for laying out components is to use a layout manager. A layout manager is an object that implements some policy for how to arrange the components in a container; different types of layout manager implement different policies. One type of layout manager is defined by the BorderLayout class. In the program, the statement content.setLayout(new BorderLayout()); creates a new BorderLayout object and tells the content panel to use the new object as its layout manager. Essentially, this line determines how components that are added to the content panel will be arranged inside the panel. We will cover layout managers in much more detail later, but for now all you need to know is that adding okButton in the BorderLayout.SOUTH position puts the button at the bottom of the panel, and putting displayPanel in the BorderLayout.CENTER position makes it fill any space that is not taken up by the button. This example shows a general technique for setting up a GUI: Create a container and assign a layout manager to it, create components and add them to the container, and use the container as the content pane of a window or applet. A container is itself a component, so it is possible that some of the components that are added to the top-level container are themselves containers, with their own layout managers and components. This makes it possible to build up complex user interfaces in a hierarchical fashion, with containers inside containers inside containers. . .
- 246. 230 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING 6.1.3 Events and Listeners The structure of containers and components sets up the physical appearance of a GUI, but it doesn’t say anything about how the GUI behaves. That is, what can the user do to the GUI and how will it respond? GUIs are largely event-driven; that is, the program waits for events that are generated by the user’s actions (or by some other cause). When an event occurs, the program responds by executing an event-handling method. In order to program the behavior of a GUI, you have to write event-handling methods to respond to the events that you are interested in. The most common technique for handling events in Java is to use event listeners. A listener is an object that includes one or more event-handling methods. When an event is detected by another object, such as a button or menu, the listener object is notified and it responds by running the appropriate event-handling method. An event is detected or generated by an object. Another object, the listener, has the responsibility of responding to the event. The event itself is actually represented by a third object, which carries information about the type of event, when it occurred, and so on. This division of responsibilities makes it easier to organize large programs. As an example, consider the OK button in the sample program. When the user clicks the button, an event is generated. This event is represented by an object belonging to the class ActionEvent. The event that is generated is associated with the button; we say that the button is the source of the event. The listener object in this case is an object belonging to the class ButtonHandler, which is defined as a nested class inside HelloWorldGUI2: private static class ButtonHandler implements ActionListener { public void actionPerformed(ActionEvent e) { System.exit(0); } } This class implements the ActionListener interface—a requirement for listener objects that handle events from buttons. (Interfaces were introduced in Subsection 5.7.1.) The event- handling method is named actionPerformed, as specified by the ActionListener interface. This method contains the code that is executed when the user clicks the button; in this case, the code is a call to System.exit(), which will terminate the program. There is one more ingredient that is necessary to get the event from the button to the listener object: The listener object must register itself with the button as an event listener. This is done with the statement: okButton.addActionListener(listener); This statement tells okButton that when the user clicks the button, the ActionEvent that is generated should be sent to listener. Without this statement, the button has no way of knowing that some other object would like to listen for events from the button. This example shows a general technique for programming the behavior of a GUI: Write classes that include event-handling methods. Create objects that belong to these classes and register them as listeners with the objects that will actually detect or generate the events. When an event occurs, the listener is notified, and the code that you wrote in one of its event-handling methods is executed. At first, this might seem like a very roundabout and complicated way to get things done, but as you gain experience with it, you will find that it is very flexible and that it goes together very well with object oriented programming. (We will return to events
- 247. 6.2. APPLETS AND HTML 231 and listeners in much more detail in Section 6.3 and later sections, and I do not expect you to completely understand them at this time.) 6.2 Applets and HTML Although stand-alone applications are probably more important than applets at this point in the history of Java, applets are still widely used. They can do things on Web pages that can’t easily be done with other technologies. It is easy to distribute applets to users: The user just has to open a Web page, and the applet is there, with no special installation required (although the user must have an appropriate version of Java installed on their computer). And of course, applets are fun; now that the Web has become such a common part of life, it’s nice to be able to see your work running on a web page. The good news is that writing applets is not much different from writing stand-alone appli- cations. The structure of an applet is essentially the same as the structure of the JFrames that were introduced in the previous section, and events are handled in the same way in both types of program. So, most of what you learn about applications applies to applets, and vice versa. Of course, one difference is that an applet is dependent on a Web page, so to use applets effectively, you have to learn at least a little about creating Web pages. Web pages are written using a language called HTML (HyperText Markup Language). In Subsection 6.2.3, below, you’ll learn how to use HTML to create Web pages that display applets. 6.2.1 JApplet The JApplet class (in package javax.swing) can be used as a basis for writing applets in the same way that JFrame is used for writing stand-alone applications. The basic JApplet class represents a blank rectangular area. Since an applet is not a stand-alone application, this area must appear on a Web page, or in some other environment that knows how to display an applet. Like a JFrame, a JApplet contains a content pane (and can contain a menu bar). You can add content to an applet either by adding content to its content pane or by replacing the content pane with another component. In my examples, I will generally create a JPanel and use it as a replacement for the applet’s content pane. To create an applet, you will write a subclass of JApplet. The JApplet class defines several instance methods that are unique to applets. These methods are called by the applet’s environ- ment at certain points during the applet’s “life cycle.” In the JApplet class itself, these methods do nothing; you can override these methods in a subclass. The most important of these special applet methods is public void init() An applet’s init() method is called when the applet is created. You can use the init() method as a place where you can set up the physical structure of the applet and the event handling that will determine its behavior. (You can also do some initialization in the constructor for your class, but there are certain aspects of the applet’s environment that are set up after its constructor is called but before the init() method is called, so there are a few operations that will work in the init() method but will not work in the constructor.) The other applet life-cycle methods are start(), stop(), and destroy(). I will not use these methods for the time being and will not discuss them here except to mention that destroy() is called at the end of the applet’s lifetime and can be used as a place to do any necessary cleanup, such as closing any windows that were opened by the applet.
- 248. 232 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING With this in mind, we can look at our first example of a JApplet. It is, of course, an applet that says “Hello World!”. To make it a little more interesting, I have added a button that changes the text of the message, and a state variable, currentMessage, that holds the text of the current message. This example is very similar to the stand-alone application HelloWorldGUI2 from the previous section. It uses an event-handling class to respond when the user clicks the button, a panel to display the message, and another panel that serves as a container for the message panel and the button. The second panel becomes the content pane of the applet. Here is the source code for the applet; again, you are not expected to understand all the details at this time: import java.awt.*; import java.awt.event.*; import javax.swing.*; /** * A simple applet that can display the messages "Hello World" * and "Goodbye World". The applet contains a button, and it * switches from one message to the other when the button is * clicked. */ public class HelloWorldApplet extends JApplet { private String currentMessage = "Hello World!"; // Currently displayed message. private MessageDisplay displayPanel; // The panel where the message is displayed. private class MessageDisplay extends JPanel { // Defines the display panel. public void paintComponent(Graphics g) { super.paintComponent(g); g.drawString(currentMessage, 20, 30); } } private class ButtonHandler implements ActionListener { // The event listener. public void actionPerformed(ActionEvent e) { if (currentMessage.equals("Hello World!")) currentMessage = "Goodbye World!"; else currentMessage = "Hello World!"; displayPanel.repaint(); // Paint display panel with new message. } } /** * The applet’s init() method creates the button and display panel and * adds them to the applet, and it sets up a listener to respond to * clicks on the button. */ public void init() { displayPanel = new MessageDisplay(); JButton changeMessageButton = new JButton("Change Message"); ButtonHandler listener = new ButtonHandler(); changeMessageButton.addActionListener(listener); JPanel content = new JPanel(); content.setLayout(new BorderLayout());
- 249. 6.2. APPLETS AND HTML 233 content.add(displayPanel, BorderLayout.CENTER); content.add(changeMessageButton, BorderLayout.SOUTH); setContentPane(content); } } You should compare this class with HelloWorldGUI2.java from the previous section. One subtle difference that you will notice is that the member variables and nested classes in this example are non-static. Remember that an applet is an object. A single class can be used to make several applets, and each of those applets will need its own copy of the applet data, so the member variables in which the data is stored must be non-static instance variables. Since the variables are non-static, the two nested classes, which use those variables, must also be non-static. (Static nested classes cannot access non-static member variables in the containing class; see Subsection 5.7.2.) Remember the basic rule for deciding whether to make a nested class static: If it needs access to any instance variable or instance method in the containing class, the nested class must be non-static; otherwise, it can be declared to be static. 6.2.2 Reusing Your JPanels Both applets and frames can be programmed in the same way: Design a JPanel, and use it to replace the default content pane in the applet or frame. This makes it very easy to write two versions of a program, one which runs as an applet and one which runs as a frame. The idea is to create a subclass of JPanel that represents the content pane for your program; all the hard programming work is done in this panel class. An object of this class can then be used as the content pane either in a frame or in an applet. Only a very simple main() program is needed to show your panel in a frame, and only a very simple applet class is needed to show your panel in an applet, so it’s easy to make both versions. As an example, we can rewrite HelloWorldApplet by writing a subclass of JPanel. That class can then be reused to make a frame in a standalone application. This class is very similar to HelloWorldApplet, but now the initialization is done in a constructor instead of in an init() method: import java.awt.*; import java.awt.event.*; import javax.swing.*; public class HelloWorldPanel extends JPanel { private String currentMessage = "Hello World!"; // Currently displayed message. private MessageDisplay displayPanel; // The panel where the message is displayed. private class MessageDisplay extends JPanel { // Defines the display panel. public void paintComponent(Graphics g) { super.paintComponent(g); g.drawString(currentMessage, 20, 30); } } private class ButtonHandler implements ActionListener { // The event listener. public void actionPerformed(ActionEvent e) { if (currentMessage.equals("Hello World!")) currentMessage = "Goodbye World!";
- 250. 234 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING else currentMessage = "Hello World!"; displayPanel.repaint(); // Paint display panel with new message. } } /** * The constructor creates the components that will be contained inside this * panel, and then adds those components to this panel. */ public HelloWorldPanel() { displayPanel = new MessageDisplay(); // Create the display subpanel. JButton changeMessageButton = new JButton("Change Message"); // The button. ButtonHandler listener = new ButtonHandler(); changeMessageButton.addActionListener(listener); setLayout(new BorderLayout()); // Set the layout manager for this panel. add(displayPanel, BorderLayout.CENTER); // Add the display panel. add(changeMessageButton, BorderLayout.SOUTH); // Add the button. } } Once this class exists, it can be used in an applet. The applet class only has to create an object of type HelloWorldPanel and use that object as its content pane: import javax.swing.JApplet; public class HelloWorldApplet2 extends JApplet { public void init() { HelloWorldPanel content = new HelloWorldPanel(); setContentPane(content); } } Similarly, its easy to make a frame that uses an object of type HelloWorldPanel as its content pane: import javax.swing.JFrame; public class HelloWorldGUI3 { public static void main(String[] args) { JFrame window = new JFrame("GUI Test"); HelloWorldPanel content = new HelloWorldPanel(); window.setContentPane(content); window.setSize(250,100); window.setLocation(100,100); window.setDefaultCloseOperation( JFrame.EXIT ON CLOSE ); window.setVisible(true); } } One new feature of this example is the line window.setDefaultCloseOperation( JFrame.EXIT ON CLOSE );
- 251. 6.2. APPLETS AND HTML 235 This says that when the user closes the window by clicking the close box in the title bar of the window, the program should be terminated. This is necessary because no other way is provided to end the program. Without this line, the default close operation of the window would simply hide the window when the user clicks the close box, leaving the program running. This brings up one of the difficulties of reusing the same panel class both in an applet and in a frame: There are some things that a stand-alone application can do that an applet can’t do. Terminating the program is one of those things. If an applet calls System.exit(), it has no effect except to generate an error. Nevertheless, in spite of occasional minor difficulties, many of the GUI examples in this book will be written as subclasses of JPanel that can be used either in an applet or in a frame. 6.2.3 Basic HTML Before you can actually use an applet that you have written, you need to create a Web page on which to place the applet. Such pages are themselves written in a language called HTML (HyperText Markup Language). An HTML document describes the contents of a page. A Web browser interprets the HTML code to determine what to display on the page. The HTML code doesn’t look much like the resulting page that appears in the browser. The HTML document does contain all the text that appears on the page, but that text is “marked up” with commands that determine the structure and appearance of the text and determine what will appear on the page in addition to the text. HTML has become a rather complicated language. In this section, I will cover just the most basic aspects of the language. You can easily find more information on the Web, if you want to learn more. Although there are many Web-authoring programs that make it possible to create Web pages without ever looking at the underlying HTML code, it is possible to write an HTML page using an ordinary text editor, typing in all the mark-up commands by hand, and it is worthwhile to learn how to create at least simple pages in this way. There is a strict syntax for HTML documents (although in practice Web browsers will do their best to display a page even if it does not follow the syntax strictly). Leaving out optional features, an HTML document has the form: <html> <head> <title>hdocument-titlei</title> </head> <body> hdocument-contenti </body> </html> The hdocument-titlei is text that will appear in the title bar of the Web browser window when the page is displayed. The hdocument-contenti is what is displayed on the page itself. The rest of this section describes some of the things that can go into the hdocument-contenti section of an HTML document ∗ ∗ ∗ The mark-up commands used by HTML are called tags. Examples include <html> and <title> in the document outline given above. An HTML tag takes the form <htag-namei hoptional-modifiersi>
- 252. 236 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING where the htag-namei is a word that specifies the command, and the hoptional-modifiersi, if present, are used to provide additional information for the command (much like parameters in subroutines). A modifier takes the form hmodifier-namei = hvalue i Usually, the hvaluei is enclosed in quotes, and it must be if it is more than one word long or if it contains certain special characters. There are a few modifiers which have no value, in which case only the name of the modifier is present. HTML is case insensitive, which means that you can use upper case and lower case letters interchangeably in tags and modifiers. (However, lower case is generally used because XHTML, a successor language to HTML, requires lower case.) A simple example of a tag is <hr>, which draws a line—also called a “horizontal rule”— across the page. The hr tag can take several possible modifiers such as width and align. For example, a horizontal line that extends halfway across the page could be generated with the tag: <hr width="50%"> The width here is specified as 50% of the available space, meaning a line that extends halfway across the page. The width could also be given as a fixed number of pixels. Many tags require matching closing tags, which take the form </htag-namei> For example, the <html> tag at the beginning of an HTML document must be matched by a closing </html> tag at the end of the document. As another example, the tag <pre> must always have a matching closing tag </pre> later in the document. An opening/closing tag pair applies to everything that comes between the opening tag and the closing tag. The <pre> tag tells a Web browser to display everything between the <pre> and the </pre> just as it is formatted in the original HTML source code, including all the spaces and carriage returns. (But tags between <pre> and </pre> are still interpreted by the browser.) “Pre” stands for preformatted text. All of the sample programs in the on-line version of this book are formatted using the <pre> command. It is important for you to understand that when you don’t use <pre>, the computer will completely ignore the formatting of the text in the HTML source code. The only thing it pays attention to is the tags. Five blank lines in the source code have no more effect than one blank line or even a single blank space. Outside of <pre>, if you want to force a new line on the Web page, you can use the tag <br>, which stands for “break”. For example, I might give my address as: David Eck<br> Department of Mathematics and Computer Science<br> Hobart and William Smith Colleges<br> Geneva, NY 14456<br> If you want extra vertical space in your web page, you can use several <br>’s in a row. Similarly, you need a tag to indicate how the text should be broken up into paragraphs. This is done with the <p> tag, which should be placed at the beginning of every paragraph. The <p> tag has a matching </p>, which should be placed at the end of each paragraph. The closing </p> is technically optional, but it is considered good form to use it. If you want all the lines of the paragraph to be shoved over to the right, you can use <p align=right> instead of
- 253. 6.2. APPLETS AND HTML 237 <p>. (This is mostly useful when used with one short line, or when used with <br> to make several short lines.) You can also use <p align=center> for centered lines. By the way, if tags like <p> and <hr> have special meanings in HTML, you might wonder how one can get them to appear literally on a web page. To get certain special characters to appear on the page, you have to use an entity name in the HTML source code. The entity name for < is <, and the entity name for > is >. Entity names begin with & and end with a semicolon. The character & is itself a special character whose entity name is &. There are also entity names for nonstandard characters such as an accented “e”, which has the entity name é. There are several useful tags that change the appearance of text. For example, to get italic text, enclose the text between <i> and </i>. For example, <i>Introduction to Programming using Java</i> in an HTML document gives Introduction to Programming using Java in italics when the document is displayed as a Web page. Similarly, the tags <b>, <u>, and <tt> can be used for bold, underlined, and typewriter-style (“monospace”) text. A headline, with very large text, can be made by placing the the text between <h1> and </h1>. Headlines with smaller text can be made using <h2> or <h3> instead of <h1>. Note that these headline tags stand on their own; they are not used inside paragraphs. You can add the modifier align=center to center the headline, and you can include break tags (<br>) in a headline to break it up into multiple lines. For example, the following HTML code will produce a medium–sized, centered, two-line headline: <h2 align=center>Chapter 6:<br>Introduction to GUI Programming</h2> ∗ ∗ ∗ The most distinctive feature of HTML is that documents can contain links to other docu- ments. The user can follow links from page to page and in the process visit pages from all over the Internet. The <a> tag is used to create a link. The text between the <a> and its matching </a> appears on the page as the text of the link; the user can follow the link by clicking on this text. The <a> tag uses the modifier href to say which document the link should connect to. The value for href must be a URL (Uniform Resource Locator). A URL is a coded set of instructions for finding a document on the Internet. For example, the URL for my own “home page” is http://math.hws.edu/eck/ To make a link to this page, I would use the HTML source code <a href="http://math.hws.edu/eck/">David’s Home Page</a> The best place to find URLs is on existing Web pages. Web browsers display the URL for the page you are currently viewing, and they can display the URL of a link if you point to the link with the mouse. If you are writing an HTML document and you want to make a link to another document that is in the same directory, you can use a relative URL. The relative URL consists of just the name of the file. For example, to create a link to a file named “s1.html” in the same directory as the HTML document that you are writing, you could use <a href="s1.html">Section 1</a>
- 254. 238 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING There are also relative URLs for linking to files that are in other directories. Using relative URLs is a good idea, since if you use them, you can move a whole collection of files without changing any of the links between them (as long as you don’t change the relative locations of the files). When you type a URL into a Web browser, you can omit the “http://” at the beginning of the URL. However, in an <a> tag in an HTML document, the “http://” can only be omitted if the URL is a relative URL. For a normal URL, it is required. ∗ ∗ ∗ You can add images to a Web page with the <img> tag. (This is a tag that has no matching closing tag.) The actual image must be stored in a separate file from the HTML document. The <img> tag has a required modifier, named src, to specify the URL of the image file. For most browsers, the image should be in one of the formats PNG (with a file name ending in “.png”), JPEG (with a file name ending in “.jpeg” or “.jpg”), or GIF (with a file name ending in “.gif”). Usually, the image is stored in the same place as the HTML document, and a relative URL—that is, just the name of the image file—is used to specify the image file. The <img> tag also has several optional modifiers. It’s a good idea to always include the height and width modifiers, which specify the size of the image in pixels. Some browsers handle images better if they know in advance how big they are. The align modifier can be used to affect the placement of the image: “align=right” will shove the image to the right edge of the page, and the text on the page will flow around the image; “align=left” works similarly. (Unfortunately, “align=center” doesn’t have the meaning you would expect. Browsers treat images as if they are just big characters. Images can occur inside paragraphs, links, and headings, for example. Alignment values of center, top, and bottom are used to specify how the image should line up with other characters in a line of text: Should the baseline of the text be at the center, the top, or the bottom of the image? Alignment values of right and left were added to HTML later, but they are the most useful values. If you want an image centered on the page, put it inside a <p align=center> tag.) For example, here is HTML code that will place an image from a file named figure1.png on the page. <img src="figure1.png" align=right height=150 width=100> The image is 100 pixels wide and 150 pixels high, and it will appear on the right edge of the page. 6.2.4 Applets on Web Pages The main point of this whole discussion of HTML is to learn how to use applets on the Web. The <applet> tag can be used to add a Java applet to a Web page. This tag must have a matching </applet>. A required modifier named code gives the name of the compiled class file that contains the applet class. The modifiers height and width are required to specify the size of the applet, in pixels. If you want the applet to be centered on the page, you can put the applet in a paragraph with center alignment So, an applet tag to display an applet named HelloWorldApplet centered on a Web page would look like this: <p align=center> <applet code="HelloWorldApplet.class" height=100 width=250> </applet> </p>
- 255. 6.2. APPLETS AND HTML 239 This assumes that the file HelloWorldApplet.class is located in the same directory with the HTML document. If this is not the case, you can use another modifier, codebase, to give the URL of the directory that contains the class file. The value of code itself is always just a class, not a URL. If the applet uses other classes in addition to the applet class itself, then those class files must be in the same directory as the applet class (always assuming that your classes are all in the “default package”; see Subsection 2.6.4). If an applet requires more than one or two class files, it’s a good idea to collect all the class files into a single jar file. Jar files are “archive files” which hold a number of smaller files. If your class files are in a jar archive, then you have to specify the name of the jar file in an archive modifier in the <applet> tag, as in <applet code="HelloWorldApplet.class" archive="HelloWorld.jar" height=50... I will have more to say about creating and using jar files at the end of this chapter. Applets can use applet parameters to customize their behavior. Applet parameters are specified by using <param> tags, which can only occur between an <applet> tag and the closing </applet>. The param tag has required modifiers named name and value, and it takes the form <param name="hparam-namei" value="hparam-valuei"> The parameters are available to the applet when it runs. An applet can use the predefined method getParameter() to check for parameters specified in param tags. The getParameter() method has the following interface: String getParameter(String paramName) The parameter paramName corresponds to the hparam-namei in a param tag. If the specified paramName actually occurs in one of the param tags, then getParameter(paramName) returns the associated hparam-valuei. If the specified paramName does not occur in any param tag, then getParameter(paramName) returns the value null. Parameter names are case-sensitive, so you cannot use “size” in the param tag and ask for “Size” in getParameter. The getParameter() method is often called in the applet’s init() method. It will not work correctly in the applet’s constructor, since it depends on information about the applet’s environment that is not available when the constructor is called. Here is an example of an applet tag with several params: <applet code="ShowMessage.class" width=200 height=50> <param name="message" value="Goodbye World!"> <param name="font" value="Serif"> <param name="size" value="36"> </applet> The ShowMessage applet would presumably read these parameters in its init() method, which could go something like this: String message; // Instance variable: message to be displayed. String fontName; // Instance variable: font to use for display. int fontSize; // Instance variable: size of the display font. public void init() { String value; value = getParameter("message"); // Get message param, if any. if (value == null)
- 256. 240 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING message = "Hello World!"; // Default value, if no param is present. else message = value; // Value from PARAM tag. value = getParameter("font"); if (value == null) fontName = "SansSerif"; // Default value, if no param is present. else fontName = value; value = getParameter("size"); try { fontSize = Integer.parseInt(value); // Convert string to number. } catch (NumberFormatException e) { fontSize = 20; // Default value, if no param is present, or if } // the parameter value is not a legal integer. . . . Elsewhere in the applet, the instance variables message, fontName, and fontSize would be used to determine the message displayed by the applet and the appearance of that message. Note that the value returned by getParameter() is always a String. If the param represents a numerical value, the string must be converted into a number, as is done here for the size parameter. 6.3 Graphics and Painting Everthing you see on a computer screen has to be drawn there, even the text. The Java API includes a range of classes and methods that are devoted to drawing. In this section, I’ll look at some of the most basic of these. The physical structure of a GUI is built of components. The term component refers to a visual element in a GUI, including buttons, menus, text-input boxes, scroll bars, check boxes, and so on. In Java, GUI components are represented by objects belonging to subclasses of the class java.awt.Component. Most components in the Swing GUI—although not top-level com- ponents like JApplet and JFrame—belong to subclasses of the class javax.swing.JComponent, which is itself a subclass of java.awt.Component. Every component is responsible for drawing itself. If you want to use a standard component, you only have to add it to your applet or frame. You don’t have to worry about painting it on the screen. That will happen automatically, since it already knows how to draw itself. Sometimes, however, you do want to draw on a component. You will have to do this whenever you want to display something that is not included among the standard, pre-defined component classes. When you want to do this, you have to define your own component class and provide a method in that class for drawing the component. I will always use a subclass of JPanel when I need a drawing surface of this kind, as I did for the MessageDisplay class in the example HelloWorldApplet.java in the previous section. A JPanel, like any JComponent, draws its content in the method public void paintComponent(Graphics g) To create a drawing surface, you should define a subclass of JPanel and provide a custom paintComponent() method. Create an object belonging to this class and use it in your applet
- 257. 6.3. GRAPHICS AND PAINTING 241 or frame. When the time comes for your component to be drawn on the screen, the system will call its paintComponent() to do the drawing. That is, the code that you put into the paintComponent() method will be executed whenever the panel needs to be drawn on the screen; by writing this method, you determine the picture that will be displayed in the panel. Note that the paintComponent() method has a parameter of type Graphics. The Graphics object will be provided by the system when it calls your method. You need this object to do the actual drawing. To do any drawing at all in Java, you need a graphics context. A graphics context is an object belonging to the class java.awt.Graphics. Instance methods are provided in this class for drawing shapes, text, and images. Any given Graphics object can draw to only one location. In this chapter, that location will always be a GUI component belonging to some subclass of JPanel. The Graphics class is an abstract class, which means that it is impossible to create a graphics context directly, with a constructor. There are actually two ways to get a graphics context for drawing on a component: First of all, of course, when the paintComponent() method of a component is called by the system, the parameter to that method is a graphics context for drawing on the component. Second, every component has an instance method called getGraphics(). This method is a function that returns a graphics context that can be used for drawing on the component outside its paintComponent() method. The official line is that you should not do this, and I will avoid it for the most part. But I have found it convenient to use getGraphics() in a few cases. The paintComponent() method in the JPanel class simply fills the panel with the panel’s background color. When defining a subclass of JPanel for use as a drawing surface, you will almost always want to fill the panel with the background color before drawing other content onto the panel (although it is not necessary to do this if the drawing commands in the method cover the background of the component completely.) This is traditionally done with a call to super.paintComponent(g), so most paintComponent() methods that you write will have the form: public void paintComponent(g) { super.paintComponent(g); . . . // Draw the content of the component. } ∗ ∗ ∗ Most components do, in fact, do all drawing operations in their paintComponent() methods. What happens if, in the middle of some other method, you realize that the content of the component needs to be changed? You should not call paintComponent() directly to make the change; this method is meant to be called only by the system. Instead, you have to inform the system that the component needs to be redrawn, and let the system do its job by calling paintComponent(). You do this by calling the component’s repaint() method. The method public void repaint(); is defined in the Component class, and so can be used with any component. You should call repaint() to inform the system that the component needs to be redrawn. The repaint() method returns immediately, without doing any painting itself. The system will call the com- ponent’s paintComponent() method later, as soon as it gets a chance to do so, after processing other pending events if there are any. Note that the system can also call paintComponent() for other reasons. It is called when the component first appears on the screen. It will also be called if the component is resized or if it is covered up by another window and then uncovered. The system does not save a copy of the
- 258. 242 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING component’s contents when it is covered. When it is uncovered, the component is responsible for redrawing itself. (As you will see, some of our early examples will not be able to do this correctly.) This means that, to work properly, the paintComponent() method must be smart enough to correctly redraw the component at any time. To make this possible, a program should store data about the state of the component in its instance variables. These variables should contain all the information necessary to redraw the component completely. The paintComponent() method should use the data in these variables to decide what to draw. When the program wants to change the content of the component, it should not simply draw the new content. It should change the values of the relevant variables and call repaint(). When the system calls paintComponent(), that method will use the new values of the variables and will draw the component with the desired modifications. This might seem a roundabout way of doing things. Why not just draw the modifications directly? There are at least two reasons. First of all, it really does turn out to be easier to get things right if all drawing is done in one method. Second, even if you did make modifications directly, you would still have to make the paintComponent() method aware of them in some way so that it will be able to redraw the component correctly on demand. You will see how all this works in practice as we work through examples in the rest of this chapter. For now, we will spend the rest of this section looking at how to get some actual drawing done. 6.3.1 Coordinates The screen of a computer is a grid of little squares called pixels. The color of each pixel can be set individually, and drawing on the screen just means setting the colors of individual pixels. A graphics context draws in a rectangle made up of pixels. A position in the rectangle is specified by a pair of integer coordinates, (x,y). The upper left corner has coordinates (0,0). The x coordinate increases from left to right, and the y coordinate increases from top to bottom. The illustration shows a 16-by-10 pixel component (with very large pixels). A small line, rectangle, and oval are shown as they would be drawn by coloring individual pixels. (Note that, properly speaking, the coordinates don’t belong to the pixels but to the grid lines between them.) For any component, you can find out the size of the rectangle that it occupies by calling the instance methods getWidth() and getHeight(), which return the number of pixels in the horizontal and vertical directions, respectively. In general, it’s not a good idea to assume that you know the size of a component, since the size is often set by a layout manager and can
- 259. 6.3. GRAPHICS AND PAINTING 243 even change if the component is in a window and that window is resized by the user. This means that it’s good form to check the size of a component before doing any drawing on that component. For example, you can use a paintComponent() method that looks like: public void paintComponent(Graphics g) { super.paintComponent(g); int width = getWidth(); // Find out the width of this component. int height = getHeight(); // Find out its height. . . . // Draw the content of the component. } Of course, your drawing commands will have to take the size into account. That is, they will have to use (x,y) coordinates that are calculated based on the actual height and width of the component. 6.3.2 Colors You will probably want to use some color when you draw. Java is designed to work with the RGB color system. An RGB color is specified by three numbers that give the level of red, green, and blue, respectively, in the color. A color in Java is an object of the class, java.awt.Color. You can construct a new color by specifying its red, blue, and green compo- nents. For example, Color myColor = new Color(r,g,b); There are two constructors that you can call in this way. In the one that I almost al- ways use, r, g, and b are integers in the range 0 to 255. In the other, they are num- bers of type float in the range 0.0F to 1.0F. (Recall that a literal of type float is written with an “F” to distinguish it from a double number.) Often, you can avoid constructing new colors altogether, since the Color class defines several named constants representing com- mon colors: Color.WHITE, Color.BLACK, Color.RED, Color.GREEN, Color.BLUE, Color.CYAN, Color.MAGENTA, Color.YELLOW, Color.PINK, Color.ORANGE, Color.LIGHT GRAY, Color.GRAY, and Color.DARK GRAY. (There are older, alternative names for these constants that use lower case rather than upper case constants, such as Color.red instead of Color.RED, but the upper case versions are preferred because they follow the convention that constant names should be upper case.) An alternative to RGB is the HSB color system. In the HSB system, a color is specified by three numbers called the hue, the saturation, and the brightness. The hue is the basic color, ranging from red through orange through all the other colors of the rainbow. The brightness is pretty much what it sounds like. A fully saturated color is a pure color tone. Decreasing the saturation is like mixing white or gray paint into the pure color. In Java, the hue, saturation and brightness are always specified by values of type float in the range from 0.0F to 1.0F. The Color class has a static member function named getHSBColor for creating HSB colors. To create the color with HSB values given by h, s, and b, you can say: Color myColor = Color.getHSBColor(h,s,b); For example, to make a color with a random hue that is as bright and as saturated as possible, you could use: Color randomColor = Color.getHSBColor( (float)Math.random(), 1.0F, 1.0F );
- 260. 244 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING The type cast is necessary because the value returned by Math.random() is of type double, and Color.getHSBColor() requires values of type float. (By the way, you might ask why RGB colors are created using a constructor while HSB colors are created using a static member function. The problem is that we would need two different constructors, both of them with three parameters of type float. Unfortunately, this is impossible. You can have two constructors only if the number of parameters or the parameter types differ.) The RGB system and the HSB system are just different ways of describing the same set of colors. It is possible to translate between one system and the other. The best way to understand the color systems is to experiment with them. In the on-line version of this section, you will find an applet that you can use to experiment with RGB and HSB colors. One of the properties of a Graphics object is the current drawing color, which is used for all drawing of shapes and text. If g is a graphics context, you can change the current drawing color for g using the method g.setColor(c), where c is a Color. For example, if you want to draw in green, you would just say g.setColor(Color.GREEN) before doing the drawing. The graphics context continues to use the color until you explicitly change it with another setColor() command. If you want to know what the current drawing color is, you can call the function g.getColor(), which returns an object of type Color. This can be useful if you want to change to another drawing color temporarily and then restore the previous drawing color. Every component has an associated foreground color and background color. Generally, the component is filled with the background color before anything else is drawn (although some components are “transparent,” meaning that the background color is ignored). When a new graphics context is created for a component, the current drawing color is set to the foreground color. Note that the foreground color and background color are properties of the component, not of a graphics context. The foreground and background colors can be set by instance methods setForeground(c) and setBackground(c), which are defined in the Component class and therefore are available for use with any component. This can be useful even for standard components, if you want them to use colors that are different from the defaults. 6.3.3 Fonts A font represents a particular size and style of text. The same character will appear different in different fonts. In Java, a font is characterized by a font name, a style, and a size. The available font names are system dependent, but you can always use the following four strings as font names: “Serif”, “SansSerif”, “Monospaced”, and “Dialog”. (A “serif” is a little decoration on a character, such as a short horizontal line at the bottom of the letter i. “SansSerif” means “without serifs.” “Monospaced” means that all the characters in the font have the same width. The “Dialog” font is the one that is typically used in dialog boxes.) The style of a font is specified using named constants that are defined in the Font class. You can specify the style as one of the four values: • Font.PLAIN, • Font.ITALIC, • Font.BOLD, or • Font.BOLD + Font.ITALIC. The size of a font is an integer. Size typically ranges from about 10 to 36, although larger sizes can also be used. The size of a font is usually about equal to the height of the largest characters in the font, in pixels, but this is not an exact rule. The size of the default font is 12.
- 261. 6.3. GRAPHICS AND PAINTING 245 Java uses the class named java.awt.Font for representing fonts. You can construct a new font by specifying its font name, style, and size in a constructor: Font plainFont = new Font("Serif", Font.PLAIN, 12); Font bigBoldFont = new Font("SansSerif", Font.BOLD, 24); Every graphics context has a current font, which is used for drawing text. You can change the current font with the setFont() method. For example, if g is a graphics context and bigBoldFont is a font, then the command g.setFont(bigBoldFont) will set the current font of g to bigBoldFont. The new font will be used for any text that is drawn after the setFont() command is given. You can find out the current font of g by calling the method g.getFont(), which returns an object of type Font. Every component has an associated font. It can be set with the instance method setFont(font), which is defined in the Component class. When a graphics context is cre- ated for drawing on a component, the graphic context’s current font is set equal to the font of the component. 6.3.4 Shapes The Graphics class includes a large number of instance methods for drawing various shapes, such as lines, rectangles, and ovals. The shapes are specified using the (x,y) coordinate system described above. They are drawn in the current drawing color of the graphics context. The current drawing color is set to the foreground color of the component when the graphics context is created, but it can be changed at any time using the setColor() method. Here is a list of some of the most important drawing methods. With all these commands, any drawing that is done outside the boundaries of the component is ignored. Note that all these methods are in the Graphics class, so they all must be called through an object of type Graphics. • drawString(String str, int x, int y) — Draws the text given by the string str. The string is drawn using the current color and font of the graphics context. x specifies the position of the left end of the string. y is the y-coordinate of the baseline of the string. The baseline is a horizontal line on which the characters rest. Some parts of the characters, such as the tail on a y or g, extend below the baseline. • drawLine(int x1, int y1, int x2, int y2) — Draws a line from the point (x1,y1) to the point (x2,y2). The line is drawn as if with a pen that hangs one pixel to the right and one pixel down from the (x,y) point where the pen is located. For example, if g refers to an object of type Graphics, then the command g.drawLine(x,y,x,y), which corresponds to putting the pen down at a point, colors the single pixel with upper left corner at the point (x,y). • drawRect(int x, int y, int width, int height) — Draws the outline of a rectangle. The upper left corner is at (x,y), and the width and height of the rectangle are as specified. If width equals height, then the rectangle is a square. If the width or the height is negative, then nothing is drawn. The rectangle is drawn with the same pen that is used for drawLine(). This means that the actual width of the rectangle as drawn is width+1, and similarly for the height. There is an extra pixel along the right edge and the bottom edge. For example, if you want to draw a rectangle around the edges of the component, you can say “g.drawRect(0, 0, getWidth()-1, getHeight()-1);”, where g is a graphics context for the component. If you use “g.drawRect(0, 0, getWidth(),
- 262. 246 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING getHeight());”, then the right and bottom edges of the rectangle will be drawn outside the component. • drawOval(int x, int y, int width, int height) — Draws the outline of an oval. The oval is one that just fits inside the rectangle specified by x, y, width, and height. If width equals height, the oval is a circle. • drawRoundRect(int x, int y, int width, int height, int xdiam, int ydiam) — Draws the outline of a rectangle with rounded corners. The basic rectangle is specified by x, y, width, and height, but the corners are rounded. The degree of rounding is given by xdiam and ydiam. The corners are arcs of an ellipse with horizontal diameter xdiam and vertical diameter ydiam. A typical value for xdiam and ydiam is 16, but the value used should really depend on how big the rectangle is. • draw3DRect(int x, int y, int width, int height, boolean raised) — Draws the outline of a rectangle that is supposed to have a three-dimensional effect, as if it is raised from the screen or pushed into the screen. The basic rectangle is specified by x, y, width, and height. The raised parameter tells whether the rectangle seems to be raised from the screen or pushed into it. The 3D effect is achieved by using brighter and darker versions of the drawing color for different edges of the rectangle. The documentation recommends setting the drawing color equal to the background color before using this method. The effect won’t work well for some colors. • drawArc(int x, int y, int width, int height, int startAngle, int arcAngle) — Draws part of the oval that just fits inside the rectangle specified by x, y, width, and height. The part drawn is an arc that extends arcAngle degrees from a starting angle at startAngle degrees. Angles are measured with 0 degrees at the 3 o’clock position (the positive direction of the horizontal axis). Positive angles are measured counterclockwise from zero, and negative angles are measured clockwise. To get an arc of a circle, make sure that width is equal to height. • fillRect(int x, int y, int width, int height) — Draws a filled-in rectangle. This fills in the interior of the rectangle that would be drawn by drawRect(x,y,width,height). The extra pixel along the bottom and right edges is not included. The width and height parameters give the exact width and height of the rectangle. For example, if you wanted to fill in the entire component, you could say “g.fillRect(0, 0, getWidth(), getHeight());” • fillOval(int x, int y, int width, int height) — Draws a filled-in oval. • fillRoundRect(int x, int y, int width, int height, int xdiam, int ydiam) — Draws a filled-in rounded rectangle. • fill3DRect(int x, int y, int width, int height, boolean raised) — Draws a filled-in three-dimensional rectangle. • fillArc(int x, int y, int width, int height, int startAngle, int arcAngle) — Draw a filled-in arc. This looks like a wedge of pie, whose crust is the arc that would be drawn by the drawArc method. 6.3.5 Graphics2D All drawing in Java is done through an object of type Graphics. The Graphics class provides basic commands for such things as drawing shapes and text and for selecting a drawing color.
- 263. 6.3. GRAPHICS AND PAINTING 247 These commands are adequate in many cases, but they fall far short of what’s needed in a serious computer graphics program. Java has another class, Graphics2D, that provides a larger set of drawing operations. Graphics2D is a sub-class of Graphics, so all the methods from the Graphics class are also available in a Graphics2D. The paintComponent() method of a JComponent gives you a graphics context of type Graphics that you can use for drawing on the component. In fact, the graphics context actually belongs to the sub-class Graphics2D (in Java version 1.2 and later), and can be type-cast to gain access to the advanced Graphics2D drawing methods: public void paintComponent(Graphics g) { super.paintComponent(g); Graphics2D g2; g2 = (Graphics2D)g; . . // Draw on the component using g2. . } Drawing in Graphics2D is based on shapes, which are objects that implement an interface named Shape. Shape classes include Line2D, Rectangle2D, Ellipse2D, Arc2D, and CubicCurve2D, among others; all these classes are defined in the package java.awt.geom. CubicCurve2D can be used to draw Bezier Curves, which are used in many graphics programs. Graphics2D has methods draw(Shape) and fill(Shape) for drawing the outline of a shape and for filling its interior. Advanced capabilities include: lines that are more than one pixel thick, dotted and dashed lines, filling a shape with a texture (this is, with a repeated image), filling a shape with a gradient, and drawing translucent objects that will blend with their background. In the Graphics class, coordinates are specified as integers and are based on pixels. The shapes that are used with Graphics2D use real numbers for coordinates, and they are not neces- sarily bound to pixels. In fact, you can change the coordinate system and use any coordinates that are convenient to your application. In computer graphics terms, you can apply a “transfor- mation” to the coordinate system. The transformation can be any combination of translation, scaling, and rotation. I mention Graphics2D here for completeness. I will not use any of the advanced capabilities of Graphics2D in this chapter, but I will cover a few of them in Section 12.2. 6.3.6 An Example Let’s use some of the material covered in this section to write a subclass of JPanel for use as a drawing surface. The panel can then be used in either an applet or a frame, as discussed in Subsection 6.2.2. All the drawing will be done in the paintComponent() method of the panel class. The panel will draw multiple copies of a message on a black background. Each copy of the message is in a random color. Five different fonts are used, with different sizes and styles. The message can be specified in the constructor; if the default constructor is used, the message is the string “Java!”. The panel works OK no matter what its size. Here is what the panel looks like:
- 264. 248 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING There is one problem with the way this class works. When the panel’s paintComponent() method is called, it chooses random colors, fonts, and locations for the messages. The informa- tion about which colors, fonts, and locations are used is not stored anywhere. The next time paintComponent() is called, it will make different random choices and will draw a different picture. For this particular applet, the problem only really appears when the panel is partially covered and then uncovered (and even then the problem does not show up in all environments). It is possible that only the part that was covered will be redrawn, and in the part that’s not redrawn, the old picture will remain. The user might see partial messages, cut off by the di- viding line between the new picture and the old. A better approach would be to compute the contents of the picture elsewhere, outside the paintComponent() method. Information about the picture should be stored in instance variables, and the paintComponent() method should use that information to draw the picture. If paintComponent() is called twice, it should draw the same picture twice, unless the data has changed in the meantime. Unfortunately, to store the data for the picture in this applet, we would need to use either arrays, which will not be covered until Chapter 7, or off-screen images, which will not be covered until Chapter 12. Other examples in this chapter will suffer from the same problem. The source for the panel class is shown below. I use an instance variable called message to hold the message that the panel will display. There are five instance variables of type Font that represent different sizes and styles of text. These variables are initialized in the constructor and are used in the paintComponent() method. The paintComponent() method for the panel simply draws 25 copies of the message. For each copy, it chooses one of the five fonts at random, and it calls g.setFont() to select that font for drawing the text. It creates a random HSB color and uses g.setColor() to select that color for drawing. It then chooses random (x,y) coordinates for the location of the message. The x coordinate gives the horizontal position of the left end of the string. The formula used for the x coordinate, “-50 + (int)(Math.random() * (width+40))” gives a random integer in the range from -50 to width-10. This makes it possible for the string to extend beyond the left edge or the right edge of the panel. Similarly, the formula for y allows the string to extend beyond the top and bottom of the applet. Here is the complete source code for the RandomStringsPanel import java.awt.Color; import java.awt.Font; import java.awt.Graphics; import javax.swing.JPanel; /** * This panel displays 25 copies of a message. The color and * position of each message is selected at random. The font
- 265. 6.3. GRAPHICS AND PAINTING 249 * of each message is randomly chosen from among five possible * fonts. The messages are displayed on a black background. * <p>Note: The style of drawing used here is bad, because every * time the paintComponent() method is called, new random values are * used. This means that a different picture will be drawn each * time. This is particularly bad if only part of the panel * needs to be redrawn, since then the panel will contain * cut-off pieces of messages. * <p>This panel is meant to be used as the content pane in * either an applet or a frame. */ public class RandomStringsPanel extends JPanel { private String message; // The message to be displayed. This can be set in // the constructor. If no value is provided in the // constructor, then the string "Java!" is used. private Font font1, font2, font3, font4, font5; // The five fonts. /** * Default constructor creates a panel that displays the message "Java!". * */ public RandomStringsPanel() { this(null); // Call the other constructor, with parameter null. } /** * Constructor creates a panel to display 25 copies of a specified message. * @param messageString The message to be displayed. If this is null, * then the default message "Java!" is displayed. */ public RandomStringsPanel(String messageString) { message = messageString; if (message == null) message = "Java!"; font1 = new Font("Serif", Font.BOLD, 14); font2 = new Font("SansSerif", Font.BOLD + Font.ITALIC, 24); font3 = new Font("Monospaced", Font.PLAIN, 30); font4 = new Font("Dialog", Font.PLAIN, 36); font5 = new Font("Serif", Font.ITALIC, 48); setBackground(Color.BLACK); } /** * The paintComponent method is responsible for drawing the content of the panel. * It draws 25 copies of the message string, using a random color, font, and * position for each string. */ public void paintComponent(Graphics g) { super.paintComponent(g); // Call the paintComponent method from the // superclass, JPanel. This simply fills the // entire panel with the background color, black.
- 266. 250 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING int width = getWidth(); int height = getHeight(); for (int i = 0; i < 25; i++) { // Draw one string. First, set the font to be one of the five // available fonts, at random. int fontNum = (int)(5*Math.random()) + 1; switch (fontNum) { case 1: g.setFont(font1); break; case 2: g.setFont(font2); break; case 3: g.setFont(font3); break; case 4: g.setFont(font4); break; case 5: g.setFont(font5); break; } // end switch // Set the color to a bright, saturated color, with random hue. float hue = (float)Math.random(); g.setColor( Color.getHSBColor(hue, 1.0F, 1.0F) ); // Select the position of the string, at random. int x,y; x = -50 + (int)(Math.random()*(width+40)); y = (int)(Math.random()*(height+20)); // Draw the message. g.drawString(message,x,y); } // end for } // end paintComponent() } // end class RandomStringsPanel This class defines a panel, which is not something that can stand on its own. To see it on the screen, we have to use it in an applet or a frame. Here is a simple applet class that uses a RandomStringsPanel as its content pane: import javax.swing.JApplet; /** * A RandomStringsApplet displays 25 copies of a string, using random colors, * fonts, and positions for the copies. The message can be specified as the * value of an applet param with name "message." If no param with name * "message" is present, then the default message "Java!" is displayed.
- 267. 6.4. MOUSE EVENTS 251 * The actual content of the applet is an object of type RandomStringsPanel. */ public class RandomStringsApplet extends JApplet { public void init() { String message = getParameter("message"); RandomStringsPanel content = new RandomStringsPanel(message); setContentPane(content); } } Note that the message to be displayed in the applet can be set using an applet parameter when the applet is added to an HTML document. Using applets on Web pages was discussed in Sub- section 6.2.4. Remember that to use the applet on a Web page, you must include both the panel class file, RandomStringsPanel.class, and the applet class file, RandomStringsApplet.class, in the same directory as the HTML document (or, alternatively, bundle the two class files into a jar file, and put the jar file in the document directory). Instead of writing an applet, of course, we could use the panel in the window of a stand- alone application. You can find the source code for a main program that does this in the file RandomStringsApp.java. 6.4 Mouse Events Events are central to programming for a graphical user interface. A GUI program doesn’t have a main() routine that outlines what will happen when the program is run, in a step-by-step process from beginning to end. Instead, the program must be prepared to respond to various kinds of events that can happen at unpredictable times and in an order that the program doesn’t control. The most basic kinds of events are generated by the mouse and keyboard. The user can press any key on the keyboard, move the mouse, or press a button on the mouse. The user can do any of these things at any time, and the computer has to respond appropriately. In Java, events are represented by objects. When an event occurs, the system collects all the information relevant to the event and constructs an object to contain that information. Different types of events are represented by objects belonging to different classes. For example, when the user presses one of the buttons on a mouse, an object belonging to a class called MouseEvent is constructed. The object contains information such as the source of the event (that is, the component on which the user clicked), the (x,y) coordinates of the point in the component where the click occurred, and which button on the mouse was pressed. When the user presses a key on the keyboard, a KeyEvent is created. After the event object is constructed, it is passed as a parameter to a designated subroutine. By writing that subroutine, the programmer says what should happen when the event occurs. As a Java programmer, you get a fairly high-level view of events. There is a lot of processing that goes on between the time that the user presses a key or moves the mouse and the time that a subroutine in your program is called to respond to the event. Fortunately, you don’t need to know much about that processing. But you should understand this much: Even though your GUI program doesn’t have a main() routine, there is a sort of main routine running somewhere that executes a loop of the form while the program is still running: Wait for the next event to occur Call a subroutine to handle the event
- 268. 252 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING This loop is called an event loop. Every GUI program has an event loop. In Java, you don’t have to write the loop. It’s part of “the system.” If you write a GUI program in some other language, you might have to provide a main routine that runs an event loop. In this section, we’ll look at handling mouse events in Java, and we’ll cover the framework for handling events in general. The next section will cover keyboard-related events and timer events. Java also has other types of events, which are produced by GUI components. These will be introduced in Section 6.6. 6.4.1 Event Handling For an event to have any effect, a program must detect the event and react to it. In order to detect an event, the program must “listen” for it. Listening for events is something that is done by an object called an event listener. An event listener object must contain instance methods for handling the events for which it listens. For example, if an object is to serve as a listener for events of type MouseEvent, then it must contain the following method (among several others): public void mousePressed(MouseEvent evt) { . . . } The body of the method defines how the object responds when it is notified that a mouse button has been pressed. The parameter, evt, contains information about the event. This information can be used by the listener object to determine its response. The methods that are required in a mouse event listener are specified in an interface named MouseListener. To be used as a listener for mouse events, an object must implement this MouseListener interface. Java interfaces were covered in Subsection 5.7.1. (To review briefly: An interface in Java is just a list of instance methods. A class can “implement” an interface by doing two things. First, the class must be declared to implement the interface, as in “class MyListener implements MouseListener” or “class MyApplet extends JApplet implements MouseListener”. Second, the class must include a definition for each instance method specified in the interface. An interface can be used as the type for a variable or formal parameter. We say that an object implements the MouseListener interface if it belongs to a class that implements the MouseListener interface. Note that it is not enough for the object to include the specified methods. It must also belong to a class that is specifically declared to implement the interface.) Many events in Java are associated with GUI components. For example, when the user presses a button on the mouse, the associated component is the one that the user clicked on. Before a listener object can “hear” events associated with a given component, the lis- tener object must be registered with the component. If a MouseListener object, mListener, needs to hear mouse events associated with a Component object, comp, the listener must be registered with the component by calling “comp.addMouseListener(mListener);”. The addMouseListener() method is an instance method in class Component, and so can be used with any GUI component object. In our first few examples, we will listen for events on a JPanel that is being used as a drawing surface. The event classes, such as MouseEvent, and the listener interfaces, such as MouseListener, are defined in the package java.awt.event. This means that if you want to work with events, you should either include the line “import java.awt.event.*;” at the beginning of your source code file or import the individual classes and interfaces. Admittedly, there is a large number of details to tend to when you want to use events. To summarize, you must
- 269. 6.4. MOUSE EVENTS 253 1. Put the import specification “import java.awt.event.*;” (or individual imports) at the beginning of your source code; 2. Declare that some class implements the appropriate listener interface, such as MouseLis- tener; 3. Provide definitions in that class for the subroutines from the interface; 4. Register the listener object with the component that will generate the events by calling a method such as addMouseListener() in the component. Any object can act as an event listener, provided that it implements the appropriate in- terface. A component can listen for the events that it itself generates. A panel can listen for events from components that are contained in the panel. A special class can be created just for the purpose of defining a listening object. Many people consider it to be good form to use anonymous inner classes to define listening objects (see Subsection 5.7.3). You will see all of these patterns in examples in this textbook. 6.4.2 MouseEvent and MouseListener The MouseListener interface specifies five different instance methods: public void mousePressed(MouseEvent evt); public void mouseReleased(MouseEvent evt); public void mouseClicked(MouseEvent evt); public void mouseEntered(MouseEvent evt); public void mouseExited(MouseEvent evt); The mousePressed method is called as soon as the user presses down on one of the mouse buttons, and mouseReleased is called when the user releases a button. These are the two methods that are most commonly used, but any mouse listener object must define all five methods; you can leave the body of a method empty if you don’t want to define a response. The mouseClicked method is called if the user presses a mouse button and then releases it quickly, without moving the mouse. (When the user does this, all three routines—mousePressed, mouseReleased, and mouseClicked—will be called in that order.) In most cases, you should define mousePressed instead of mouseClicked. The mouseEntered and mouseExited methods are called when the mouse cursor enters or leaves the component. For example, if you want the component to change appearance whenever the user moves the mouse over the component, you could define these two methods. As an example, we will look at a small addition to the RandomStringsPanel example from the previous section. In the new version, the panel will repaint itself when the user clicks on it. In order for this to happen, a mouse listener should listen for mouse events on the panel, and when the listener detects a mousePressed event, it should respond by calling the repaint() method of the panel. For the new version of the program, we need an object that implements the MouseListener interface. One way to create the object is to define a separate class, such as: import java.awt.Component; import java.awt.event.*; /** * An object of type RepaintOnClick is a MouseListener that * will respond to a mousePressed event by calling the repaint() * method of the source of the event. That is, a RepaintOnClick
- 270. 254 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING * object can be added as a mouse listener to any Component; * when the user clicks that component, the component will be * repainted. */ public class RepaintOnClick implements MouseListener { public void mousePressed(MouseEvent evt) { Component source = (Component)evt.getSource(); source.repaint(); // Call repaint() on the Component that was clicked. } public void mouseClicked(MouseEvent evt) { } public void mouseReleased(MouseEvent evt) { } public void mouseEntered(MouseEvent evt) { } public void mouseExited(MouseEvent evt) { } } This class does three of the four things that we need to do in order to handle mouse events: First, it imports java.awt.event.* for easy access to event-related classes. Second, it is declared that the class “implements MouseListener”. And third, it provides definitions for the five methods that are specified in the MouseListener interface. (Note that four of the five event-handling methods have empty defintions. We really only want to define a response to mousePressed events, but in order to implement the MouseListener interface, a class must define all five methods.) We must do one more thing to set up the event handling for this example: We must register an event-handling object as a listener with the component that will generate the events. In this case, the mouse events that we are interested in will be generated by an object of type RandomStringsPanel. If panel is a variable that refers to the panel object, we can create a mouse listener object and register it with the panel with the statements: RepaintOnClick listener = new RepaintOnClick(); // Create MouseListener object. panel.addMouseListener(listener); // Register MouseListener with the panel. Once this is done, the listener object will be notified of mouse events on the panel. When a mousePressed event occurs, the mousePressed() method in the listener will be called. The code in this method calls the repaint() method in the component that is the source of the event, that is, in the panel. The result is that the RandomStringsPanel is repainted with its strings in new random colors, fonts, and positions. Although we have written the RepaintOnClick class for use with our RandomStringsPanel example, the event-handling class contains no reference at all to the RandomStringsPanel class. How can this be? The mousePressed() method in class RepaintOnClick looks at the source of the event, and calls its repaint() method. If we have registered the RepaintOnClick object as a listener on a RandomStringsPanel, then it is that panel that is repainted. But the listener object could be used with any type of component, and it would work in the same way. Similarly, the RandomStringsPanel class contains no reference to the RepaintOnClick class— in fact, RandomStringsPanel was written before we even knew anything about mouse events! The panel will send mouse events to any object that has registered with it as a mouse listener. It does not need to know anything about that object except that it is capable of receiving mouse events. The relationship between an object that generates an event and an object that responds to that event is rather loose. The relationship is set up by registering one object to listen for
- 271. 6.4. MOUSE EVENTS 255 events from the other object. This is something that can potentially be done from outside both objects. Each object can be developed independently, with no knowledge of the internal operation of the other object. This is the essence of modular design: Build a complex system out of modules that interact only in straightforward, easy to understand ways. Then each module is a separate design problem that can be tackled independently. To make this clearer, consider the application version of the ClickableRandomStrings program. I have included RepaintOnClick as a nested class, although it could just as easily be a separate class. The main point is that this program uses the same RandomStringsPanel class that was used in the original program, which did not respond to mouse clicks. The mouse handling has been “bolted on” to an existing class, without having to make any changes at all to that class: import java.awt.Component; import java.awt.event.MouseEvent; import java.awt.event.MouseListener; import javax.swing.JFrame; /** * Displays a window that shows 25 copies of the string "Java!" in * random colors, fonts, and positions. The content of the window * is an object of type RandomStringsPanel. When the user clicks * the window, the content of the window is repainted, with the * strings in newly selected random colors, fonts, and positions. */ public class ClickableRandomStringsApp { public static void main(String[] args) { JFrame window = new JFrame("Random Strings"); RandomStringsPanel content = new RandomStringsPanel(); content.addMouseListener( new RepaintOnClick() ); // Register mouse listener. window.setContentPane(content); window.setDefaultCloseOperation(JFrame.EXIT ON CLOSE); window.setLocation(100,75); window.setSize(300,240); window.setVisible(true); } private static class RepaintOnClick implements MouseListener { public void mousePressed(MouseEvent evt) { Component source = (Component)evt.getSource(); source.repaint(); } public void mouseClicked(MouseEvent evt) { } public void mouseReleased(MouseEvent evt) { } public void mouseEntered(MouseEvent evt) { } public void mouseExited(MouseEvent evt) { } } }
- 272. 256 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING 6.4.3 Mouse Coordinates Often, when a mouse event occurs, you want to know the location of the mouse cursor. This information is available from the MouseEvent parameter to the event-handling method, which contains instance methods that return information about the event. If evt is the parame- ter, then you can find out the coordinates of the mouse cursor by calling evt.getX() and evt.getY(). These methods return integers which give the x and y coordinates where the mouse cursor was positioned at the time when the event occurred. The coordinates are ex- pressed in the coordinate system of the component that generated the event, where the top left corner of the component is (0,0). The user can hold down certain modifier keys while using the mouse. The possible mod- ifier keys include: the Shift key, the Control key, the ALT key (called the Option key on the Macintosh), and the Meta key (called the Command or Apple key on the Macintosh). You might want to respond to a mouse event differently when the user is holding down a modi- fier key. The boolean-valued instance methods evt.isShiftDown(), evt.isControlDown(), evt.isAltDown(), and evt.isMetaDown() can be called to test whether the modifier keys are pressed. You might also want to have different responses depending on whether the user presses the left mouse button, the middle mouse button, or the right mouse button. Now, not every mouse has a middle button and a right button, so Java handles the information in a peculiar way. It treats pressing the right button as equivalent to holding down the Meta key while pressing the left mouse button. That is, if the right button is pressed, then the instance method evt.isMetaDown() will return true (even if the Meta key is not pressed). Similarly, pressing the middle mouse button is equivalent to holding down the ALT key. In practice, what this really means is that pressing the right mouse button under Windows is equivalent to holding down the Command key while pressing the mouse button on Macintosh. A program tests for either of these by calling evt.isMetaDown(). As an example, consider a JPanel that does the following: Clicking on the panel with the left mouse button will place a red rectangle on the panel at the point where the mouse was clicked. Clicking with the right mouse button (or holding down the Command key while clicking on a Macintosh) will place a blue oval on the applet. Holding down the Shift key while clicking will clear the panel by removing all the shapes that have been placed. There are several ways to write this example. I could write a separate class to handle mouse events, as I did in the previous example. However, in this case, I decided to let the panel respond to mouse events itself. Any object can be a mouse listener, as long as it imple- ments the MouseListener interface. In this case, the panel class implements the MouseListener interface, so any object belonging to that class can act as a mouse listener. The constructor for the panel class registers the panel with itself as a mouse listener. It does this with the statement “addMouseListener(this)”. Since this command is in a method in the panel class, the addMouseListener() method in the panel object is being called, and a listener is being registered with that panel. The parameter “this” also refers to the panel object, so it is the same panel object that is listening for events. Thus, the panel object plays a dual role here. (If you find this too confusing, remember that you can always write a separate class to define the listening object.) The source code for the panel class is shown below. You should check how the instance methods in the MouseEvent object are used. You can also check for the Four Steps of Event Handling (“import java.awt.event.*”, “implements MouseListener”, definitions for the event-handling methods, and “addMouseListener”):
- 273. 6.4. MOUSE EVENTS 257 import java.awt.*; import java.awt.event.*; import javax.swing.*; /** * A simple demonstration of MouseEvents. Shapes are drawn * on a black background when the user clicks the panel If * the user Shift-clicks, the applet is cleared. If the user * right-clicks the applet, a blue oval is drawn. Otherwise, * when the user clicks, a red rectangle is drawn. The contents of * the panel are not persistent. For example, they might disappear * if the panel is covered and uncovered. */ public class SimpleStamperPanel extends JPanel implements MouseListener { /** * This constructor simply sets the background color of the panel to be black * and sets the panel to listen for mouse events on itself. */ public SimpleStamperPanel() { setBackground(Color.BLACK); addMouseListener(this); } /** * Since this panel has been set to listen for mouse events on itself, * this method will be called when the user clicks the mouse on the panel. * This method is part of the MouseListener interface. */ public void mousePressed(MouseEvent evt) { if ( evt.isShiftDown() ) { // The user was holding down the Shift key. Just repaint the panel. // Since this class does not define a paintComponent() method, the // method from the superclass, JPanel, is called. That method simply // fills the panel with its background color, which is black. The // effect is to clear the panel. repaint(); return; } int x = evt.getX(); // x-coordinate where user clicked. int y = evt.getY(); // y-coordinate where user clicked. Graphics g = getGraphics(); // Graphics context for drawing directly. // NOTE: This is considered to be bad style! if ( evt.isMetaDown() ) { // User right-clicked at the point (x,y). Draw a blue oval centered // at the point (x,y). (A black outline around the oval will make it // more distinct when ovals and rects overlap.) g.setColor(Color.BLUE); // Blue interior. g.fillOval( x - 30, y - 15, 60, 30 ); g.setColor(Color.BLACK); // Black outline. g.drawOval( x - 30, y - 15, 60, 30 ); }
- 274. 258 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING else { // User left-clicked (or middle-clicked) at (x,y). // Draw a red rectangle centered at (x,y). g.setColor(Color.RED); // Red interior. g.fillRect( x - 30, y - 15, 60, 30 ); g.setColor(Color.BLACK); // Black outline. g.drawRect( x - 30, y - 15, 60, 30 ); } g.dispose(); // We are finished with the graphics context, so dispose of it. } // end mousePressed(); // The next four empty routines are required by the MouseListener interface. // Since they don’t do anything in this class, so their definitions are empty. public void mouseEntered(MouseEvent evt) { } public void mouseExited(MouseEvent evt) { } public void mouseClicked(MouseEvent evt) { } public void mouseReleased(MouseEvent evt) { } } // end class SimpleStamperPanel Note, by the way, that this class violates the rule that all drawing should be done in a paintComponent() method. The rectangles and ovals are drawn directly in the mousePressed() routine. To make this possible, I need to obtain a graphics context by saying “g = getGraphics()”. After using g for drawing, I call g.dispose() to inform the operating system that I will no longer be using g for drawing. It is a good idea to do this to free the system resources that are used by the graphics context. I do not advise doing this type of direct drawing if it can be avoided, but you can see that it does work in this case, and at this point we really have no other way to write this example. 6.4.4 MouseMotionListeners and Dragging Whenever the mouse is moved, it generates events. The operating system of the computer detects these events and uses them to move the mouse cursor on the screen. It is also possible for a program to listen for these “mouse motion” events and respond to them. The most common reason to do so is to implement dragging. Dragging occurs when the user moves the mouse while holding down a mouse button. The methods for responding to mouse motion events are defined in an interface named MouseMotionListener. This interface specifies two event-handling methods: public void mouseDragged(MouseEvent evt); public void mouseMoved(MouseEvent evt); The mouseDragged method is called if the mouse is moved while a button on the mouse is pressed. If the mouse is moved while no mouse button is down, then mouseMoved is called instead. The parameter, evt, is an object of type MouseEvent. It contains the x and y coordi- nates of the mouse’s location. As long as the user continues to move the mouse, one of these methods will be called over and over. (So many events are generated that it would be inefficient for a program to hear them all, if it doesn’t want to do anything in response. This is why the mouse motion event-handlers are defined in a separate interface from the other mouse events: You can listen for the mouse events defined in MouseListener without automatically hearing all mouse motion events as well.)
- 275. 6.4. MOUSE EVENTS 259 If you want your program to respond to mouse motion events, you must create an object that implements the MouseMotionListener interface, and you must register that object to listen for events. The registration is done by calling a component’s addMouseMotionListener method. The object will then listen for mouseDragged and mouseMoved events associated with that component. In most cases, the listener object will also implement the MouseListener interface so that it can respond to the other mouse events as well. To get a better idea of how mouse events work, you should try the SimpleTrackMouseApplet in the on-line version of this section. The applet is programmed to respond to any of the seven different kinds of mouse events by displaying the coordinates of the mouse, the type of event, and a list of the modifier keys that are down (Shift, Control, Meta, and Alt). You can experiment with the applet to see what happens when you use the mouse on the applet. (Alternatively, you could run the stand-alone application version of the program, SimpleTrackMouse.java.) The source code for the applet can be found in SimpleTrackMousePanel.java, which defines the panel that is used as the content pane of the applet, and in SimpleTrackMouseApplet.java, which defines the applet class. The panel class includes a nested class, MouseHandler, that defines the mouse-handling object. I encourage you to read the source code. You should now be familiar with all the techniques that it uses. It is interesting to look at what a program needs to do in order to respond to dragging op- erations. In general, the response involves three methods: mousePressed(), mouseDragged(), and mouseReleased(). The dragging gesture starts when the user presses a mouse button, it continues while the mouse is dragged, and it ends when the user releases the button. This means that the programming for the response to one dragging gesture must be spread out over the three methods! Furthermore, the mouseDragged() method can be called many times as the mouse moves. To keep track of what is going on between one method call and the next, you need to set up some instance variables. In many applications, for example, in order to process a mouseDragged event, you need to remember the previous coordinates of the mouse. You can store this information in two instance variables prevX and prevY of type int. It can also be useful to save the starting coordinates, where the mousePressed event occurred, in instance variables. I also suggest having a boolean variable, dragging, which is set to true while a dragging gesture is being processed. This is necessary because not every mousePressed event starts a dragging operation to which you want to respond. The mouseDragged and mouseReleased methods can use the value of dragging to check whether a drag operation is actually in progress. You might need other instance variables as well, but in general outline, a class that handles mouse dragging looks like this: import java.awt.event.*; public class MouseDragHandler implements MouseListener, MouseMotionListener { private int startX, startY; // Point where mouse is pressed. private int prevX, prevY; // Most recently processed mouse coords. private boolean dragging; // Set to true when dragging is in process. . . . // other instance variables for use in dragging public void mousePressed(MouseEvent evt) { if ( we-want-to-start-dragging ) { dragging = true; startX = evt.getX(); // Remember starting position. startY = evt.getY(); prevX = startX; // Remember most recent coords. prevY = startY;
- 276. 260 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING . . // Other processing. . } } public void mouseDragged(MouseEvent evt) { if ( dragging == false ) // First, check if we are return; // processing a dragging gesture. int x = evt.getX(); // Current position of Mouse. int y = evt.getY(); . . // Process a mouse movement from (prevX, prevY) to (x,y). . prevX = x; // Remember the current position for the next call. prevY = y; } public void mouseReleased(MouseEvent evt) { if ( dragging == false ) // First, check if we are return; // processing a dragging gesture. dragging = false; // We are done dragging. . . // Other processing and clean-up. . } } As an example, let’s look at a typical use of dragging: allowing the user to sketch a curve by dragging the mouse. This example also shows many other features of graphics and mouse pro- cessing. In the program, you can draw a curve by dragging the mouse on a large white drawing area, and you can select a color for drawing by clicking on one of several colored rectangles to the right of the drawing area. The complete source code can be found in SimplePaint.java, which can be run as a stand-alone application, and you can find an applet version in the on-line version of this section. Here is a picture of the program:
- 277. 6.4. MOUSE EVENTS 261 I will discuss a few aspects of the source code here, but I encourage you to read it carefully in its entirety. There are lots of informative comments in the source code. (The source code uses one unusual technique: It defines a subclass of JApplet, but it also includes a main() routine. The main() routine has nothing to do with the class’s use as an applet, but it makes it possible to run the class as a stand-alone application. When this is done, the application opens a window that shows the same panel that would be shown in the applet version. This example thus shows how to write a single file that can be used either as a stand-alone application or as an applet.) The panel class for this example is designed to work for any reasonable size, that is, unless the panel is too small. This means that coordinates are computed in terms of the actual width and height of the panel. (The width and height are obtained by calling getWidth() and getHeight().) This makes things quite a bit harder than they would be if we assumed some particular fixed size for the panel. Let’s look at some of these computations in detail. For example, the large white drawing area extends from y = 3 to y = height - 3 vertically and from x = 3 to x = width - 56 horizontally. These numbers are needed in order to interpret the meaning of a mouse click. They take into account a gray border around the panel and the color palette along the right edge of the panel. The border is 3 pixels wide. The colored rectangles are 50 pixels wide. Together with the 3-pixel border around the panel and a 3-pixel divider between the drawing area and the colored rectangles, this adds up to put the right edge of the drawing area 56 pixels from the right edge of the panel. A white square labeled “CLEAR” occupies a 50-by-50 pixel region beneath the colored rect- angles on the right edge of the panel. Allowing for this square, we can figure out how much vertical space is available for the seven colored rectangles, and then divide that space by 7 to get the vertical space available for each rectangle. This quantity is represented by a variable, colorSpace. Out of this space, 3 pixels are used as spacing between the rectangles, so the height of each rectangle is colorSpace - 3. The top of the N-th rectangle is located (N*colorSpace + 3) pixels down from the top of the panel, assuming that we count the rectangles starting with zero. This is because there are N rectangles above the N-th rectangle, each of which uses colorSpace pixels. The extra 3 is for the border at the top of the panel. After all that, we can write down the command for drawing the N-th rectangle: g.fillRect(width - 53, N*colorSpace + 3, 50, colorSpace - 3); That was not easy! But it shows the kind of careful thinking and precision graphics that are sometimes necessary to get good results. The mouse in this panel is used to do three different things: Select a color, clear the drawing, and draw a curve. Only the third of these involves dragging, so not every mouse click will start a dragging operation. The mousePressed routine has to look at the (x,y) coordinates where the mouse was clicked and decide how to respond. If the user clicked on the CLEAR rectangle, the drawing area is cleared by calling repaint(). If the user clicked somewhere in the strip of colored rectangles, the selected color is changed. This involves computing which color the user clicked on, which is done by dividing the y coordinate by colorSpace. Finally, if the user clicked on the drawing area, a drag operation is initiated. A boolean variable, dragging, is set to true so that the mouseDragged and mouseReleased methods will know that a curve is being drawn. The code for this follows the general form given above. The actual drawing of the curve is done in the mouseDragged method, which draws a line from the previous location of the mouse to its current location. Some effort is required to make sure that the line does not extend beyond the white drawing area of the panel. This is not automatic, since as far as the computer is concerned, the border and the color bar are part of the drawing surface. If the
- 278. 262 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING user drags the mouse outside the drawing area while drawing a line, the mouseDragged routine changes the x and y coordinates to make them lie within the drawing area. 6.4.5 Anonymous Event Handlers As I mentioned above, it is a fairly common practice to use anonymous nested classes to define listener objects. As discussed in Subsection 5.7.3, a special form of the new operator is used to create an object that belongs to an anonymous class. For example, a mouse listener object can be created with an expression of the form: new MouseListener() { public void mousePressed(MouseEvent evt) { . . . } public void mouseReleased(MouseEvent evt) { . . . } public void mouseClicked(MouseEvent evt) { . . . } public void mouseEntered(MouseEvent evt) { . . . } public void mouseExited(MouseEvent evt) { . . . } } This is all just one long expression that both defines an un-named class and creates an object that belongs to that class. To use the object as a mouse listener, it should be passed as the parameter to some component’s addMouseListener() method in a command of the form: component.addMouseListener( new MouseListener() { public void mousePressed(MouseEvent evt) { . . . } public void mouseReleased(MouseEvent evt) { . . . } public void mouseClicked(MouseEvent evt) { . . . } public void mouseEntered(MouseEvent evt) { . . . } public void mouseExited(MouseEvent evt) { . . . } } ); Now, in a typical application, most of the method definitions in this class will be empty. A class that implements an interface must provide definitions for all the methods in that interface, even if the definitions are empty. To avoid the tedium of writing empty method definitions in cases like this, Java provides adapter classes. An adapter class implements a listener interface by providing empty definitions for all the methods in the interface. An adapter class is useful only as a basis for making subclasses. In the subclass, you can define just those methods that you actually want to use. For the remaining methods, the empty definitions that are provided by the adapter class will be used. The adapter class for the MouseListener interface is named MouseAdapter. For example, if you want a mouse listener that only responds to mouse-pressed events, you can use a command of the form: component.addMouseListener( new MouseAdapter() { public void mousePressed(MouseEvent evt) { . . . } } ); To see how this works in a real example, let’s write another version of the ClickableRandomStringsApp application from Subsection 6.4.2. This version uses an anony- mous class based on MouseAdapter to handle mouse events: import java.awt.Component; import java.awt.event.MouseEvent; import java.awt.event.MouseListener; import javax.swing.JFrame; public class ClickableRandomStringsApp {
- 279. 6.4. MOUSE EVENTS 263 public static void main(String[] args) { JFrame window = new JFrame("Random Strings"); RandomStringsPanel content = new RandomStringsPanel(); content.addMouseListener( new MouseAdapter() { // Register a mouse listener that is defined by an anonymous subclass // of MouseAdapter. This replaces the RepaintOnClick class that was // used in the original version. public void mousePressed(MouseEvent evt) { Component source = (Component)evt.getSource(); source.repaint(); } } ); window.setContentPane(content); window.setDefaultCloseOperation(JFrame.EXIT ON CLOSE); window.setLocation(100,75); window.setSize(300,240); window.setVisible(true); } } Anonymous inner classes can be used for other purposes besides event handling. For ex- ample, suppose that you want to define a subclass of JPanel to represent a drawing surface. The subclass will only be used once. It will redefine the paintComponent() method, but will make no other changes to JPanel. It might make sense to define the subclass as an anony- mous nested class. As an example, I present HelloWorldGUI4.java. This version is a variation of HelloWorldGUI2.java that uses anonymous nested classes where the original program uses ordinary, named nested classes: import java.awt.*; import java.awt.event.*; import javax.swing.*; /** * A simple GUI program that creates and opens a JFrame containing * the message "Hello World" and an "OK" button. When the user clicks * the OK button, the program ends. This version uses anonymous * classes to define the message display panel and the action listener * object. Compare to HelloWorldGUI2, which uses nested classes. */ public class HelloWorldGUI4 { /** * The main program creates a window containing a HelloWorldDisplay * and a button that will end the program when the user clicks it. */ public static void main(String[] args) { JPanel displayPanel = new JPanel() { // An anonymous subclass of JPanel that displays "Hello World!". public void paintComponent(Graphics g) { super.paintComponent(g); g.drawString( "Hello World!", 20, 30 ); }
- 280. 264 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING }; JButton okButton = new JButton("OK"); okButton.addActionListener( new ActionListener() { // An anonymous class that defines the listener object. public void actionPerformed(ActionEvent e) { System.exit(0); } } ); JPanel content = new JPanel(); content.setLayout(new BorderLayout()); content.add(displayPanel, BorderLayout.CENTER); content.add(okButton, BorderLayout.SOUTH); JFrame window = new JFrame("GUI Test"); window.setContentPane(content); window.setSize(250,100); window.setLocation(100,100); window.setVisible(true); } } 6.5 Timer and Keyboard Events Not every event is generated by an action on the part of the user. Events can also be generated by objects as part of their regular programming, and these events can be monitored by other objects so that they can take appropriate actions when the events occur. One example of this is the class javax.swing.Timer. A Timer generates events at regular intervals. These events can be used to drive an animation or to perform some other task at regular intervals. We will begin this section with a look at timer events and animation. We will then look at another type of basic user-generated event: the KeyEvents that are generated when the user types on the keyboard. The example at the end of the section uses both a timer and keyboard events to implement a simple game. 6.5.1 Timers and Animation An object belonging to the class javax.swing.Timer exists only to generate events. A Timer, by default, generates a sequence of events with a fixed delay between each event and the next. (It is also possible to set a Timer to emit a single event after a specified time delay; in that case, the timer is being used as an “alarm.”) Each event belongs to the class ActionEvent. An object that is to listen for the events must implement the interface ActionListener, which defines just one method: public void actionPerformed(ActionEvent evt) To use a Timer, you must create an object that implements the ActionListener interface. That is, the object must belong to a class that is declared to “implement ActionListener”, and that class must define the actionPerformed method. Then, if the object is set to listen for
- 281. 6.5. TIMER AND KEYBOARD EVENTS 265 events from the timer, the code in the listener’s actionPerformed method will be executed every time the timer generates an event. Since there is no point to having a timer without having a listener to respond to its events, the action listener for a timer is specified as a parameter in the timer’s constructor. The time delay between timer events is also specified in the constructor. If timer is a variable of type Timer, then the statement timer = new Timer( millisDelay, listener ); creates a timer with a delay of millisDelay milliseconds between events (where 1000 mil- liseconds equal one second). Events from the timer are sent to the listener. (millisDelay must be of type int, and listener must be of type ActionListener.) Note that a timer is not guaranteed to deliver events at precisely regular intervals. If the computer is busy with some other task, an event might be delayed or even dropped altogether. A timer does not automatically start generating events when the timer object is created. The start() method in the timer must be called to tell the timer to start generating events. The timer’s stop() method can be used to turn the stream of events off—it can be restarted by calling start() again. ∗ ∗ ∗ One application of timers is computer animation. A computer animation is just a sequence of still images, presented to the user one after the other. If the time between images is short, and if the change from one image to another is not too great, then the user perceives continuous motion. The easiest way to do animation in Java is to use a Timer to drive the animation. Each time the timer generates an event, the next frame of the animation is computed and drawn on the screen—the code that implements this goes in the actionPerformed method of an object that listens for events from the timer. Our first example of using a timer is not exactly an animation, but it does display a new image for each timer event. The program shows randomly generated images that vaguely resemble works of abstract art. In fact, the program draws a new random image every time its paintComponent() method is called, and the response to a timer event is simply to call repaint(), which in turn triggers a call to paintComponent. The work of the program is done in a subclass of JPanel, which starts like this: import java.awt.*; import java.awt.event.*; import javax.swing.*; public class RandomArtPanel extends JPanel { /** * A RepaintAction object calls the repaint method of this panel each * time its actionPerformed() method is called. An object of this * type is used as an action listener for a Timer that generates an * ActionEvent every four seconds. The result is that the panel is * redrawn every four seconds. */ private class RepaintAction implements ActionListener { public void actionPerformed(ActionEvent evt) { repaint(); // Call the repaint() method in the panel class. } }
- 282. 266 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING /** * The constructor creates a timer with a delay time of four seconds * (4000 milliseconds), and with a RepaintAction object as its * ActionListener. It also starts the timer running. */ public RandomArtPanel() { RepaintAction action = new RepaintAction(); Timer timer = new Timer(4000, action); timer.start(); } /** * The paintComponent() method fills the panel with a random shade of * gray and then draws one of three types of random "art". The type * of art to be drawn is chosen at random. */ public void paintComponent(Graphics g) { . . // The rest of the class is omitted . You can find the full source code for this class in the file RandomArtPanel.java; An application version of the program is RandomArt.java, while the applet version is RandomArtApplet.java. You can see the applet version in the on-line version of this section. Later in this section, we will use a timer to drive the animation in a simple computer game. 6.5.2 Keyboard Events In Java, user actions become events in a program. These events are associated with GUI components. When the user presses a button on the mouse, the event that is generated is associated with the component that contains the mouse cursor. What about keyboard events? When the user presses a key, what component is associated with the key event that is generated? A GUI uses the idea of input focus to determine the component associated with keyboard events. At any given time, exactly one interface element on the screen has the input focus, and that is where all keyboard events are directed. If the interface element happens to be a Java component, then the information about the keyboard event becomes a Java object of type KeyEvent, and it is delivered to any listener objects that are listening for KeyEvents associated with that component. The necessity of managing input focus adds an extra twist to working with keyboard events. It’s a good idea to give the user some visual feedback about which component has the input focus. For example, if the component is the typing area of a word-processor, the feedback is usually in the form of a blinking text cursor. Another common visual clue is to draw a brightly colored border around the edge of a component when it has the input focus, as I do in the examples given later in this section. A component that wants to have the input focus can call the method requestFocus(), which is defined in the Component class. Calling this method does not absolutely guarantee that the component will actually get the input focus. Several components might request the focus; only one will get it. This method should only be used in certain circumstances in any case, since it can be a rude surprise to the user to have the focus suddenly pulled away from a component that the user is working with. In a typical user interface, the user can choose to
- 283. 6.5. TIMER AND KEYBOARD EVENTS 267 give the focus to a component by clicking on that component with the mouse. And pressing the tab key will often move the focus from one component to another. Some components do not automatically request the input focus when the user clicks on them. To solve this problem, a program has to register a mouse listener with the compo- nent to detect user clicks. In response to a user click, the mousePressed() method should call requestFocus() for the component. This is true, in particular, for the components that are used as drawing surfaces in the examples in this chapter. These components are defined as subclasses of JPanel, and JPanel objects do not receive the input focus automatically. If you want to be able to use the keyboard to interact with a JPanel named drawingSurface, you have to register a listener to listen for mouse events on the drawingSurface and call drawingSurface.requestFocus() in the mousePressed() method of the listener object. As our first example of processing key events, we look at a simple program in which the user moves a square up, down, left, and right by pressing arrow keys. When the user hits the ’R’, ’G’, ’B’, or ’K’ key, the color of the square is set to red, green, blue, or black, respectively. Of course, none of these key events are delivered to the program unless it has the input focus. The panel in the program changes its appearance when it has the input focus: When it does, a cyan-colored border is drawn around the panel; when it does not, a gray-colored border is drawn. Also, the panel displays a different message in each case. If the panel does not have the input focus, the user can give the input focus to the panel by clicking on it. The complete source code for this example can be found in the file KeyboardAndFocusDemo.java. I will discuss some aspects of it below. After reading this section, you should be able to understand the source code in its entirety. Here is what the program looks like in its focussed state: In Java, keyboard event objects belong to a class called KeyEvent. An object that needs to listen for KeyEvents must implement the interface named KeyListener. Furthermore, the object must be registered with a component by calling the component’s addKeyListener() method. The registration is done with the command “component.addKeyListener(listener);” where listener is the object that is to listen for key events, and component is the object that will generate the key events (when it has the input focus). It is possible for component and listener to be the same object. All this is, of course, directly analogous to what you learned about mouse events in the previous section. The KeyListener interface defines the following methods, which must be included in any class that implements KeyListener: public void keyPressed(KeyEvent evt); public void keyReleased(KeyEvent evt); public void keyTyped(KeyEvent evt); Java makes a careful distinction between the keys that you press and the characters that you type. There are lots of keys on a keyboard: letter keys, number keys, modifier keys such as Control and Shift, arrow keys, page up and page down keys, keypad keys, function keys. In
- 284. 268 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING many cases, pressing a key does not type a character. On the other hand, typing a character sometimes involves pressing several keys. For example, to type an uppercase ’A’, you have to press the Shift key and then press the A key before releasing the Shift key. On my Macintosh computer, I can type an accented e, by holding down the Option key, pressing the E key, releasing the Option key, and pressing E again. Only one character was typed, but I had to perform three key-presses and I had to release a key at the right time. In Java, there are three types of KeyEvent. The types correspond to pressing a key, releasing a key, and typing a character. The keyPressed method is called when the user presses a key, the keyReleased method is called when the user releases a key, and the keyTyped method is called when the user types a character. Note that one user action, such as pressing the E key, can be responsible for two events, a keyPressed event and a keyTyped event. Typing an upper case ’A’ can generate two keyPressed, two keyReleased, and one keyTyped event. Usually, it is better to think in terms of two separate streams of events, one consisting of keyPressed and keyReleased events and the other consisting of keyTyped events. For some applications, you want to monitor the first stream; for other applications, you want to monitor the second one. Of course, the information in the keyTyped stream could be extracted from the keyPressed/keyReleased stream, but it would be difficult (and also system-dependent to some extent). Some user actions, such as pressing the Shift key, can only be detected as keyPressed events. I have a solitaire game on my computer that hilites every card that can be moved, when I hold down the Shift key. You could do something like that in Java by hiliting the cards when the Shift key is pressed and removing the hilite when the Shift key is released. There is one more complication. Usually, when you hold down a key on the keyboard, that key will auto-repeat. This means that it will generate multiple keyPressed events, as long as it is held down. It can also generate multiple keyTyped events. For the most part, this will not affect your programming, but you should not expect every keyPressed event to have a corresponding keyReleased event. Every key on the keyboard has an integer code number. (Actually, this is only true for keys that Java knows about. Many keyboards have extra keys that can’t be used with Java.) When the keyPressed or keyReleased method is called, the parameter, evt, contains the code of the key that was pressed or released. The code can be obtained by calling the function evt.getKeyCode(). Rather than asking you to memorize a table of code numbers, Java provides a named constant for each key. These constants are defined in the KeyEvent class. For example the constant for the shift key is KeyEvent.VK SHIFT. If you want to test whether the key that the user pressed is the Shift key, you could say “if (evt.getKeyCode() == KeyEvent.VK SHIFT)”. The key codes for the four arrow keys are KeyEvent.VK LEFT, KeyEvent.VK RIGHT, KeyEvent.VK UP, and KeyEvent.VK DOWN. Other keys have similar codes. (The “VK” stands for “Virtual Keyboard”. In reality, different keyboards use different key codes, but Java translates the actual codes from the keyboard into its own “virtual” codes. Your program only sees these virtual key codes, so it will work with various keyboards on various platforms without modification.) In the case of a keyTyped event, you want to know which character was typed. This information can be obtained from the parameter, evt, in the keyTyped method by calling the function evt.getKeyChar(). This function returns a value of type char representing the character that was typed. In the KeyboardAndFocusDemo program, I use the keyPressed routine to respond when the user presses one of the arrow keys. The applet includes instance variables, squareLeft and squareTop, that give the position of the upper left corner of the movable square. When the
- 285. 6.5. TIMER AND KEYBOARD EVENTS 269 user presses one of the arrow keys, the keyPressed routine modifies the appropriate instance variable and calls repaint() to redraw the panel with the square in its new position. Note that the values of squareLeft and squareTop are restricted so that the square never moves outside the white area of the panel: /** * This is called each time the user presses a key while the panel has * the input focus. If the key pressed was one of the arrow keys, * the square is moved (except that it is not allowed to move off the * edge of the panel, allowing for a 3-pixel border). */ public void keyPressed(KeyEvent evt) { int key = evt.getKeyCode(); // keyboard code for the pressed key if (key == KeyEvent.VK LEFT) { // move the square left squareLeft -= 8; if (squareLeft < 3) squareLeft = 3; repaint(); } else if (key == KeyEvent.VK RIGHT) { // move the square right squareLeft += 8; if (squareLeft > getWidth() - 3 - SQUARE SIZE) squareLeft = getWidth() - 3 - SQUARE SIZE; repaint(); } else if (key == KeyEvent.VK UP) { // move the squre up squareTop -= 8; if (squareTop < 3) squareTop = 3; repaint(); } else if (key == KeyEvent.VK DOWN) { // move the square down squareTop += 8; if (squareTop > getHeight() - 3 - SQUARE SIZE) squareTop = getHeight() - 3 - SQUARE SIZE; repaint(); } } // end keyPressed() Color changes—which happen when the user types the characters ’R’, ’G’, ’B’, and ’K’, or the lower case equivalents—are handled in the keyTyped method. I won’t include it here, since it is so similar to the keyPressed method. Finally, to complete the KeyListener interface, the keyReleased method must be defined. In the sample program, the body of this method is empty since the applet does nothing in response to keyReleased events. 6.5.3 Focus Events If a component is to change its appearance when it has the input focus, it needs some way to know when it has the focus. In Java, objects are notified about changes of input focus by events of type FocusEvent. An object that wants to be notified of changes in focus can implement the FocusListener interface. This interface declares two methods:
- 286. 270 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING public void focusGained(FocusEvent evt); public void focusLost(FocusEvent evt); Furthermore, the addFocusListener() method must be used to set up a listener for the focus events. When a component gets the input focus, it calls the focusGained() method of any object that has been registered with that component as a FocusListener. When it loses the focus, it calls the listener’s focusLost() method. Sometimes, it is the component itself that listens for focus events. In the sample KeyboardAndFocusDemo program, the response to a focus event is simply to redraw the panel. The paintComponent() method checks whether the panel has the input focus by calling the boolean-valued function hasFocus(), which is defined in the Component class, and it draws a different picture depending on whether or not the panel has the input focus. The net result is that the appearance of the panel changes when the panel gains or loses focus. The methods from the FocusListener interface are defined simply as: public void focusGained(FocusEvent evt) { // The panel now has the input focus. repaint(); // will redraw with a new message and a cyan border } public void focusLost(FocusEvent evt) { // The panel has now lost the input focus. repaint(); // will redraw with a new message and a gray border } The other aspect of handling focus is to make sure that the panel gets the focus when the user clicks on it. To do this, the panel implements the MouseListener interface and listens for mouse events on itself. It defines a mousePressed routine that asks that the input focus be given to the panel: public void mousePressed(MouseEvent evt) { requestFocus(); } The other four methods of the mouseListener interface are defined to be empty. Note that the panel implements three different listener interfaces, KeyListener, FocusListener, and MouseLis- tener, and the constructor in the panel class registers itself to listen for all three types of events with the statements: addKeyListener(this); addFocusListener(this); addMouseListener(this); There are, of course, other ways to organize this example. It would be possible, for example, to use a nested class to define the listening object. Or anonymous classes could be used to define separate listening objects for each type of event. In my next example, I will take the latter approach. 6.5.4 State Machines The information stored in an object’s instance variables is said to represent the state of that object. When one of the object’s methods is called, the action taken by the object can depend on its state. (Or, in the terminology we have been using, the definition of the method can look at the instance variables to decide what to do.) Furthermore, the state can change. (That
- 287. 6.5. TIMER AND KEYBOARD EVENTS 271 is, the definition of the method can assign new values to the instance variables.) In computer science, there is the idea of a state machine, which is just something that has a state and can change state in response to events or inputs. The response of a state machine to an event or input depends on what state it’s in. An object is a kind of state machine. Sometimes, this point of view can be very useful in designing classes. The state machine point of view can be especially useful in the type of event-oriented programming that is required by graphical user interfaces. When designing a GUI program, you can ask yourself: What information about state do I need to keep track of? What events can change the state of the program? How will my response to a given event depend on the current state? Should the appearance of the GUI be changed to reflect a change in state? How should the paintComponent() method take the state into account? All this is an alternative to the top-down, step-wise-refinement style of program design, which does not apply to the overall design of an event-oriented program. In the KeyboardAndFocusDemo program, shown above, the state of the program is recorded in the instance variables squareColor, squareLeft, and squareTop. These state variables are used in the paintComponent() method to decide how to draw the panel. They are changed in the two key-event-handling methods. In the rest of this section, we’ll look at another example, where the state plays an even bigger role. In this example, the user plays a simple arcade-style game by pressing the arrow keys. The main panel of the program is defined in the souce code file SubKillerPanel.java. An applet that uses this panel can be found in SubKillerApplet.java, while the stand-alone application version is SubKiller.java. You can try out the applet in the on-line version of this section. Here is what it looks like: You have to click on the panel to give it the input focus. The program shows a black “submarine” near the bottom of the panel. When the panel has the input focus, this submarine moves back and forth erratically near the bottom. Near the top, there is a blue “boat”. You can move this boat back and forth by pressing the left and right arrow keys. Attached to the boat is a red “bomb” (or “depth charge”). You can drop the bomb by hitting the down arrow key. The objective is to blow up the submarine by hitting it with the bomb. If the bomb falls off the bottom of the screen, you get a new one. If the submarine explodes, a new sub is created and you get a new bomb. Try it! Make sure to hit the sub at least once, so you can see the explosion. Let’s think about how this program can be programmed. First of all, since we are doing object-oriented programming, I decided to represent the boat, the depth charge, and the sub- marine as objects. Each of these objects is defined by a separate nested class inside the main panel class, and each object has its own state which is represented by the instance variables in
- 288. 272 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING the corresponding class. I use variables boat, bomb, and sub in the panel class to refer to the boat, bomb, and submarine objects. Now, what constitutes the “state” of the program? That is, what things change from time to time and affect the appearance or behavior of the program? Of course, the state includes the positions of the boat, submarine, and bomb, so I need variables to store the positions. Anything else, possibly less obvious? Well, sometimes the bomb is falling, and sometimes it’s not. That is a difference in state. Since there are two possibilities, I represent this aspect of the state with a boolean variable in the bomb object, bomb.isFalling. Sometimes the submarine is moving left and sometimes it is moving right. The difference is represented by another boolean variable, sub.isMovingLeft. Sometimes, the sub is exploding. This is also part of the state, and it is represented by a boolean variable, sub.isExploding. However, the explosions require a little more thought. An explosion is something that takes place over a series of frames. While an explosion is in progress, the sub looks different in each frame, as the size of the explosion increases. Also, I need to know when the explosion is over so that I can go back to moving and drawing the sub as usual. So, I use an integer variable, sub.explosionFrameNumber to record how many frames have been drawn since the explosion started; the value of this variable is used only when an explosion is in progress. How and when do the values of these state variables change? Some of them seem to change on their own: For example, as the sub moves left and right, the state variables the that specify its position are changing. Of course, these variables are changing because of an animation, and that animation is driven by a timer. Each time an event is generated by the timer, some of the state variables have to change to get ready for the next frame of the animation. The changes are made by the action listener that listens for events from the timer. The boat, bomb, and sub objects each contain an updateForNextFrame() method that updates the state variables of the object to get ready for the next frame of the animation. The action listener for the timer calls these methods with the statements boat.updateForNewFrame(); bomb.updateForNewFrame(); sub.updateForNewFrame(); The action listener also calls repaint(), so that the panel will be redrawn to reflect its new state. There are several state variables that change in these update methods, in addition to the position of the sub: If the bomb is falling, then its y-coordinate increases from one frame to the next. If the bomb hits the sub, then the isExploding variable of the sub changes to true, and the isFalling variable of the bomb becomes false. The isFalling variable also becomes false when the bomb falls off the bottom of the screen. If the sub is exploding, then its explosionFrameNumber increases from one frame to the next, and when it reaches a certain value, the explosion ends and isExploding is reset to false. At random times, the sub switches between moving to the left and moving to the right. Its direction of motion is recorded in the the sub’s isMovingLeft variable. The sub’s updateForNewFrame() method includes the lines if ( Math.random() < 0.04 ) isMovingLeft = ! isMovingLeft; There is a 1 in 25 chance that Math.random() will be less than 0.04, so the statement “isMovingLeft = ! isMovingLeft” is executed in one in every twenty-five frames, on the average. The effect of this statement is to reverse the value of isMovingLeft, from false to true or from true to false. That is, the direction of motion of the sub is reversed. In addtion to changes in state that take place from one frame to the next, a few state variables change when the user presses certain keys. In the program, this is checked in a
- 289. 6.6. BASIC COMPONENTS 273 method that responds to user keystrokes. If the user presses the left or right arrow key, the position of the boat is changed. If the user presses the down arrow key, the bomb changes from not-falling to falling. This is coded in the keyPressed()method of a KeyListener that is registered to listen for key events on the panel; that method reads as follows: public void keyPressed(KeyEvent evt) { int code = evt.getKeyCode(); // which key was pressed. if (code == KeyEvent.VK LEFT) { // Move the boat left. (If this moves the boat out of the frame, its // position will be adjusted in the boat.updateForNewFrame() method.) boat.centerX -= 15; } else if (code == KeyEvent.VK RIGHT) { // Move the boat right. (If this moves boat out of the frame, its // position will be adjusted in the boat.updateForNewFrame() method.) boat.centerX += 15; } else if (code == KeyEvent.VK DOWN) { // Start the bomb falling, it is is not already falling. if ( bomb.isFalling == false ) bomb.isFalling = true; } } Note that it’s not necessary to call repaint() when the state changes, since this panel shows an animation that is constantly being redrawn anyway. Any changes in the state will become visible to the user as soon as the next frame is drawn. At some point in the program, I have to make sure that the user does not move the boat off the screen. I could have done this in keyPressed(), but I choose to check for this in another routine, in the boat object. I encourage you to read the source code in SubKillerPanel.java. Although a few points are tricky, you should with some effort be able to read and understand the entire program. Try to understand the program in terms of state machines. Note how the state of each of the three objects in the program changes in response to events from the timer and from the user. You should also note that the program uses four listeners, to respond to action events from the timer, key events from the user, focus events, and mouse events. (The mouse is used only to request the input focus when the user clicks the panel.) The timer runs only when the panel has the input focus; this is programmed by having the focus listener start the timer when the panel gains the input focus and stop the timer when the panel loses the input focus. All four listeners are created in the constructor of the SubKillerPanel class using anonymous inner classes. (See Subsection 6.4.5.) While it’s not at all sophisticated as arcade games go, the SubKiller game does use some interesting programming. And it nicely illustrates how to apply state-machine thinking in event-oriented programming. 6.6 Basic Components In preceding sections, you’ve seen how to use a graphics context to draw on the screen and how to handle mouse events and keyboard events. In one sense, that’s all there is to GUI programming. If you’re willing to program all the drawing and handle all the mouse and keyboard events, you have nothing more to learn. However, you would either be doing a lot
- 290. 274 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING more work than you need to do, or you would be limiting yourself to very simple user interfaces. A typical user interface uses standard GUI components such as buttons, scroll bars, text-input boxes, and menus. These components have already been written for you, so you don’t have to duplicate the work involved in developing them. They know how to draw themselves, and they can handle the details of processing the mouse and keyboard events that concern them. Consider one of the simplest user interface components, a push button. The button has a border, and it displays some text. This text can be changed. Sometimes the button is disabled, so that clicking on it doesn’t have any effect. When it is disabled, its appearance changes. When the user clicks on the push button, the button changes appearance while the mouse button is pressed and changes back when the mouse button is released. In fact, it’s more complicated than that. If the user moves the mouse outside the push button before releasing the mouse button, the button changes to its regular appearance. To implement this, it is necessary to respond to mouse exit or mouse drag events. Furthermore, on many platforms, a button can receive the input focus. The button changes appearance when it has the focus. If the button has the focus and the user presses the space bar, the button is triggered. This means that the button must respond to keyboard and focus events as well. Fortunately, you don’t have to program any of this, provided you use an object belonging to the standard class javax.swing.JButton. A JButton object draws itself and processes mouse, keyboard, and focus events on its own. You only hear from the Button when the user triggers it by clicking on it or pressing the space bar while the button has the input focus. When this happens, the JButton object creates an event object belonging to the class java.awt.event.ActionEvent. The event object is sent to any registered listeners to tell them that the button has been pushed. Your program gets only the information it needs—the fact that a button was pushed. ∗ ∗ ∗ The standard components that are defined as part of the Swing graphical user interface API are defined by subclasses of the class JComponent, which is itself a subclass of Component. (Note that this includes the JPanel class that we have already been working with extensively.) Many useful methods are defined in the Component and JComponent classes and so can be used with any Swing component. We begin by looking at a few of these methods. Suppose that comp is a variable that refers to some JComponent. Then the following methods can be used: • comp.getWidth() and comp.getHeight() are functions that give the current size of the component, in pixels. One warning: When a component is first created, its size is zero. The size will be set later, probably by a layout manager. A common mistake is to check the size of a component before that size has been set, such as in a constructor. • comp.setEnabled(true) and comp.setEnabled(false) can be used to enable and disable the component. When a component is disabled, its appearance might change, and the user cannot do anything with it. There is a boolean-valued function, comp.isEnabled() that you can call to discover whether the component is enabled. • comp.setVisible(true) and comp.setVisible(false) can be called to hide or show the component. • comp.setFont(font) sets the font that is used for text displayed on the component. See Subsection 6.3.3 for a discussion of fonts. • comp.setBackground(color) and comp.setForeground(color) set the background and foreground colors for the component. See Subsection 6.3.2.
- 291. 6.6. BASIC COMPONENTS 275 • comp.setOpaque(true) tells the component that the area occupied by the component should be filled with the component’s background color before the content of the com- ponent is painted. By default, only JLabels are non-opaque. A non-opaque, or “trans- parent”, component ignores its background color and simply paints its content over the content of its container. This usually means that it inherits the background color from its container. • comp.setToolTipText(string) sets the specified string as a “tool tip” for the component. The tool tip is displayed if the mouse cursor is in the component and the mouse is not moved for a few seconds. The tool tip should give some information about the meaning of the component or how to use it. • comp.setPreferredSize(size) sets the size at which the component should be displayed, if possible. The parameter is of type java.awt.Dimension, where an object of type Di- mension has two public integer-valued instance variables, width and height. A call to this method usually looks something like “setPreferredSize( new Dimension(100,50) )”. The preferred size is used as a hint by layout managers, but will not be respected in all cases. Standard components generally compute a correct preferred size automatically, but it can be useful to set it in some cases. For example, if you use a JPanel as a drawing surface, it might be a good idea to set a preferred size for it. Note that using any component is a multi-step process. The component object must be created with a constructor. It must be added to a container. In many cases, a listener must be registered to respond to events from the component. And in some cases, a reference to the component must be saved in an instance variable so that the component can be manipulated by the program after it has been created. In this section, we will look at a few of the basic standard components that are available in Swing. In the next section we will consider the problem of laying out components in containers. 6.6.1 JButton An object of class JButton is a push button that the user can click to trigger some action. You’ve already seen buttons used in Section 6.1 and Section 6.2, but we consider them in much more detail here. To use any component effectively, there are several aspects of the corresponding class that you should be familiar with. For JButton, as an example, I list these aspects explicitely: • Constructors: The JButton class has a constructor that takes a string as a parameter. This string becomes the text displayed on the button. For example: stopGoButton = new JButton("Go"). This creates a button object that will display the text, “Go” (but remember that the button must still be added to a container before it can appear on the screen). • Events: When the user clicks on a button, the button generates an event of type Action- Event. This event is sent to any listener that has been registered with the button as an ActionListener. • Listeners: An object that wants to handle events generated by buttons must imple- ment the ActionListener interface. This interface defines just one method, “public void actionPerformed(ActionEvent evt)”, which is called to notify the object of an action event.
- 292. 276 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING • Registration of Listeners: In order to actually receive notification of an event from a button, an ActionListener must be registered with the button. This is done with the but- ton’s addActionListener() method. For example: stopGoButton.addActionListener( buttonHandler ); • Event methods: When actionPerformed(evt) is called by the button, the parameter, evt, contains information about the event. This information can be retrieved by calling methods in the ActionEvent class. In particular, evt.getActionCommand() returns a String giving the command associated with the button. By default, this command is the text that is displayed on the button, but it is possible to set it to some other string. The method evt.getSource() returns a reference to the Object that produced the event, that is, to the JButton that was pressed. The return value is of type Object, not JButton, because other types of components can also produce ActionEvents. • Component methods: Several useful methods are defined in the JButton class. For example, stopGoButton.setText("Stop") changes the text displayed on the button to “Stop”. And stopGoButton.setActionCommand("sgb") changes the action command associated to this button for action events. Of course, JButtons also have all the general Component methods, such as setEnabled() and setFont(). The setEnabled() and setText() methods of a button are particularly useful for giving the user information about what is going on in the program. A disabled button is better than a button that gives an obnoxious error message such as “Sorry, you can’t click on me now!” 6.6.2 JLabel JLabel is certainly the simplest type of component. An object of type JLabel exists just to display a line of text. The text cannot be edited by the user, although it can be changed by your program. The constructor for a JLabel specifies the text to be displayed: JLabel message = new JLabel("Hello World!"); There is another constructor that specifies where in the label the text is located, if there is extra space. The possible alignments are given by the constants JLabel.LEFT, JLabel.CENTER, and JLabel.RIGHT. For example, JLabel message = new JLabel("Hello World!", JLabel.CENTER); creates a label whose text is centered in the available space. You can change the text displayed in a label by calling the label’s setText() method: message.setText("Goodby World!"); Since the JLabel class is a subclass of JComponent, you can use methods such as setForeground() with labels. If you want the background color to have any effect, you should call setOpaque(true) on the label, since otherwise the JLabel might not fill in its background. For example: JLabel message = new JLabel("Hello World!", JLabel.CENTER); message.setForeground(Color.RED); // Display red text... message.setBackground(Color.BLACK); // on a black background... message.setFont(new Font("Serif",Font.BOLD,18)); // in a big bold font. message.setOpaque(true); // Make sure background is filled in.
- 293. 6.6. BASIC COMPONENTS 277 6.6.3 JCheckBox A JCheckBox is a component that has two states: selected or unselected. The user can change the state of a check box by clicking on it. The state of a checkbox is represented by a boolean value that is true if the box is selected and false if the box is unselected. A checkbox has a label, which is specified when the box is constructed: JCheckBox showTime = new JCheckBox("Show Current Time"); Usually, it’s the user who sets the state of a JCheckBox, but you can also set the state in your program. The current state of a checkbox is set using its setSelected(boolean) method. For example, if you want the checkbox showTime to be checked, you would say “showTime.setSelected(true)". To uncheck the box, say “showTime.setSelected(false)". You can determine the current state of a checkbox by calling its isSelected() method, which returns a boolean value. In many cases, you don’t need to worry about events from checkboxes. Your program can just check the state whenever it needs to know it by calling the isSelected() method. However, a checkbox does generate an event when its state is changed by the user, and you can detect this event and respond to it if you want something to happen at the moment the state changes. When the state of a checkbox is changed by the user, it generates an event of type ActionEvent. If you want something to happen when the user changes the state, you must register an ActionListener with the checkbox by calling its addActionListener() method. (Note that if you change the state by calling the setSelected() method, no ActionEvent is generated. However, there is another method in the JCheckBox class, doClick(), which simulates a user click on the checkbox and does generate an ActionEvent.) When handling an ActionEvent, you can call evt.getSource() in the actionPerformed() method to find out which object generated the event. (Of course, if you are only listening for events from one component, you don’t even have to do this.) The returned value is of type Object, but you can type-cast it to another type if you want. Once you know the object that generated the event, you can ask the object to tell you its current state. For example, if you know that the event had to come from one of two checkboxes, cb1 or cb2, then your actionPerformed() method might look like this: public void actionPerformed(ActionEvent evt) { Object source = evt.getSource(); if (source == cb1) { boolean newState = cb1.isSelected(); ... // respond to the change of state } else if (source == cb2) { boolean newState = cb2.isSelected(); ... // respond to the change of state } } Alternatively, you can use evt.getActionCommand() to retrieve the action command asso- ciated with the source. For a JCheckBox, the action command is, by default, the label of the checkbox.
- 294. 278 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING 6.6.4 JTextField and JTextArea The JTextField and JTextArea classes represent components that contain text that can be edited by the user. A JTextField holds a single line of text, while a JTextArea can hold multiple lines. It is also possible to set a JTextField or JTextArea to be read-only so that the user can read the text that it contains but cannot edit the text. Both classes are subclasses of an abstract class, JTextComponent, which defines their common properties. JTextField and JTextArea have many methods in common. The instance method setText(), which takes a parameter of type String, can be used to change the text that is displayed in an input component. The contents of the component can be retrieved by calling its getText() instance method, which returns a value of type String. If you want to stop the user from modifying the text, you can call setEditable(false). Call the same method with a parameter of true to make the input component user-editable again. The user can only type into a text component when it has the input focus. The user can give the input focus to a text component by clicking it with the mouse, but sometimes it is useful to give the input focus to a text field programmatically. You can do this by calling its requestFocus() method. For example, when I discover an error in the user’s input, I usually call requestFocus() on the text field that contains the error. This helps the user see where the error occurred and lets the user start typing the correction immediately. By default, there is no space between the text in a text component and the edge of the component, which usually doesn’t look very good. You can use the setMargin() method of the component to add some blank space between the edge of the component and the text. This method takes a parameter of type java.awt.Insets which contains four integer instance variables that specify the margins on the top, left, bottom, and right edge of the component. For example, textComponent.setMargin( new Insets(5,5,5,5) ); adds a five-pixel margin between the text in textComponent and each edge of the component. ∗ ∗ ∗ The JTextField class has a constructor public JTextField(int columns) where columns is an integer that specifies the number of characters that should be visible in the text field. This is used to determine the preferred width of the text field. (Because characters can be of different sizes and because the preferred width is not always respected, the actual number of characters visible in the text field might not be equal to columns.) You don’t have to specify the number of columns; for example, you might use the text field in a context where it will expand to fill whatever space is available. In that case, you can use the constructor JTextField(), with no parameters. You can also use the following constructors, which specify the initial contents of the text field: public JTextField(String contents); public JTextField(String contents, int columns); The constructors for a JTextArea are public JTextArea() public JTextArea(int rows, int columns) public JTextArea(String contents) public JTextArea(String contents, int rows, int columns)
- 295. 6.6. BASIC COMPONENTS 279 The parameter rows specifies how many lines of text should be visible in the text area. This determines the preferred height of the text area, just as columns determines the preferred width. However, the text area can actually contain any number of lines; the text area can be scrolled to reveal lines that are not currently visible. It is common to use a JTextArea as the CENTER component of a BorderLayout. In that case, it is less useful to specify the number of lines and columns, since the TextArea will expand to fill all the space available in the center area of the container. The JTextArea class adds a few useful methods to those inherited from JTextComponent. For example, the instance method append(moreText), where moreText is of type String, adds the specified text at the end of the current content of the text area. (When using append() or setText() to add text to a JTextArea, line breaks can be inserted in the text by using the newline character, ’n’.) And setLineWrap(wrap), where wrap is of type boolean, tells what should happen when a line of text is too long to be displayed in the text area. If wrap is true, then any line that is too long will be “wrapped” onto the next line; if wrap is false, the line will simply extend outside the text area, and the user will have to scroll the text area horizontally to see the entire line. The default value of wrap is false. Since it might be necessary to scroll a text area to see all the text that it contains, you might expect a text area to come with scroll bars. Unfortunately, this does not happen automatically. To get scroll bars for a text area, you have to put the JTextArea inside another component, called a JScrollPane. This can be done as follows: JTextArea inputArea = new JTextArea(); JScrollPane scroller = new JScrollPane( inputArea ); The scroll pane provides scroll bars that can be used to scroll the text in the text area. The scroll bars will appear only when needed, that is when the size of the text exceeds the size of the text area. Note that when you want to put the text area into a container, you should add the scroll pane, not the text area itself, to the container. ∗ ∗ ∗ When the user is typing in a JTextField and presses return, an ActionEvent is generated. If you want to respond to such events, you can register an ActionListener with the text field, using the text field’s addActionListener() method. (Since a JTextArea can contain multiple lines of text, pressing return in a text area does not generate an event; is simply begins a new line of text.) JTextField has a subclass, JPasswordField, which is identical except that it does not reveal the text that it contains. The characters in a JPasswordField are all displayed as asterisks (or some other fixed character). A password field is, obviously, designed to let the user enter a password without showing that password on the screen. Text components are actually quite complex, and I have covered only their most basic properties here. I will return to the topic of text components in Subsection 12.4.4. 6.6.5 JComboBox The JComboBox class provides a way to let the user select one option from a list of options. The options are presented as a kind of pop-up menu, and only the currently selected option is visible on the screen. When a JComboBox object is first constructed, it initially contains no items. An item is added to the bottom of the menu by calling the combo box’s instance method, addItem(str), where str is the string that will be displayed in the menu.
- 296. 280 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING For example, the following code will create an object of type JComboBox that contains the options Red, Blue, Green, and Black: JComboBox colorChoice = new JComboBox(); colorChoice.addItem("Red"); colorChoice.addItem("Blue"); colorChoice.addItem("Green"); colorChoice.addItem("Black"); You can call the getSelectedIndex() method of a JComboBox to find out which item is currently selected. This method returns an integer that gives the position of the selected item in the list, where the items are numbered starting from zero. Alternatively, you can call getSelectedItem() to get the selected item itself. (This method returns a value of type Object, since a JComboBox can actually hold other types of objects besides strings.) You can change the selection by calling the method setSelectedIndex(n), where n is an integer giving the position of the item that you want to select. The most common way to use a JComboBox is to call its getSelectedIndex() method when you have a need to know which item is currently selected. However, like other components that we have seen, JComboBox components generate ActionEvents when the user selects an item. You can register an ActionListener with the JComboBox if you want to respond to such events as they occur. JComboBoxes have a nifty feature, which is probably not all that useful in practice. You can make a JComboBox “editable” by calling its method setEditable(true). If you do this, the user can edit the selection by clicking on the JComboBox and typing. This allows the user to make a selection that is not in the pre-configured list that you provide. (The “Combo” in the name “JComboBox” refers to the fact that it’s a kind of combination of menu and text-input box.) If the user has edited the selection in this way, then the getSelectedIndex() method will return the value -1, and getSelectedItem() will return the string that the user typed. An ActionEvent is triggered if the user presses return while typing in the JComboBox. 6.6.6 JSlider A JSlider provides a way for the user to select an integer value from a range of possible values. The user does this by dragging a “knob” along a bar. A slider can, optionally, be decorated with tick marks and with labels. This picture shows three sliders with different decorations and with different ranges of values: Here, the second slider is decorated with ticks, and the third one is decorated with labels. It’s possible for a single slider to have both types of decorations. The most commonly used constructor for JSliders specifies the start and end of the range of values for the slider and its initial value when it first appears on the screen: public JSlider(int minimum, int maximum, int value)
- 297. 6.6. BASIC COMPONENTS 281 If the parameters are omitted, the values 0, 100, and 50 are used. By default, a slider is horizon- tal, but you can make it vertical by calling its method setOrientation(JSlider.VERTICAL). The current value of a JSlider can be read at any time with its getValue() method, which returns a value of type int. If you want to change the value, you can do so with the method setValue(n), which takes a parameter of type int. If you want to respond immediately when the user changes the value of a slider, you can register a listener with the slider. JSliders, unlike other components we have seen, do not generate ActionEvents. Instead, they generate events of type ChangeEvent. ChangeEvent and related classes are defined in the package javax.swing.event rather than java.awt.event, so if you want to use ChangeEvents, you should import javax.swing.event.* at the beginning of your program. You must also define some object to implement the ChangeListener interface, and you must register the change listener with the slider by calling its addChangeListener() method. A ChangeListener must provide a definition for the method: public void stateChanged(ChangeEvent evt) This method will be called whenever the value of the slider changes. (Note that it will also be called when you change the value with the setValue() method, as well as when the user changes the value.) In the stateChanged() method, you can call evt.getSource() to find out which object generated the event. Using tick marks on a slider is a two-step process: Specify the interval between the tick marks, and tell the slider that the tick marks should be displayed. There are actually two types of tick marks, “major” tick marks and “minor” tick marks. You can have one or the other or both. Major tick marks are a bit longer than minor tick marks. The method setMinorTickSpacing(i) indicates that there should be a minor tick mark every i units along the slider. The parameter is an integer. (The spacing is in terms of values on the slider, not pixels.) For the major tick marks, there is a similar command, setMajorTickSpacing(i). Calling these methods is not enough to make the tick marks appear. You also have to call setPaintTicks(true). For example, the second slider in the above picture was created and configured using the commands: slider2 = new JSlider(); // (Uses default min, max, and value.) slider2.addChangeListener(this); slider2.setMajorTickSpacing(25); slider2.setMinorTickSpacing(5); slider2.setPaintTicks(true); Labels on a slider are handled similarly. You have to specify the labels and tell the slider to paint them. Specifying labels is a tricky business, but the JSlider class has a method to simplify it. You can create a set of labels and add them to a slider named sldr with the command: sldr.setLabelTable( sldr.createStandardLabels(i) ); where i is an integer giving the spacing between the labels. To arrange for the labels to be displayed, call setPaintLabels(true). For example, the third slider in the above picture was created and configured with the commands: slider3 = new JSlider(2000,2100,2006); slider3.addChangeListener(this); slider3.setLabelTable( slider3.createStandardLabels(50) ); slider3.setPaintLabels(true);
- 298. 282 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING 6.7 Basic Layout Components are the fundamental building blocks of a graphical user interface. But you have to do more with components besides create them. Another aspect of GUI programming is laying out components on the screen, that is, deciding where they are drawn and how big they are. You have probably noticed that computing coordinates can be a difficult problem, especially if you don’t assume a fixed size for the drawing area. Java has a solution for this, as well. Components are the visible objects that make up a GUI. Some components are containers, which can hold other components. Containers in Java are objects that belong to some subclass of java.awt.Container. The content pane of a JApplet or JFrame is an example of a container. The standard class JPanel, which we have mostly used as a drawing surface up till now, is another example of a container. Because a JPanel object is a container, it can hold other components. Because a JPanel is itself a component, you can add a JPanel to another JPanel. This makes complex nesting of components possible. JPanels can be used to organize complicated user interfaces, as shown in this illustration: The components in a container must be “laid out,” which means setting their sizes and positions. It’s possible to program the layout yourself, but ordinarily layout is done by a layout manager. A layout manager is an object associated with a container that implements some policy for laying out the components in that container. Different types of layout manager implement different policies. In this section, we will cover the three most common types of layout manager, and then we will look at several programming examples that use components and layout. Every container has an instance method, setLayout(), that takes a parameter of type LayoutManager and that is used to specify the layout manager that will be responsible for laying out any components that are added to the container. Components are added to a container by calling an instance method named add() in the container object. There are actually several versions of the add() method, with different parameter lists. Different versions of add() are appropriate for different layout managers, as we will see below.
- 299. 6.7. BASIC LAYOUT 283 6.7.1 Basic Layout Managers Java has a variety of standard layout managers that can be used as parameters in the setLayout() method. They are defined by classes in the package java.awt. Here, we will look at just three of these layout manager classes: FlowLayout, BorderLayout, and GridLayout. A FlowLayout simply lines up components in a row across the container. The size of each component is equal to that component’s “preferred size.” After laying out as many items as will fit in a row across the container, the layout manager will move on to the next row. The default layout for a JPanel is a FlowLayout; that is, a JPanel uses a FlowLayout unless you specify a different layout manager by calling the panel’s setLayout() method. The components in a given row can be either left-aligned, right-aligned, or centered within that row, and there can be horizontal and vertical gaps between components. If the default constructor, “new FlowLayout()”, is used, then the components on each row will be centered and both the horizontal and the vertical gaps will be five pixels. The constructor public FlowLayout(int align, int hgap, int vgap) can be used to specify alternative alignment and gaps. The possible values of align are FlowLayout.LEFT, FlowLayout.RIGHT, and FlowLayout.CENTER. Suppose that cntr is a container object that is using a FlowLayout as its layout manager. Then, a component, comp, can be added to the container with the statement cntr.add(comp); The FlowLayout will line up all the components that have been added to the container in this way. They will be lined up in the order in which they were added. For example, this picture shows five buttons in a panel that uses a FlowLayout: Note that since the five buttons will not fit in a single row across the panel, they are arranged in two rows. In each row, the buttons are grouped together and are centered in the row. The buttons were added to the panel using the statements: panel.add(button1); panel.add(button2); panel.add(button3); panel.add(button4); panel.add(button5); When a container uses a layout manager, the layout manager is ordinarily responsible for computing the preferred size of the container (although a different preferred size could be set by calling the container’s setPreferredSize method). A FlowLayout prefers to put its components in a single row, so the preferred width is the total of the preferred widths of all the components, plus the horizontal gaps between the components. The preferred height is the maximum preferred height of all the components. ∗ ∗ ∗
- 300. 284 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING A BorderLayout layout manager is designed to display one large, central component, with up to four smaller components arranged along the edges of the central component. If a container, cntr, is using a BorderLayout, then a component, comp, should be added to the container using a statement of the form cntr.add( comp, borderLayoutPosition ); where borderLayoutPosition specifies what position the component should occupy in the layout and is given as one of the constants BorderLayout.CENTER, BorderLayout.NORTH, BorderLayout.SOUTH, BorderLayout.EAST, or BorderLayout.WEST. The meaning of the five positions is shown in this diagram: Note that a border layout can contain fewer than five compompontnts, so that not all five of the possible positions need to be filled. A BorderLayout selects the sizes of its components as follows: The NORTH and SOUTH com- ponents (if present) are shown at their preferred heights, but their width is set equal to the full width of the container. The EAST and WEST components are shown at their preferred widths, but their height is set to the height of the container, minus the space occupied by the NORTH and SOUTH components. Finally, the CENTER component takes up any remaining space; the preferred size of the CENTER component is completely ignored. You should make sure that the components that you put into a BorderLayout are suitable for the positions that they will occupy. A horizontal slider or text field, for example, would work well in the NORTH or SOUTH position, but wouldn’t make much sense in the EAST or WEST position. The default constructor, new BorderLayout(), leaves no space between components. If you would like to leave some space, you can specify horizontal and vertical gaps in the constructor of the BorderLayout object. For example, if you say panel.setLayout(new BorderLayout(5,7)); then the layout manager will insert horizontal gaps of 5 pixels between components and vertical gaps of 7 pixels between components. The background color of the container will show through in these gaps. The default layout for the original content pane that comes with a JFrame or JApplet is a BorderLayout with no horizontal or vertical gap. ∗ ∗ ∗ Finally, we consider the GridLayout layout manager. A grid layout lays out components in a grid of equal sized rectangles. This illustration shows how the components would be arranged in a grid layout with 3 rows and 2 columns:
- 301. 6.7. BASIC LAYOUT 285 If a container uses a GridLayout, the appropriate add method for the container takes a single parameter of type Component (for example: cntr.add(comp)). Components are added to the grid in the order shown; that is, each row is filled from left to right before going on the next row. The constructor for a GridLayout takes the form “new GridLayout(R,C)”, where R is the number of rows and C is the number of columns. If you want to leave horizontal gaps of H pixels between columns and vertical gaps of V pixels between rows, use “new GridLayout(R,C,H,V)” instead. When you use a GridLayout, it’s probably good form to add just enough components to fill the grid. However, this is not required. In fact, as long as you specify a non-zero value for the number of rows, then the number of columns is essentially ignored. The system will use just as many columns as are necessary to hold all the components that you add to the container. If you want to depend on this behavior, you should probably specify zero as the number of columns. You can also specify the number of rows as zero. In that case, you must give a non-zero number of columns. The system will use the specified number of columns, with just as many rows as necessary to hold the components that are added to the container. Horizontal grids, with a single row, and vertical grids, with a single column, are very com- mon. For example, suppose that button1, button2, and button3 are buttons and that you’d like to display them in a horizontal row in a panel. If you use a horizontal grid for the panel, then the buttons will completely fill that panel and will all be the same size. The panel can be created as follows: JPanel buttonBar = new JPanel(); buttonBar.setLayout( new GridLayout(1,3) ); // (Note: The "3" here is pretty much ignored, and // you could also say "new GridLayout(1,0)". // To leave gaps between the buttons, you could use // "new GridLayout(1,0,5,5)".) buttonBar.add(button1); buttonBar.add(button2); buttonBar.add(button3); You might find this button bar to be more attractive than the one that uses the default FlowLay- out layout manager. 6.7.2 Borders We have seen how to leave gaps between the components in a container, but what if you would like to leave a border around the outside of the container? This problem is not handled by layout managers. Instead, borders in Swing are represented by objects. A Border object can be added to any JComponent, not just to containers. Borders can be more than just empty space. The class javax.swing.BorderFactory contains a large number of static methods for creating border objects. For example, the function
- 302. 286 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING BorderFactory.createLineBorder(Color.BLACK) returns an object that represents a one-pixel wide black line around the outside of a component. If comp is a JComponent, a border can be added to comp using its setBorder() method. For example: comp.setBorder( BorderFactory.createLineBorder(Color.BLACK) ); When a border has been set for a JComponent, the border is drawn automatically, without any further effort on the part of the programmer. The border is drawn along the edges of the component, just inside its boundary. The layout manager of a JPanel or other container will take the space occupied by the border into account. The components that are added to the container will be displayed in the area inside the border. I don’t recommend using a border on a JPanel that is being used as a drawing surface. However, if you do this, you should take the border into account. If you draw in the area occupied by the border, that part of your drawing will be covered by the border. Here are some of the static methods that can be used to create borders: • BorderFactory.createEmptyBorder(top,left,bottom,right) — leaves an empty bor- der around the edges of a component. Nothing is drawn in this space, so the background color of the component will appear in the area occupied by the border. The parameters are integers that give the width of the border along the top, left, bottom, and right edges of the component. This is actually very useful when used on a JPanel that contains other components. It puts some space between the components and the edge of the panel. It can also be useful on a JLabel, which otherwise would not have any space between the text and the edge of the label. • BorderFactory.createLineBorder(color,thickness) — draws a line around all four edges of a component. The first parameter is of type Color and specifies the color of the line. The second parameter is an integer that specifies the thickness of the border. If the second parameter is omitted, a line of thickness 1 is drawn. • BorderFactory.createMatteBorder(top,left,bottom,right,color) — is similar to createLineBorder, except that you can specify individual thicknesses for the top, left, bottom, and right edges of the component. • BorderFactory.createEtchedBorder() — creates a border that looks like a groove etched around the boundary of the component. The effect is achieved using lighter and darker shades of the component’s background color, and it does not work well with every background color. • BorderFactory.createLoweredBevelBorder()—gives a component a three-dimensional effect that makes it look like it is lowered into the computer screen. As with an Etched- Border, this only works well for certain background colors. • BorderFactory.createRaisedBevelBorder()—similar to a LoweredBevelBorder, but the component looks like it is raised above the computer screen. • BorderFactory.createTitledBorder(title)—creates a border with a title. The title is a String, which is displayed in the upper left corner of the border. There are many other methods in the BorderFactory class, most of them providing vari- ations of the basic border styles given here. The following illustration shows six components with six different border styles. The text in each component is the command that created the border for that component:
- 303. 6.7. BASIC LAYOUT 287 (The source code for the applet that produced this picture can be found in BorderDemo.java.) 6.7.3 SliderAndComboBoxDemo Now that we have looked at components and layouts, it’s time to put them together into some complete programs. We start with a simple demo that uses a JLabel, a JComboBox, and a couple of JSliders, all laid out in a GridLayout, as shown in this picture: The sliders in this applet control the foreground and background color of the label, and the combo box controls its font style. Writing this program is a matter of creating the components, laying them out, and programming listeners to respond to events from the sliders and combo box. In my program, I define a subclass of JPanel which will be used for the applet’s content pane. This class implements ChangeListener and ActionListener, so the panel itself can act as the listener for change events from the sliders and action events from the combo box. In the constructor, the four components are created and configured, a GridLayout is installed as the layout manager for the panel, and the components are added to the panel: /* Create the sliders, and set up this panel to listen for ChangeEvents that are generated by the sliders. */ bgColorSlider = new JSlider(0,255,100); bgColorSlider.addChangeListener(this); fgColorSlider = new JSlider(0,255,200); fgColorSlider.addChangeListener(this);
- 304. 288 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING /* Create the combo box, and add four items to it, listing different font styles. Set up the panel to listen for ActionEvents from the combo box. */ fontStyleSelect = new JComboBox(); fontStyleSelect.addItem("Plain Font"); fontStyleSelect.addItem("Italic Font"); fontStyleSelect.addItem("Bold Font"); fontStyleSelect.addItem("Bold Italic Font"); fontStyleSelect.setSelectedIndex(2); fontStyleSelect.addActionListener(this); /* Create the display label, with properties to match the values of the sliders and the setting of the combo box. */ displayLabel = new JLabel("Hello World!", JLabel.CENTER); displayLabel.setOpaque(true); displayLabel.setBackground( new Color(100,100,100) ); displayLabel.setForeground( new Color(255, 200, 200) ); displayLabel.setFont( new Font("Serif", Font.BOLD, 30) ); /* Set the layout for the panel, and add the four components. Use a GridLayout with 4 rows and 1 column. */ setLayout(new GridLayout(4,1)); add(displayLabel); add(bgColorSlider); add(fgColorSlider); add(fontStyleSelect); The class also defines the methods required by the ActionListener and ChangeListener inter- faces. The actionPerformed() method is called when the user selects an item in the combo box. This method changes the font in the JLable, where the font depends on which item is currently selected in the combo box, fontStyleSelect: public void actionPerformed(ActionEvent evt) { switch ( fontStyleSelect.getSelectedIndex() ) { case 0: displayLabel.setFont( new Font("Serif", Font.PLAIN, 30) ); break; case 1: displayLabel.setFont( new Font("Serif", Font.ITALIC, 30) ); break; case 2: displayLabel.setFont( new Font("Serif", Font.BOLD, 30) ); break; case 3: displayLabel.setFont( new Font("Serif", Font.BOLD + Font.ITALIC, 30) ); break; } } And the stateChanged() method, which is called when the user manipulates one of the sliders, uses the value on the slider to compute a new foreground or background color for the label. The method checks evt.getSource() to determine which slider was changed:
- 305. 6.7. BASIC LAYOUT 289 public void stateChanged(ChangeEvent evt) { if (evt.getSource() == bgColorSlider) { int bgVal = bgColorSlider.getValue(); displayLabel.setBackground( new Color(bgVal,bgVal,bgVal) ); // NOTE: The background color is a shade of gray, // determined by the setting on the slider. } else { int fgVal = fgColorSlider.getValue(); displayLabel.setForeground( new Color( 255, fgVal, fgVal) ); // Note: The foreground color ranges from pure red to pure // white as the slider value increases from 0 to 255. } } (The complete source code is in the file SliderAndComboBoxDemo.java.) 6.7.4 A Simple Calculator As our next example, we look briefly at an example that uses nested subpanels to build a more complex user interface. The program has two JTextFields where the user can enter two numbers, four JButtons that the user can click to add, subtract, multiply, or divide the two numbers, and a JLabel that displays the result of the operation: Like the previous example, this example uses a main panel with a GridLayout that has four rows and one column. In this case, the layout is created with the statement: setLayout(new GridLayout(4,1,3,3)); which allows a 3-pixel gap between the rows where the gray background color of the panel is visible. The gray border around the edges of the panel is added with the statement setBorder( BorderFactory.createEmptyBorder(5,5,5,5) ); The first row of the grid layout actually contains two components, a JLabel displaying the text “x =” and a JTextField. A grid layout can only only have one component in each position. In this case, that component is a JPanel, a subpanel that is nested inside the main panel. This subpanel in turn contains the label and text field. This can be programmed as follows: xInput = new JTextField("0", 10); // Create a text field sized to hold 10 chars. JPanel xPanel = new JPanel(); // Create the subpanel. xPanel.add( new JLabel(" x = ")); // Add a label to the subpanel. xPanel.add(xInput); // Add the text field to the subpanel mainPanel.add(xPanel); // Add the subpanel to the main panel.
- 306. 290 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING The subpanel uses the default FlowLayout layout manager, so the label and text field are simply placed next to each other in the subpanel at their preferred size, and are centered in the subpanel. Similarly, the third row of the grid layout is a subpanel that contains four buttons. In this case, the subpanel uses a GridLayout with one row and four columns, so that the buttons are all the same size and completely fill the subpanel. One other point of interest in this example is the actionPerformed() method that responds when the user clicks one of the buttons. This method must retrieve the user’s numbers from the text field, perform the appropriate arithmetic operation on them (depending on which button was clicked), and set the text of the label to represent the result. However, the contents of the text fields can only be retrieved as strings, and these strings must be converted into numbers. If the conversion fails, the label is set to display an error message: public void actionPerformed(ActionEvent evt) { double x, y; // The numbers from the input boxes. try { String xStr = xInput.getText(); x = Double.parseDouble(xStr); } catch (NumberFormatException e) { // The string xStr is not a legal number. answer.setText("Illegal data for x."); xInput.requestFocus(); return; } try { String yStr = yInput.getText(); y = Double.parseDouble(yStr); } catch (NumberFormatException e) { // The string yStr is not a legal number. answer.setText("Illegal data for y."); yInput.requestFocus(); return; } /* Perfrom the operation based on the action command from the button. The action command is the text displayed on the button. Note that division by zero produces an error message. */ String op = evt.getActionCommand(); if (op.equals("+")) answer.setText( "x + y = " + (x+y) ); else if (op.equals("-")) answer.setText( "x - y = " + (x-y) ); else if (op.equals("*")) answer.setText( "x * y = " + (x*y) ); else if (op.equals("/")) { if (y == 0) answer.setText("Can’t divide by zero!"); else answer.setText( "x / y = " + (x/y) );
- 307. 6.7. BASIC LAYOUT 291 } } // end actionPerformed() (The complete source code for this example can be found in SimpleCalc.java.) 6.7.5 Using a null Layout As mentioned above, it is possible to do without a layout manager altogether. For out next example, we’ll look at a panel that does not use a layout manager. If you set the layout manager of a container to be null, by calling container.setLayout(null), then you assume complete responsibility for positioning and sizing the components in that container. If comp is any component, then the statement comp.setBounds(x, y, width, height); puts the top left corner of the component at the point (x,y), measured in the coordinate system of the container that contains the component, and it sets the width and height of the component to the specified values. You should only set the bounds of a component if the container that contains it has a null layout manager. In a container that has a non-null layout manager, the layout manager is responsible for setting the bounds, and you should not interfere with its job. Assuming that you have set the layout manager to null, you can call the setBounds() method any time you like. (You can even make a component that moves or changes size while the user is watching.) If you are writing a panel that has a known, fixed size, then you can set the bounds of each component in the panel’s constructor. Note that you must also add the components to the panel, using the panel’s add(component) instance method; otherwise, the component will not appear on the screen. Our example contains four components: two buttons, a label, and a panel that displays a checkerboard pattern: This is just an example of using a null layout; it doesn’t do anything, except that clicking the buttons changes the text of the label. (We will use this example in Section 7.5 as a starting point for a checkers game.) For its content pane, this example uses a main panel that is defined by a class named NullLayoutPanel. The four components are created and added to the panel in the constructor of the NullLayoutPanel class. Then the setBounds() method of each component is called to set the size and position of the component:
- 308. 292 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING public NullLayoutPanel() { setLayout(null); // I will do the layout myself! setBackground(new Color(0,150,0)); // A dark green background. setBorder( BorderFactory.createEtchedBorder() ); setPreferredSize( new Dimension(350,240) ); // I assume that the size of the panel is, in fact, 350-by-240. /* Create the components and add them to the content pane. If you don’t add them to the a container, they won’t appear, even if you set their bounds! */ board = new Checkerboard(); // (Checkerborad is a subclass of JPanel, defined elsewhere.) add(board); newGameButton = new JButton("New Game"); newGameButton.addActionListener(this); add(newGameButton); resignButton = new JButton("Resign"); resignButton.addActionListener(this); add(resignButton); message = new JLabel("Click "New Game" to begin a game."); message.setForeground( new Color(100,255,100) ); // Light green. message.setFont(new Font("Serif", Font.BOLD, 14)); add(message); /* Set the position and size of each component by calling its setBounds() method. */ board.setBounds(20,20,164,164); newGameButton.setBounds(210, 60, 120, 30); resignButton.setBounds(210, 120, 120, 30); message.setBounds(20, 200, 330, 30); } // end constructor It’s reasonably easy, in this case, to get an attractive layout. It’s much more difficult to do your own layout if you want to allow for changes of size. In that case, you have to respond to changes in the container’s size by recomputing the sizes and positions of all the components that it contains. If you want to respond to changes in a container’s size, you can register an appropriate listener with the container. Any component generates an event of type ComponentEvent when its size changes (and also when it is moved, hidden, or shown). You can register a ComponentListener with the container and respond to size change events by recomputing the sizes and positions of all the components in the container. Consult a Java reference for more information about ComponentEvents. However, my real advice is that if you want to allow for changes in the container’s size, try to find a layout manager to do the work for you. (The complete source code for this example is in NullLayoutDemo.java.)
- 309. 6.7. BASIC LAYOUT 293 6.7.6 A Little Card Game For a final example, let’s look at something a little more interesting as a program. The example is a simple card game in which you look at a playing card and try to predict whether the next card will be higher or lower in value. (Aces have the lowest value in this game.) You’ve seen a text-oriented version of the same game in Subsection 5.4.3. Section 5.4 also introduced Deck, Hand, and Card classes that are used in the game program. In this GUI version of the game, you click on a button to make your prediction. If you predict wrong, you lose. If you make three correct predictions, you win. After completing one game, you can click the “New Game” button to start a new game. Here is what the game looks like: The complete source code for this example is in the file HighLowGUI.java. You can try out the game in the on-line version of this section, or by running the program as a stand-alone application. The overall structure of the main panel in this example should be clear: It has three buttons in a subpanel at the bottom of the main panel and a large drawing surface that displays the cards and a message. The main panel uses a BorderLayout. The drawing surface occupies the CENTER position of the border layout. The subpanel that contains the buttons occupies the SOUTH position of the border layout, and the other three positions of the layout are empty. The drawing surface is defined by a nested class named CardPanel, which is a subclass of JPanel. I have chosen to let the drawing surface object do most of the work of the game: It listens for events from the three buttons and responds by taking the appropriate actions. The main panel is defined by HighLowGUI itself, which is another subclass of JPanel. The constructor of the HighLowGUI class creates all the other components, sets up event handling, and lays out the components: public HighLowGUI() { // The constructor. setBackground( new Color(130,50,40) ); setLayout( new BorderLayout(3,3) ); // BorderLayout with 3-pixel gaps. CardPanel board = new CardPanel(); // Where the cards are drawn. add(board, BorderLayout.CENTER); JPanel buttonPanel = new JPanel(); // The subpanel that holds the buttons. buttonPanel.setBackground( new Color(220,200,180) ); add(buttonPanel, BorderLayout.SOUTH); JButton higher = new JButton( "Higher" );
- 310. 294 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING higher.addActionListener(board); // The CardPanel listens for events. buttonPanel.add(higher); JButton lower = new JButton( "Lower" ); lower.addActionListener(board); buttonPanel.add(lower); JButton newGame = new JButton( "New Game" ); newGame.addActionListener(board); buttonPanel.add(newGame); setBorder(BorderFactory.createLineBorder( new Color(130,50,40), 3) ); } // end constructor The programming of the drawing surface class, CardPanel, is a nice example of thinking in terms of a state machine. (See Subsection 6.5.4.) It is important to think in terms of the states that the game can be in, how the state can change, and how the response to events can depend on the state. The approach that produced the original, text-oriented game in Subsection 5.4.3 is not appropriate here. Trying to think about the game in terms of a process that goes step-by-step from beginning to end is more likely to confuse you than to help you. The state of the game includes the cards and the message. The cards are stored in an object of type Hand. The message is a String. These values are stored in instance variables. There is also another, less obvious aspect of the state: Sometimes a game is in progress, and the user is supposed to make a prediction about the next card. Sometimes we are between games, and the user is supposed to click the “New Game” button. It’s a good idea to keep track of this basic difference in state. The CardPanel class uses a boolean instance variable named gameInProgress for this purpose. The state of the game can change whenever the user clicks on a button. The CardPanel class implements the ActionListener interface and defines an actionPerformed() method to respond to the user’s clicks. This method simply calls one of three other methods, doHigher(), doLower(), or newGame(), depending on which button was pressed. It’s in these three event- handling methods that the action of the game takes place. We don’t want to let the user start a new game if a game is currently in progress. That would be cheating. So, the response in the newGame() method is different depending on whether the state variable gameInProgress is true or false. If a game is in progress, the message instance variable should be set to show an error message. If a game is not in progress, then all the state variables should be set to appropriate values for the beginning of a new game. In any case, the board must be repainted so that the user can see that the state has changed. The complete newGame() method is as follows: /** * Called by the CardPanel constructor, and called by actionPerformed() if * the user clicks the "New Game" button. Start a new game. */ void doNewGame() { if (gameInProgress) { // If the current game is not over, it is an error to try // to start a new game. message = "You still have to finish this game!"; repaint(); return; }
- 311. 6.7. BASIC LAYOUT 295 deck = new Deck(); // Create the deck and hand to use for this game. hand = new Hand(); deck.shuffle(); hand.addCard( deck.dealCard() ); // Deal the first card into the hand. message = "Is the next card higher or lower?"; gameInProgress = true; repaint(); } // end doNewGame() The doHigher() and doLower() methods are almost identical to each other (and could probably have been combined into one method with a parameter, if I were more clever). Let’s look at the doHigher() routine. This is called when the user clicks the “Higher” button. This only makes sense if a game is in progress, so the first thing doHigher() should do is check the value of the state variable gameInProgress. If the value is false, then doHigher() should just set up an error message. If a game is in progress, a new card should be added to the hand and the user’s prediction should be tested. The user might win or lose at this time. If so, the value of the state variable gameInProgress must be set to false because the game is over. In any case, the board is repainted to show the new state. Here is the doHigher() method: /** * Called by actionPerformmed() when user clicks "Higher" button. * Check the user’s prediction. Game ends if user guessed * wrong or if the user has made three correct predictions. */ void doHigher() { if (gameInProgress == false) { // If the game has ended, it was an error to click "Higher", // So set up an error message and abort processing. message = "Click "New Game" to start a new game!"; repaint(); return; } hand.addCard( deck.dealCard() ); // Deal a card to the hand. int cardCt = hand.getCardCount(); Card thisCard = hand.getCard( cardCt - 1 ); // Card just dealt. Card prevCard = hand.getCard( cardCt - 2 ); // The previous card. if ( thisCard.getValue() < prevCard.getValue() ) { gameInProgress = false; message = "Too bad! You lose."; } else if ( thisCard.getValue() == prevCard.getValue() ) { gameInProgress = false; message = "Too bad! You lose on ties."; } else if ( cardCt == 4) { gameInProgress = false; message = "You win! You made three correct guesses."; } else { message = "Got it right! Try for " + cardCt + "."; } repaint(); } // end doHigher()
- 312. 296 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING The paintComponent() method of the CardPanel class uses the values in the state variables to decide what to show. It displays the string stored in the message variable. It draws each of the cards in the hand. There is one little tricky bit: If a game is in progress, it draws an extra face-down card, which is not in the hand, to represent the next card in the deck. Drawing the cards requires some care and computation. I wrote a method, “void drawCard(Graphics g, Card card, int x, int y)”, which draws a card with its upper left corner at the point (x,y). The paintComponent() routine decides where to draw each card and calls this routine to do the drawing. You can check out all the details in the source code, HighLowGUI.java. ∗ ∗ ∗ One further note on the programming of this example: The source code defines HighLowGUI as a subclass of JPanel. The class contains a main() routine so that it can be run as a stand-alone application; the main() routine simply opens a window that uses a panel of type HighLowGUI as its content pane. In addition, I decided to write an applet version of the program as a static nested class named Applet inside the HighLowGUI class. Since this is a nested class, its full name is HighLowGUI.Applet and the class file that is produced when the source code is compiled is named HighLowGUI$Applet.class. This class is used for the applet version of the program in the on-line version of the book. The <applet> tag lists the class file for the applet as code="HighLowGUI$Applet.class". This is admittedly an unusual way to organize the program, and it is probably more natural to have the panel, applet, and stand-alone program defined in separate classes. However, writing the program in this way does show the flexibility of Java classes. (Nested classes were discussed in Subsection 5.7.2.) 6.8 Menus and Dialogs We have already encountered many of the basic aspects of GUI programming, but professional programs use many additional features. We will cover some of the advanced features of Java GUI programming in Chapter 12, but in this section we look briefly at a few more basic features that are essential for writing GUI programs. I will discuss these features in the context of a “MosaicDraw” program that is shown in this picture:
- 313. 6.8. MENUS AND DIALOGS 297 As the user clicks-and-drags the mouse in the large drawing area of this program, it leaves a trail of little colored squares. There is some random variation in the color of the squares. (This is meant to make the picture look a little more like a real mosaic, which is a picture made out of small colored stones in which there would be some natural color variation.) There is a menu bar above the drawing area. The “Control” menu contains commands for filling and clearing the drawing area, along with a few options that affect the appearance of the picture. The “Color” menu lets the user select the color that will be used when the user draws. The “Tools” menu affects the behavior of the mouse. Using the default “Draw” tool, the mouse leaves a trail of single squares. Using the “Draw 3x3” tool, the mouse leaves a swath of colored squares that is three squares wide. There are also “Erase” tools, which let the user set squares back to their default black color. The drawing area of the program is a panel that belongs to the MosaicPanel class, a subclass of JPanel that is defined in MosaicPanel.java. MosaicPanel is a highly reusable class for repre- senting mosaics of colored rectangles. It does not directly support drawing on the mosaic, but it does support setting the color of each individual square. The MosaicDraw program installs a mouse listener on the panel; the mouse listener responds to mousePressed and mouseDragged events on the panel by setting the color of the square that contains the mouse. This is a nice example of applying a listener to an object to do something that was not programmed into the object itself. Most of the programming for MosaicDraw can be found in MosaicDrawController.java. (It could have gone into the MosaicPanel class, if I had not decided to use that pre-existing class in unmodified form.) It is the MosaicDrawController class that creates a MosaicPanel object and adds a mouse listener to it. It also creates the menu bar that is shown at the top of the program and implements all the commands in the menu bar. It has an instance method getMosaicPanel() that returns a reference to the mosaic panel that it has created, and it has another instance method getMenuBar() that returns a menu bar for the program. These methods are used to obtain the panel and menu bar so that they can be added to an applet or a frame. To get a working program, an object of type JApplet or JFrame is needed. The files Mo- saicDrawApplet.java and MosaicDrawFrame.java define the applet and frame versions of the program. These are rather simple classes; they simply create a MosaicDrawController object and use its mosaic panel and menu bar. I urge you to study these files, along with MosaicDraw- Controller.java. I will not be discussing all aspects of the code here, but you should be able to understand it all after reading this section. As for MosaicPanel.java, it uses some techniques that you would not understand at this point, but I encourage you to at least read the comments in this file to learn about the API for mosaic panels. 6.8.1 Menus and Menubars MosaicDraw is the first example that we have seen that uses a menu bar. Fortunately, menus are very easy to use in Java. The items in a menu are represented by the class JMenuItem (this class and other menu-related classes are in package javax.swing). Menu items are used in almost exactly the same way as buttons. In fact, JMenuItem and JButton are both subclasses of a class, AbstractButton, that defines their common behavior. In particular, a JMenuItem is created using a constructor that specifies the text of the menu item, such as: JMenuItem fillCommand = new JMenuItem("Fill"); You can add an ActionListener to a JMenuItem by calling the menu item’s addActionListener()
- 314. 298 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING method. The actionPerformed() method of the action listener is called when the user selects the item from the menu. You can change the text of the item by calling its setText(String) method, and you can enable it and disable it using the setEnabled(boolean) method. All this works in exactly the same way as for a JButton. The main difference between a menu item and a button, of course, is that a menu item is meant to appear in a menu rather than in a panel. A menu in Java is represented by the class JMenu. A JMenu has a name, which is specified in the constructor, and it has an add(JMenuItem) method that can be used to add a JMenuItem to the menu. So, the “Tools” menu in the MosaicDraw program could be created as follows, where listener is a variable of type ActionListener: JMenu toolsMenu = new JMenu("Tools"); // Create a menu with name "Tools" JMenuItem drawCommand = new JMenuItem("Draw"); // Create a menu item. drawCommand.addActionListener(listener); // Add listener to menu item. toolsMenu.add(drawCommand); // Add menu item to menu. JMenuItem eraseCommand = new JMenuItem("Erase"); // Create a menu item. eraseCommand.addActionListener(listener); // Add listener to menu item. toolsMenu.add(eraseCommand); // Add menu item to menu. . . // Create and add other menu items. . Once a menu has been created, it must be added to a menu bar. A menu bar is represented by the class JMenuBar. A menu bar is just a container for menus. It does not have a name, and its constructor does not have any parameters. It has an add(JMenu) method that can be used to add menus to the menu bar. For example, the MosaicDraw program uses three menus, controlMenu, colorMenu, and toolsMenu. We could create a menu bar and add the menus to it with the statements: JMenuBar menuBar = new JMenuBar(); menuBar.add(controlMenu); menuBar.add(colorMenu); menuBar.add(toolsMenu); The final step in using menus is to use the menu bar in a JApplet or JFrame. We have already seen that an applet or frame has a “content pane.” The menu bar is another component of the applet or frame, not contained inside the content pane. Both the JApplet and the JFrame classes include an instance method setMenuBar(JMenuBar) that can be used to set the menu bar. (There can only be one, so this is a “set” method rather than an “add” method.) In the MosaicDraw program, the menu bar is created by a MosaicDrawController object and can be obtained by calling that object’s getMenuBar() method. Here is the basic code that is used (in somewhat modified form) to set up the interface both in the applet and in the frame version of the program: MosaicDrawController controller = new MosaicDrawController(); MoasicPanel content = controller.getMosaicPanel(); setContentPane( content ); // Use panel from controller as content pane. JMenuBar menuBar = controller.getMenuBar(); setJMenuBar( menuBar ); // Use the menu bar from the controller.
- 315. 6.8. MENUS AND DIALOGS 299 Using menus always follows the same general pattern: Create a menu bar. Create menus and add them to the menu bar. Create menu items and add them to the menus (and set up listening to handle action events from the menu items). Use the menu bar in a JApplet or JFrame by calling the setJMenuBar() method of the applet or frame. ∗ ∗ ∗ There are other kinds of menu items, defined by subclasses of JMenuItem, that can be added to menus. One of these is JCheckBoxMenuItem, which represents menu items that can be in one of two states, selected or not selected. A JCheckBoxMenuItem has the same functionality and is used in the same way as a JCheckBox (see Subsection 6.6.3). Three JCheckBoxMenuItems are used in the “Control” menu of the MosaicDraw program. One can be used to turn the random color variation of the squares on and off. Another turns a symmetry feature on and off; when symmetry is turned on, the user’s drawing is reflected horizontally and vertically to produce a symmetric pattern. And the third check box menu item shows and hides the “grouting” in the mosaic; the grouting is the gray lines that are drawn around each of the little squares in the mosaic. The menu item that corresponds to the “Use Randomness” option in the “Control” menu could be set up with the statements: JMenuItem useRandomnessToggle = new JCheckBoxMenuItem("Use Randomness"); useRandomnessToggle.addActionListener(listener); // Set up a listener. useRandomnessToggle.setSelected(true); // Randomness is initially turned on. controlMenu.add(useRandomnessToggle); // Add the menu item to the menu. The “Use Randomness” JCheckBoxMenuItem corresponds to a boolean-valued instance vari- able named useRandomness in the MosaicDrawController class. This variable is part of the state of the controller object. Its value is tested whenever the user draws one of the squares, to decide whether or not to add a random variation to the color of the square. When the user selects the “Use Randomness” command from the menu, the state of the JCheckBoxMenuItem is re- versed, from selected to not-selected or from not-selected to selected. The ActionListener for the menu item checks whether the menu item is selected or not, and it changes the value of useRandomness to match. Note that selecting the menu command does not have any immediate effect on the picture that is shown in the window. It just changes the state of the program so that future drawing operations on the part of the user will have a different effect. The “Use Symmetry” option in the “Control” menu works in much the same way. The “Show Grouting” option is a little different. Selecting the “Show Grouting” option does have an immediate effect: The picture is redrawn with or without the grouting, depending on the state of the menu item. My program uses a single ActionListener to respond to all of the menu items in all the menus. This is not a particularly good design, but it is easy to implement for a small program like this one. The actionPerformed() method of the listener object uses the statement String command = evt.getActionCommand(); to get the action command of the source of the event; this will be the text of the menu item. The listener tests the value of command to determine which menu item was selected by the user. If the menu item is a JCheckBoxMenuItem, the listener must check the state of the menu item. Then menu item is the source of the event that is being processed. The listener can get its hands on the menu item object by calling evt.getSource(). Since the return value of getSource() is Object, the the return value must be type-cast to the correct type. Here, for example, is the code that handles the “Use Randomness” command: if (command.equals("Use Randomness")) { // Set the value of useRandomness depending on the menu item’s state.
- 316. 300 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING JCheckBoxMenuItem toggle = (JCheckBoxMenuItem)evt.getSource(); useRandomness = toggle.isSelected(); } ∗ ∗ ∗ In addition to menu items, a menu can contain lines that separate the menu items into groups. In the MosaicDraw program, the “Control” menu contains a separator. A JMenu has an instance method addSeparator() that can be used to add a separator to the menu. For example, the separator in the “Control” menu was created with the statement: controlMenu.addSeparator(); A menu can also contain a submenu. The name of the submenu appears as an item in the main menu. When the user moves the mouse over the submenu name, the submenu pops up. (There is no example of this in the MosaicDraw program.) It is very easy to do this in Java: You can add one JMenu to another JMenu using a statement such as mainMenu.add(submenu). 6.8.2 Dialogs One of the commands in the “Color” menu of the MosaicDraw program is “Custom Color. . . ”. When the user selects this command, a new window appears where the user can select a color. This window is an example of a dialog or dialog box. A dialog is a type of window that is generally used for short, single purpose interactions with the user. For example, a dialog box can be used to display a message to the user, to ask the user a question, to let the user select a file to be opened, or to let the user select a color. In Swing, a dialog box is represented by an object belonging to the class JDialog or to a subclass. The JDialog class is very similar to JFrame and is used in much the same way. Like a frame, a dialog box is a separate window. Unlike a frame, however, a dialog is not completely independent. Every dialog is associated with a frame (or another dialog), which is called its parent window. The dialog box is dependent on its parent. For example, if the parent is closed, the dialog box will also be closed. It is possible to create a dialog box without specifying a parent, but in that case a an invisible frame is created by the system to serve as the parent. Dialog boxes can be either modal or modeless. When a modal dialog is created, its parent frame is blocked. That is, the user will not be able to interact with the parent until the dialog box is closed. Modeless dialog boxes do not block their parents in the same way, so they seem a lot more like independent windows. In practice, modal dialog boxes are easier to use and are much more common than modeless dialogs. All the examples we will look at are modal. Aside from having a parent, a JDialog can be created and used in the same way as a JFrame. However, I will not give any examples here of using JDialog directly. Swing has many convenient methods for creating many common types of dialog boxes. For example, the color choice dialog that appears when the user selects the “Custom Color” command in the MosaicDraw program belongs to the class JColorChooser, which is a subclass of JDialog. The JColorChooser class has a static method static method that makes color choice dialogs very easy to use: Color JColorChooser.showDialog(Component parentComp, String title, Color initialColor) When you call this method, a dialog box appears that allows the user to select a color. The first parameter specifies the parent of the dialog; the parent window of the dialog will be the window (if any) that contains parentComp; this parameter can be null and it can itself be a frame or dialog object. The second parameter is a string that appears in the title bar of the
- 317. 6.8. MENUS AND DIALOGS 301 dialog box. And the third parameter, initialColor, specifies the color that is selected when the color choice dialog first appears. The dialog has a sophisticated interface that allows the user to change the selected color. When the user presses an “OK” button, the dialog box closes and the selected color is returned as the value of the method. The user can also click a “Cancel” button or close the dialog box in some other way; in that case, null is returned as the value of the method. By using this predefined color chooser dialog, you can write one line of code that will let the user select an arbitrary color. Swing also has a JFileChooser class that makes it almost as easy to show a dialog box that lets the user select a file to be opened or saved. The JOptionPane class includes a variety of methods for making simple dialog boxes that are variations on three basic types: a “message” dialog, a “confirm” dialog, and an “input” dialog. (The variations allow you to provide a title for the dialog box, to specify the icon that appears in the dialog, and to add other components to the dialog box. I will only cover the most basic forms here.) The on-line version of this section includes an applet that demonstrates JOptionPane as well as JColorChooser. A message dialog simply displays a message string to the user. The user (hopefully) reads the message and dismisses the dialog by clicking the “OK” button. A message dialog can be shown by calling the static method: void JOptionPane.showMessageDialog(Component parentComp, String message) The message can be more than one line long. Lines in the message should be separated by newline characters, n. New lines will not be inserted automatically, even if the message is very long. An input dialog displays a question or request and lets the user type in a string as a response. You can show an input dialog by calling: String JOptionPane.showInputDialog(Component parentComp, String question) Again, the question can include newline characters. The dialog box will contain an input box, an “OK” button, and a “Cancel” button. If the user clicks “Cancel”, or closes the dialog box in some other way, then the return value of the method is null. If the user clicks “OK”, then the return value is the string that was entered by the user. Note that the return value can be an empty string (which is not the same as a null value), if the user clicks “OK” without typing anything in the input box. If you want to use an input dialog to get a numerical value from the user, you will have to convert the return value into a number; see Subsection 3.7.2. Finally, a confirm dialog presents a question and three response buttons: “Yes”, “No”, and “Cancel”. A confirm dialog can be shown by calling: int JOptionPane.showConfirmDialog(Component parentComp, String question) The return value tells you the user’s response. It is one of the following constants: • JOptionPane.YES OPTION — the user clicked the “Yes” button • JOptionPane.NO OPTION — the user clicked the “No” button • JOptionPane.CANCEL OPTION — the user clicked the “Cancel” button • JOptionPane.CLOSE OPTION — the dialog was closed in some other way. By the way, it is possible to omit the Cancel button from a confirm dialog by calling one of the other methods in the JOptionPane class. Just call: JOptionPane.showConfirmDialog( parent, question, title, JOptionPane.YES NO OPTION )
- 318. 302 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING The final parameter is a constant which specifies that only a “Yes” button and a “No” button should be used. The third parameter is a string that will be displayed as the title of the dialog box window. If you would like to see how dialogs are created and used in the sample applet, you can find the source code in the file SimpleDialogDemo.java. 6.8.3 Fine Points of Frames In previous sections, whenever I used a frame, I created a JFrame object in a main() routine and installed a panel as the content pane of that frame. This works fine, but a more object- oriented approach is to define a subclass of JFrame and to set up the contents of the frame in the constructor of that class. This is what I did in the case of the MosaicDraw program. MosaicDrawFrame is defined as a subclass of JFrame. The definition of this class is very short, but it illustrates several new features of frames that I want to discuss: public class MosaicDrawFrame extends JFrame { public static void main(String[] args) { JFrame window = new MosaicDrawFrame(); window.setDefaultCloseOperation(JFrame.EXIT ON CLOSE); window.setVisible(true); } public MosaicDrawFrame() { super("Mosaic Draw"); MosaicDrawController controller = new MosaicDrawController(); setContentPane( controller.getMosaicPanel() ); setJMenuBar( controller.getMenuBar() ); pack(); Dimension screensize = Toolkit.getDefaultToolkit().getScreenSize(); setLocation( (screensize.width - getWidth())/2, (screensize.height - getHeight())/2 ); } } The constructor in this class begins with the statement super("Mosaic Draw"), which calls the constructor in the superclass, JFrame. The parameter specifies a title that will appear in the title bar of the window. The next three lines of the constructor set up the contents of the window; a MosaicDrawController is created, and the content pane and menu bar of the window are obtained from the controller. The next line is something new. If window is a variable of type JFrame (or JDialog), then the statement window.pack() will resize the window so that its size matches the preferred size of its contents. (In this case, of course, “pack()” is equivalent to “this.pack()”; that is, it refers to the window that is being created by the constructor.) The pack() method is usually the best way to set the size of a window. Note that it will only work correctly if every component in the window has a correct preferred size. This is only a problem in two cases: when a panel is used as a drawing surface and when a panel is used as a container with a null layout manager. In both these cases there is no way for the system to determine the correct preferred size automatically, and you should set a preferred size by hand. For example: panel.setPreferredSize( new Dimension(400, 250) );
- 319. 6.8. MENUS AND DIALOGS 303 The last two lines in the constructor position the window so that it is exactly centered on the screen. The line Dimension screensize = Toolkit.getDefaultToolkit().getScreenSize(); determines the size of the screen. The size of the screen is screensize.width pixels in the hor- izontal direction and screensize.height pixels in the vertical direction. The setLocation() method of the frame sets the position of the upper left corner of the frame on the screen. The expression “screensize.width - getWidth()” is the amount of horizontal space left on the screen after subtracting the width of the window. This is divided by 2 so that half of the empty space will be to the left of the window, leaving the other half of the space to the right of the window. Similarly, half of the extra vertical space is above the window, and half is below. Note that the constructor has created the window and set its size and position, but that at the end of the constructor, the window is not yet visible on the screen. (More exactly, the constructor has created the window object, but the visual representation of that object on the screen has not yet been created.) To show the window on the screen, it will be necessary to call its instance method, window.setVisible(true). In addition to the constructor, the MosaicDrawFrame class includes a main() routine. This makes it possible to run MosaicDrawFrame as a stand-alone application. (The main() routine, as a static method, has nothing to do with the function of a MosaicDrawFrame object, and it could (and perhaps should) be in a separate class.) The main() routine creates a MosaicDrawFrame and makes it visible on the screen. It also calls window.setDefaultCloseOperation(JFrame.EXIT ON CLOSE); which means that the program will end when the user closes the window. Note that this is not done in the constructor because doing it there would make MosaicDrawFrame less flexible. It would be possible, for example, to write a program that lets the user open multiple MosaicDraw windows. In that case, we don’t want to end the program just because the user has closed one of the windows. Furthermore, it is possible for an applet to create a frame, which will open as a separate window on the screen. An applet is not allowed to “terminate the program” (and it’s not even clear what that should mean in the case of an applet), and attempting to do so will produce an exception. There are other possible values for the default close operation of a window: • JFrame.DO NOTHING ON CLOSE — the user’s attempts to close the window by clicking its close box will be ignored. • JFrame.HIDE ON CLOSE — when the user clicks its close box, the window will be hidden just as if window.setVisible(false) were called. The window can be made visible again by calling window.setVisible(true). This is the value that is used if you do not specify another value by calling setDefaultCloseOperation. • JFrame.DISPOSE ON CLOSE — the window is closed and any operating system resources used by the window are released. It is not possible to make the window visible again. (This is the proper way to permanently get rid of a window without ending the program. You can accomplish the same thing by calling the instance method window.dispose().) I’ve written an applet version of the MosaicDraw program that appears on a Web page as a single button. When the user clicks the button, the applet opens a MosaicDrawFrame. In this case, the applet sets the default close operation of the window to JFrame.DISPOSE ON CLOSE. You can try the applet in the on-line version of this section.
- 320. 304 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING The file MosaicDrawLauncherApplet.java contains the source code for the applet. One interesting point in the applet is that the text of the button changes depending on whether a window is open or not. If there is no window, the text reads “Launch MosaicDraw”. When the window is open, it changes to “Close MosaicDraw”, and clicking the button will close the window. The change is implemented by attaching a WindowListener to the window. The listener responds to WindowEvents that are generated when the window opens and closes. Although I will not discuss window events further here, you can look at the source code for an example of how they can be used. 6.8.4 Creating Jar Files As the final topic for this chapter, we look again at jar files. Recall that a jar file is a “java archive” that can contain a number of class files. When creating a program that uses more than one class, it’s usually a good idea to place all the classes that are required by the program into a jar file, since then a user will only need that one file to run the program. Subsection 6.2.4 discusses how a jar file can be used for an applet. Jar files can also be used for stand-alone applications. In fact, it is possible to make a so-called executable jar file. A user can run an executable jar file in much the same way as any other application, usually by double-clicking the icon of the jar file. (The user’s computer must have a correct version of Java installed, and the computer must be configured correctly for this to work. The configuration is usually done automatically when Java is installed, at least on Windows and Mac OS.) The question, then, is how to create a jar file. The answer depends on what programming environment you are using. The two basic types of programming environment—command line and IDE—were discussed in Section 2.6. Any IDE (Integrated Programming Environment) for Java should have a command for creating jar files. In the Eclipse IDE, for example, it’s done as follows: In the Package Explorer pane, select the programming project (or just all the individual source code files that you need). Right-click on the selection, and choose “Export” from the menu that pops up. In the window that appears, select “JAR file” and click “Next”. In the window that appears next, enter a name for the jar file in the box labeled “JAR file”. (Click the “Browse” button next to this box to select the file name using a file dialog box.) The name of the file should end with “.jar”. If you are creating a regular jar file, not an executable one, you can hit “Finish” at this point, and the jar file will be created. You could do this, for example, if the jar file contains an applet but no main program. To create an executable file, hit the “Next” button twice to get to the “Jar Manifest Specification” screen. At the bottom of this screen is an input box labeled “Main class”. You have to enter the name of the class that contains the main() routine that will be run when the jar file is executed. If you hit the “Browse” button next to the “Main class” box, you can select the class from a list of classes that contain main() routines. Once you’ve selected the main class, you can click the “Finish” button to create the executable jar file. It is also possible to create jar files on the command line. The Java Development Kit includes a command-line program named jar that can be used to create jar files. If all your classes are in the default package (like the examples in this book), then the jar command is easy to use. To create a non-executable jar file on the command line, change to the directory that contains the class files that you want to include in the jar. Then give the command jar cf JarFileName.jar *.class where JarFileName can be any name that you want to use for the jar file. The “*” in “*.class” is a wildcard that makes *.class match every class file in the current directory. This means
- 321. 6.8. MENUS AND DIALOGS 305 that all the class files in the directory will be included in the jar file. If you want to include only certain class files, you can name them individually, separated by spaces. (Things get more complicated if your classes are not in the default package. In that case, the class files must be in subdirectories of the directory in which you issue the jar file. See Subsection 2.6.4.) Making an executable jar file on the command line is a little more complicated. There has to be some way of specifying which class contains the main() routine. This is done by creating a manifest file. The manifest file can be a plain text file containing a single line of the form Main-Class: ClassName where ClassName should be replaced by the name of the class that contains the main() routine. For example, if the main() routine is in the class MosaicDrawFrame, then the manifest file should read “Main-Class: MosaicDrawFrame”. You can give the manifest file any name you like. Put it in the same directory where you will issue the jar command, and use a command of the form jar cmf ManifestFileName JarFileName.jar *.class to create the jar file. (The jar command is capable of performing a variety of different opera- tions. The first parameter to the command, such as “cf” or “cmf”, tells it which operation to perform.) By the way, if you have successfully created an executable jar file, you can run it on the command line using the command “java -jar”. For example: java -jar JarFileName.jar
- 322. 306 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING Exercises for Chapter 6 1. In the SimpleStamperPanel example from Subsection 6.4.2, a rectangle or oval is drawn on the panel when the user clicks the mouse, except that when the user shift-clicks, the panel is cleared instead. Modify this class so that the modified version will continue to draw figures as the user drags the mouse. That is, the mouse will leave a trail of figures as the user drags the mouse. However, if the user shift-clicks, the panel should simply be cleared and no figures should be drawn even if the user drags the mouse after shift-clicking. Use your panel either in an applet or in a stand-alone application (or both). Here is a picture of my solution: The source code for the original panel class is SimpleStamperPanel.java. An applet that uses this class can be found in SimpleStamperApplet.java, and a main program that uses the panel in a frame is in SimpleStamper.java. See the discussion of dragging in Subsection 6.4.4. (Note that in the original version, I drew a black outline around each shape. In the modified version, I decided that it would look better to draw a gray outline instead.) 2. Write a panel that shows a small red square and a small blue square. The user should be able to drag either square with the mouse. (You’ll need an instance variable to remember which square the user is dragging.) The user can drag the square off the applet if she wants; if she does this, it’s gone. Use your panel in either an applet or a stand-alone application. 3. Write a panel that shows a pair of dice. When the user clicks on the panel, the dice should be rolled (that is, the dice should be assigned newly computed random values). Each die should be drawn as a square showing from 1 to 6 dots. Since you have to draw two dice, its a good idea to write a subroutine, “void drawDie(Graphics g, int val, int x, int y)”, to draw a die at the specified (x,y) coordinates. The second parameter, val, specifies the value that is showing on the die. Assume that the size of the panel is 100 by 100 pixels. Also write an applet that uses your panel as its content pane. Here is a picture of the applet:
- 323. Exercises 307 4. In Exercise 6.3, you wrote a pair-of-dice panel where the dice are rolled when the user clicks on the panel Now make a pair-of-dice program in which the user rolls the dice by clicking a button. The button should appear under the panel that shows the dice. Also make the following change: When the dice are rolled, instead of just showing the new value, show a short animation during which the values on the dice are changed in every frame. The animation is supposed to make the dice look more like they are actually rolling. Write your program as a stand-alone application. 5. In Exercise 3.6, you drew a checkerboard. For this exercise, write a checkerboard applet where the user can select a square by clicking on it. Hilite the selected square by drawing a colored border around it. When the applet is first created, no square is selected. When the user clicks on a square that is not currently selected, it becomes selected. If the user clicks the square that is selected, it becomes unselected. Assume that the size of the applet is exactly 160 by 160 pixels, so that each square on the checkerboard is 20 by 20 pixels. 6. For this exercise, you should modify the SubKiller game from Subsection 6.5.4. You can start with the existing source code, from the file SubKillerPanel.java. Modify the game so it keeps track of the number of hits and misses and displays these quantities. That is, every time the depth charge blows up the sub, the number of hits goes up by one. Every time the depth charge falls off the bottom of the screen without hitting the sub, the number of misses goes up by one. There is room at the top of the panel to display these numbers. To do this exercise, you only have to add a half-dozen lines to the source code. But you have to figure out what they are and where to add them. To do this, you’ll have to read the source code closely enough to understand how it works. 7. Exercise 5.2 involved a class, StatCalc.java, that could compute some statistics of a set of numbers. Write a program that uses the StatCalc class to compute and display statistics of numbers entered by the user. The panel will have an instance variable of type StatCalc that does the computations. The panel should include a JTextField where the user enters a number. It should have four labels that display four statistics for the numbers that have been entered: the number of numbers, the sum, the mean, and the standard deviation. Every time the user enters a new number, the statistics displayed on the labels should change. The user enters a number by typing it into the JTextField and pressing return. There should be a “Clear” button that clears out all the data. This means creating a new StatCalc object and resetting the displays on the labels. My panel also has an “Enter” button that does the same thing as pressing the return key in the JTextField. (Recall that a JTextField generates an ActionEvent when the user presses return, so your panel should register itself to listen for ActionEvents from the JTextField.) Write your program as a stand-alone application. Here is a picture of my solution to this problem:
- 324. 308 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING 8. Write a panel with a JTextArea where the user can enter some text. The panel should have a button. When the user clicks on the button, the panel should count the number of lines in the user’s input, the number of words in the user’s input, and the number of characters in the user’s input. This information should be displayed on three labels in the panel. Recall that if textInput is a JTextArea, then you can get the contents of the JTextArea by calling the function textInput.getText(). This function returns a String containing all the text from the text area. The number of characters is just the length of this String. Lines in the String are separated by the new line character, ’n’, so the number of lines is just the number of new line characters in the String, plus one. Words are a little harder to count. Exercise 3.4 has some advice about finding the words in a String. Essentially, you want to count the number of characters that are first characters in words. Don’t forget to put your JTextArea in a JScrollPane, and add the scroll pane to the container, not the text area. Scrollbars should appear when the user types more text than will fit in the available area. Here is a picture of my solution: 9. Write a Blackjack program that lets the user play a game of Blackjack, with the computer as the dealer. The applet should draw the user’s cards and the dealer’s cards, just as was done for the graphical HighLow card game in Subsection 6.7.6. You can use the source code for that game, HighLowGUI.java, for some ideas about how to write your Blackjack game. The structures of the HighLow panel and the Blackjack panel are very similar. You will certainly want to use the drawCard() method from the HighLow program.
- 325. Exercises 309 You can find a description of the game of Blackjack in Exercise 5.5. Add the following rule to that description: If a player takes five cards without going over 21, that player wins immediately. This rule is used in some casinos. For your program, it means that you only have to allow room for five cards. You should assume that the panel is just wide enough to show five cards, and that it is tall enough show the user’s hand and the dealer’s hand. Note that the design of a GUI Blackjack game is very different from the design of the text-oriented program that you wrote for Exercise 5.5. The user should play the game by clicking on “Hit” and “Stand” buttons. There should be a “New Game” button that can be used to start another game after one game ends. You have to decide what happens when each of these buttons is pressed. You don’t have much chance of getting this right unless you think in terms of the states that the game can be in and how the state can change. Your program will need the classes defined in Card.java, Hand.java, Deck.java, and BlackjackHand.java. 10. In the Blackjack game from Exercise 6.9, the user can click on the “Hit”, “Stand”, and “NewGame” buttons even when it doesn’t make sense to do so. It would be better if the buttons were disabled at the appropriate times. The “New Game” button should be dis- abled when there is a game in progress. The “Hit” and “Stand” buttons should be disabled when there is not a game in progress. The instance variable gameInProgress tells whether or not a game is in progress, so you just have to make sure that the buttons are properly enabled and disabled whenever this variable changes value. I strongly advise writing a sub- routine that can be called whenever it is necessary to set the value of the gameInProgress variable. Then the subroutine can take responsibility for enabling and disabling the but- tons. Recall that if bttn is a variable of type JButton, then bttn.setEnabled(false) disables the button and bttn.setEnabled(true) enables the button. As a second (and more difficult) improvement, make it possible for the user to place bets on the Blackjack game. When the applet starts, give the user $100. Add a JTextField to the strip of controls along the bottom of the applet. The user can enter the bet in this JTextField. When the game begins, check the amount of the bet. You should do this when the game begins, not when it ends, because several errors can occur: The contents of the JTextField might not be a legal number. The bet that the user places might be more money than the user has, or it might be <= 0. You should detect these errors and show an error message instead of starting the game. The user’s bet should be an integral number of dollars. It would be a good idea to make the JTextField uneditable while the game is in progress. If betInput is the JTextField, you can make it editable and uneditable by the user with the commands betInput.setEditable(true) and betInput.setEditable(false). In the paintComponent() method, you should include commands to display the amount of money that the user has left. There is one other thing to think about: Ideally, the applet should not start a new game when it is first created. The user should have a chance to set a bet amount before the game starts. So, in the constructor for the drawing surface class, you should not call doNewGame(). You might want to display a message such as “Welcome to Blackjack” before the first game starts. Here is a picture of my program:
- 326. 310 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING
- 327. Quiz 311 Quiz on Chapter 6 1. Programs written for a graphical user interface have to deal with “events.” Explain what is meant by the term event. Give at least two different examples of events, and discuss how a program might respond to those events. 2. Explain carefully what the repaint() method does. 3. What is HTML? 4. Java has a standard class called JPanel. Discuss two ways in which JPanels can be used. 5. Draw the picture that will be produced by the following paintComponent() method: public static void paintComponent(Graphics g) { super.paintComponent(g); for (int i=10; i <= 210; i = i + 50) for (int j = 10; j <= 210; j = j + 50) g.drawLine(i,10,j,60); } 6. Suppose you would like a panel that displays a green square inside a red circle, as illus- trated. Write a paintComponent() method for the panel class that will draw the image. 7. Java has a standard class called MouseEvent. What is the purpose of this class? What does an object of type MouseEvent do? 8. One of the main classes in Swing is the JComponent class. What is meant by a component? What are some examples? 9. What is the function of a LayoutManager in Java? 10. What type of layout manager is being used for each of the three panels in the following illustration from Section 6.7?
- 328. 312 CHAPTER 6. INTRODUCTION TO GUI PROGRAMMING T h r e e p a n e l s , s h o w n i n c o l o r , c o n t a i n i n g s i x o t h e r c o m p o n e n t s , s h o w n i n g r a y . 11. Explain how Timers are used to do animation. 12. What is a JCheckBox and how is it used?
- 329. Chapter 7 Arrays Computers get a lot of their power from working with data structures. A data structure is an organized collection of related data. An object is a data structure, but this type of data structure—consisting of a fairly small number of named instance variables—is just the beginning. In many cases, programmers build complicated data structures by hand, by linking objects together. We’ll look at these custom-built data structures in Chapter 9. But there is one type of data structure that is so important and so basic that it is built into every programming language: the array. An array is a data structure consisting of a numbered list of items, where all the items are of the same type. In Java, the items in an array are always numbered from zero up to some maximum value, which is set when the array is created. For example, an array might contain 100 integers, numbered from zero to 99. The items in an array can belong to one of Java’s primitive types. They can also be references to objects, so that you could, for example, make an array containing all the buttons in a GUI program. This chapter discusses how arrays are created and used in Java. It also covers the standard class java.util.ArrayList. An object of type ArrayList is very similar to an array of Objects, but it can grow to hold any number of items. 7.1 Creating and Using Arrays When a number of data items are chunked together into a unit, the result is a data structure. Data structures can be very complex, but in many applications, the appropriate data structure consists simply of a sequence of data items. Data structures of this simple variety can be either arrays or records. The term “record” is not used in Java. A record is essentially the same as a Java object that has instance variables only, but no instance methods. Some other languages, which do not support objects in general, nevertheless do support records. The C programming language, for example, is not object-oriented, but it has records, which in C go by the name “struct.” The data items in a record—in Java, an object’s instance variables—are called the fields of the record. Each item is referred to using a field name. In Java, field names are just the names of the instance variables. The distinguishing characteristics of a record are that the data items in the record are referred to by name and that different fields in a record are allowed to be of different types. For example, if the class Person is defined as: class Person { String name; 313
- 330. 314 CHAPTER 7. ARRAYS int id number; Date birthday; int age; } then an object of class Person could be considered to be a record with four fields. The field names are name, id number, birthday, and age. Note that the fields are of various types: String, int, and Date. Because records are just a special type of object, I will not discuss them further. 7.1.1 Arrays Like a record, an array is a sequence of items. However, where items in a record are referred to by name, the items in an array are numbered, and individual items are referred to by their position number. Furthermore, all the items in an array must be of the same type. The definition of an array is: a numbered sequence of items, which are all of the same type. The number of items in an array is called the length of the array. The position number of an item in an array is called the index of that item. The type of the individual items in an array is called the base type of the array. The base type of an array can be any Java type, that is, one of the primitive types, or a class name, or an interface name. If the base type of an array is int, it is referred to as an “array of ints.” An array with base type String is referred to as an “array of Strings.” However, an array is not, properly speaking, a list of integers or strings or other values. It is better thought of as a list of variables of type int, or of type String, or of some other type. As always, there is some potential for confusion between the two uses of a variable: as a name for a memory location and as a name for the value stored in that memory location. Each position in an array acts as a variable. Each position can hold a value of a specified type (the base type of the array). The value can be changed at any time. Values are stored in an array. The array is the container, not the values. The items in an array—really, the individual variables that make up the array—are more often referred to as the elements of the array. In Java, the elements in an array are always numbered starting from zero. That is, the index of the first element in the array is zero. If the length of the array is N, then the index of the last element in the array is N-1. Once an array has been created, its length cannot be changed. Java arrays are objects. This has several consequences. Arrays are created using a form of the new operator. No variable can ever hold an array; a variable can only refer to an array. Any variable that can refer to an array can also hold the value null, meaning that it doesn’t at the moment refer to anything. Like any object, an array belongs to a class, which like all classes is a subclass of the class Object. The elements of the array are, essentially, instance variables in the array object, except that they are referred to by number rather than by name. Nevertheless, even though arrays are objects, there are differences between arrays and other kinds of objects, and there are a number of special language features in Java for creating and using arrays. 7.1.2 Using Arrays Suppose that A is a variable that refers to an array. Then the element at index k in A is referred to as A[k]. The first element is A[0], the second is A[1], and so forth. “A[k]” is really a variable, and it can be used just like any other variable. You can assign values to it, you can
- 331. 7.1. CREATING AND USING ARRAYS 315 use it in expressions, and you can pass it as a parameter to a subroutine. All of this will be discussed in more detail below. For now, just keep in mind the syntax harray-variablei [ hinteger-expressioni ] for referring to an element of an array. Although every array, as an object, belongs to some class, array classes never have to be defined. Once a type exists, the corresponding array class exists automatically. If the name of the type is BaseType, then the name of the associated array class is BaseType[ ]. That is to say, an object belonging to the class BaseType[ ] is an array of items, where each item is a variable of type BaseType. The brackets, “[]”, are meant to recall the syntax for referring to the individual items in the array. “BaseType[ ]” is read as “array of BaseType” or “BaseType array.” It might be worth mentioning here that if ClassA is a subclass of ClassB, then the class ClassA[ ] is automatically a subclass of ClassB[ ]. The base type of an array can be any legal Java type. From the primitive type int, the array type int[ ] is derived. Each element in an array of type int[ ] is a variable of type int, which holds a value of type int. From a class named Shape, the array type Shape[ ] is derived. Each item in an array of type Shape[ ] is a variable of type Shape, which holds a value of type Shape. This value can be either null or a reference to an object belonging to the class Shape. (This includes objects belonging to subclasses of Shape.) ∗ ∗ ∗ Let’s try to get a little more concrete about all this, using arrays of integers as our first example. Since int[ ] is a class, it can be used to declare variables. For example, int[] list; creates a variable named list of type int[ ]. This variable is capable of referring to an array of ints, but initially its value is null (if list is a member variable in a class) or undefined (if list is a local variable in a method). The new operator is used to create a new array object, which can then be assigned to list. The syntax for using new with arrays is different from the syntax you learned previously. As an example, list = new int[5]; creates an array of five integers. More generally, the constructor “new BaseType[N]” is used to create an array belonging to the class BaseType[ ]. The value N in brackets specifies the length of the array, that is, the number of elements that it contains. Note that the array “knows” how long it is. The length of the array is an instance variable in the array object. In fact, the length of an array, list, can be referred to as list.length. (However, you are not allowed to change the value of list.length, so it’s really a “final” instance variable, that is, one whose value cannot be changed after it has been initialized.) The situation produced by the statement “list = new int[5];” can be pictured like this: l i s t : ( 5 ) l i s t . l e n g t h l i s t [ 0 ] 0 l i s t [ 1 ] 0 l i s t [ 2 ] 0 l i s t [ 3 ] 0 l i s t [ 4 ] 0 T h e s t a t e m e n t " l i s t = n e w i n t [ 5 ] ; " c r e a t e s a n a r r a y t h a t c a n h o l d fi v e i n t s , a n d s e t s l i s t t o r e f e r t o i t . T h e a r r a y o b j e c t c o n t a i n s fi v e i n t e g e r s , w h i c h a r e r e f e r r e d t o a s l i s t [ 0 ] , l i s t [ 1 ] , a n d s o o n . I t a l s o c o n t a i n s l i s t . l e n g t h , w h i c h g i v e s t h e n u m b e r o f i t e m s i n t h e a r r a y . l i s t . l e n g t h c a n ' t b e c h a n g e d .
- 332. 316 CHAPTER 7. ARRAYS Note that the newly created array of integers is automatically filled with zeros. In Java, a newly created array is always filled with a known, default value: zero for numbers, false for boolean, the character with Unicode number zero for char, and null for objects. The elements in the array, list, are referred to as list[0], list[1], list[2], list[3], and list[4]. (Note again that the index for the last item is one less than list.length.) However, array references can be much more general than this. The brackets in an array reference can contain any expression whose value is an integer. For example if indx is a variable of type int, then list[indx] and list[2*indx+7] are syntactically correct references to elements of the array list. Thus, the following loop would print all the integers in the array, list, to standard output: for (int i = 0; i < list.length; i++) { System.out.println( list[i] ); } The first time through the loop, i is 0, and list[i] refers to list[0]. So, it is the value stored in the variable list[0] that is printed. The second time through the loop, i is 1, and the value stored in list[1] is printed. The loop ends after printing the value of list[4], when i becomes equal to 5 and the continuation condition “i < list.length” is no longer true. This is a typical example of using a loop to process an array. I’ll discuss more examples of array processing throughout this chapter. Every use of a variable in a program specifies a memory location. Think for a moment about what the computer does when it encounters a reference to an array element, list[k], while it is executing a program. The computer must determine which memory location is being referred to. To the computer, list[k] means something like this: “Get the pointer that is stored in the variable, list. Follow this pointer to find an array object. Get the value of k. Go to the k-th position in the array, and that’s the memory location you want.” There are two things that can go wrong here. Suppose that the value of list is null. If that is the case, then list doesn’t even refer to an array. The attempt to refer to an element of an array that doesn’t exist is an error that will cause an exception of type NullPointerException to be thrown. The second possible error occurs if list does refer to an array, but the value of k is outside the legal range of indices for that array. This will happen if k < 0 or if k >= list.length. This is called an “array index out of bounds” error. When an error of this type occurs, an exception of type ArrayIndexOutOfBoundsException is thrown. When you use arrays in a program, you should be mindful that both types of errors are possible. However, array index out of bounds errors are by far the most common error when working with arrays. 7.1.3 Array Initialization For an array variable, just as for any variable, you can declare the variable and initialize it in a single step. For example, int[] list = new int[5]; If list is a local variable in a subroutine, then this is exactly equivalent to the two statements: int[] list; list = new int[5]; (If list is an instance variable, then of course you can’t simply replace “int[] list = new int[5];” with “int[] list; list = new int[5];” since the assignment statement “list = new int[5];” is only legal inside a subroutine.)
- 333. 7.1. CREATING AND USING ARRAYS 317 The new array is filled with the default value appropriate for the base type of the array—zero for int and null for class types, for example. However, Java also provides a way to initialize an array variable with a new array filled with a specified list of values. In a declaration statement that creates a new array, this is done with an array initializer. For example, int[] list = { 1, 4, 9, 16, 25, 36, 49 }; creates a new array containing the seven values 1, 4, 9, 16, 25, 36, and 49, and sets list to refer to that new array. The value of list[0] will be 1, the value of list[1] will be 4, and so forth. The length of list is seven, since seven values are provided in the initializer. An array initializer takes the form of a list of values, separated by commas and enclosed between braces. The length of the array does not have to be specified, because it is implicit in the list of values. The items in an array initializer don’t have to be constants. They can be variables or arbitrary expressions, provided that their values are of the appropriate type. For example, the following declaration creates an array of eight Colors. Some of the colors are given by expressions of the form “new Color(r,g,b)” instead of by constants: Color[] palette = { Color.BLACK, Color.RED, Color.PINK, new Color(0,180,0), // dark green Color.GREEN, Color.BLUE, new Color(180,180,255), // light blue Color.WHITE }; A list initializer of this form can be used only in a declaration statement, to give an initial value to a newly declared array variable. It cannot be used in an assignment statement to assign a value to a variable that has been previously declared. However, there is another, similar notation for creating a new array that can be used in an assignment statement or passed as a parameter to a subroutine. The notation uses another form of the new operator to both create and initialize a new array object at the same time. (The rather odd syntax is similar to the syntax for anonymous classes, which were discussed in Subsection 5.7.3.) For example to assign a new value to an array variable, list, that was declared previously, you could use: list = new int[] { 1, 8, 27, 64, 125, 216, 343 }; The general syntax for this form of the new operator is new hbase-typei [ ] { hlist-of-valuesi } This is actually an expression whose value is a reference to a newly created array object. This means that it can be used in any context where an object of type hbase-typei[] is expected. For example, if makeButtons is a method that takes an array of Strings as a parameter, you could say: makeButtons( new String[] { "Stop", "Go", "Next", "Previous" } ); Being able to create and use an array “in place” in this way can be very convenient, in the same way that anonymous nested classes are convenient. By the way, it is perfectly legal to use the “new BaseType[] { ... }” syntax instead of the array initializer syntax in the declaration of an array variable. For example, instead of saying:
- 334. 318 CHAPTER 7. ARRAYS int[] primes = { 2, 3, 5, 7, 11, 13, 17, 19 }; you can say, equivalently, int[] primes = new int[] { 2, 3, 5, 7, 11, 17, 19 }; In fact, rather than use a special notation that works only in the context of declaration state- ments, I prefer to use the second form. ∗ ∗ ∗ One final note: For historical reasons, an array declaration such as int[] list; can also be written as int list[]; which is a syntax used in the languages C and C++. However, this alternative syntax does not really make much sense in the context of Java, and it is probably best avoided. After all, the intent is to declare a variable of a certain type, and the name of that type is “int[ ]”. It makes sense to follow the “htype-namei hvariable-namei;” syntax for such declarations. 7.2 Programming With Arrays Arrays are the most basic and the most important type of data structure, and tech- niques for processing arrays are among the most important programming techniques you can learn. Two fundamental array processing techniques—searching and sorting—will be covered in Section 7.4. This section introduces some of the basic ideas of array processing in general. 7.2.1 Arrays and for Loops In many cases, processing an array means applying the same operation to each item in the array. This is commonly done with a for loop. A loop for processing all the elements of an array A has the form: // do any necessary initialization for (int i = 0; i < A.length; i++) { . . . // process A[i] } Suppose, for example, that A is an array of type double[ ]. Suppose that the goal is to add up all the numbers in the array. An informal algorithm for doing this would be: Start with 0; Add A[0]; (process the first item in A) Add A[1]; (process the second item in A) . . . Add A[ A.length - 1 ]; (process the last item in A) Putting the obvious repetition into a loop and giving a name to the sum, this becomes:
- 335. 7.2. PROGRAMMING WITH ARRAYS 319 double sum; // The sum of the numbers in A. sum = 0; // Start with 0. for (int i = 0; i < A.length; i++) sum += A[i]; // add A[i] to the sum, for // i = 0, 1, ..., A.length - 1 Note that the continuation condition, “i < A.length”, implies that the last value of i that is actually processed is A.length-1, which is the index of the final item in the array. It’s important to use “<” here, not “<=”, since “<=” would give an array index out of bounds error. There is no element at position A.length in A. Eventually, you should just about be able to write loops similar to this one in your sleep. I will give a few more simple examples. Here is a loop that will count the number of items in the array A which are less than zero: int count; // For counting the items. count = 0; // Start with 0 items counted. for (int i = 0; i < A.length; i++) { if (A[i] < 0.0) // if this item is less than zero... count++; // ...then count it } // At this point, the value of count is the number // of items that have passed the test of being < 0 Replace the test “A[i] < 0.0”, if you want to count the number of items in an array that satisfy some other property. Here is a variation on the same theme. Suppose you want to count the number of times that an item in the array A is equal to the item that follows it. The item that follows A[i] in the array is A[i+1], so the test in this case is “if (A[i] == A[i+1])”. But there is a catch: This test cannot be applied when A[i] is the last item in the array, since then there is no such item as A[i+1]. The result of trying to apply the test in this case would be an ArrayIndexOutOfBoundsException. This just means that we have to stop one item short of the final item: int count = 0; for (int i = 0; i < A.length - 1; i++) { if (A[i] == A[i+1]) count++; } Another typical problem is to find the largest number in A. The strategy is to go through the array, keeping track of the largest number found so far. We’ll store the largest number found so far in a variable called max. As we look through the array, whenever we find a number larger than the current value of max, we change the value of max to that larger value. After the whole array has been processed, max is the largest item in the array overall. The only question is, what should the original value of max be? One possibility is to start with max equal to A[0], and then to look through the rest of the array, starting from A[1], for larger items: double max = A[0]; for (int i = 1; i < A.length; i++) { if (A[i] > max) max = A[i]; } // at this point, max is the largest item in A
- 336. 320 CHAPTER 7. ARRAYS (There is one subtle problem here. It’s possible in Java for an array to have length zero. In that case, A[0] doesn’t exist, and the reference to A[0] in the first line gives an array index out of bounds error. However, zero-length arrays are normally something that you want to avoid in real problems. Anyway, what would it mean to ask for the largest item in an array that contains no items at all?) As a final example of basic array operations, consider the problem of copying an array. To make a copy of our sample array A, it is not sufficient to say double[] B = A; since this does not create a new array object. All it does is declare a new array variable and make it refer to the same object to which A refers. (So that, for example, a change to A[i] will automatically change B[i] as well.) To make a new array that is a copy of A, it is necessary to make a new array object and to copy each of the individual items from A into the new array: double[] B = new double[A.length]; // Make a new array object, // the same size as A. for (int i = 0; i < A.length; i++) B[i] = A[i]; // Copy each item from A to B. Copying values from one array to another is such a common operation that Java has a predefined subroutine to do it. The subroutine, System.arraycopy(), is a static member subroutine in the standard System class. Its declaration has the form public static void arraycopy(Object sourceArray, int sourceStartIndex, Object destArray, int destStartIndex, int count) where sourceArray and destArray can be arrays with any base type. Values are copied from sourceArray to destArray. The count tells how many elements to copy. Values are taken from sourceArray starting at position sourceStartIndex and are stored in destArray starting at position destStartIndex. For example, to make a copy of the array, A, using this subroutine, you would say: double B = new double[A.length]; System.arraycopy( A, 0, B, 0, A.length ); 7.2.2 Arrays and for-each Loops Java 5.0 introduced a new form of the for loop, the “for-each loop” that was introduced in Subsection 3.4.4. The for-each loop is meant specifically for processing all the values in a data structure. When used to process an array, a for-each loop can be used to perform the same operation on each value that is stored in the array. If anArray is an array of type BaseType[ ], then a for-each loop for anArray has the form: for ( BaseType item : anArray ) { . . // process the item . } In this loop, item is the loop control variable. It is being declared as a variable of type BaseType, where BaseType is the base type of the array. (In a for-each loop, the loop control variable must be declared in the loop.) When this loop is executed, each value from the array is assigned to item in turn and the body of the loop is executed for each value. Thus, the above loop is exactly equivalent to:
- 337. 7.2. PROGRAMMING WITH ARRAYS 321 for ( int index = 0; index < anArray.length; index++ ) { BaseType item; item = anArray[index]; // Get one of the values from the array . . // process the item . } For example, if A is an array of type int[ ], then we could print all the values from A with the for-each loop: for ( int item : A ) System.out.println( item ); and we could add up all the positive integers in A with: int sum = 0; // This will be the sum of all the positive numbers in A for ( int item : A ) { if (item > 0) sum = sum + item; } The for-each loop is not always appropriate. For example, there is no simple way to use it to process the items in just a part of an array. However, it does make it a little easier to process all the values in an array, since it eliminates any need to use array indices. It’s important to note that a for-each loop processes the values in the array, not the elements (where an element means the actual memory location that is part of the array). For example, consider the following incorrect attempt to fill an array of integers with 17’s: int[] intList = new int[10]; for ( int item : intList ) { // INCORRECT! DOES NOT MODIFY THE ARRAY! item = 17; } The assignment statement item = 17 assigns the value 17 to the loop control variable, item. However, this has nothing to do with the array. When the body of the loop is executed, the value from one of the elements of the array is copied into item. The statement item = 17 replaces that copied value but has no effect on the array element from which it was copied; the value in the array is not changed. 7.2.3 Array Types in Subroutines Any array type, such as double[ ], is a full-fledged Java type, so it can be used in all the ways that any other Java type can be used. In particular, it can be used as the type of a formal parameter in a subroutine. It can even be the return type of a function. For example, it might be useful to have a function that makes a copy of an array of double: /** * Create a new array of doubles that is a copy of a given array. * @param source the array that is to be copied; the value can be null * @return a copy of source; if source is null, then the return value is also null */ public static double[] copy( double[] source ) { if ( source == null )
- 338. 322 CHAPTER 7. ARRAYS return null; double[] cpy; // A copy of the source array. cpy = new double[source.length]; System.arraycopy( source, 0, cpy, 0, source.length ); return cpy; } The main() routine of a program has a parameter of type String[ ]. You’ve seen this used since all the way back in Section 2.1, but I haven’t really been able to explain it until now. The parameter to the main() routine is an array of Strings. When the system calls the main() routine, the strings in this array are the command-line arguments from the command that was used to run the program. When using a command-line interface, the user types a command to tell the system to execute a program. The user can include extra input in this command, beyond the name of the program. This extra input becomes the command-line arguments. For example, if the name of the class that contains the main() routine is myProg, then the user can type “java myProg” to execute the program. In this case, there are no command-line arguments. But if the user types the command java myProg one two three then the command-line arguments are the strings “one”, “two”, and “three”. The system puts these strings into an array of Strings and passes that array as a parameter to the main() routine. Here, for example, is a short program that simply prints out any command line arguments entered by the user: public class CLDemo { public static void main(String[] args) { System.out.println("You entered " + args.length + " command-line arguments"); if (args.length > 0) { System.out.println("They were:"); for (int i = 0; i < args.length; i++) System.out.println(" " + args[i]); } } // end main() } // end class CLDemo Note that the parameter, args, is never null when main() is called by the system, but it might be an array of length zero. In practice, command-line arguments are often the names of files to be processed by the program. I will give some examples of this in Chapter 11, when I discuss file processing. 7.2.4 Random Access So far, all my examples of array processing have used sequential access. That is, the elements of the array were processed one after the other in the sequence in which they occur in the array. But one of the big advantages of arrays is that they allow random access. That is, every element of the array is equally accessible at any given time. As an example, let’s look at a well-known problem called the birthday problem: Suppose that there are N people in a room. What’s the chance that there are two people in the room who have the same birthday? (That is, they were born on the same day in the same month, but not necessarily in the same year.) Most people severely underestimate the probability. We
- 339. 7.2. PROGRAMMING WITH ARRAYS 323 will actually look at a different version of the question: Suppose you choose people at random and check their birthdays. How many people will you check before you find one who has the same birthday as someone you’ve already checked? Of course, the answer in a particular case depends on random factors, but we can simulate the experiment with a computer program and run the program several times to get an idea of how many people need to be checked on average. To simulate the experiment, we need to keep track of each birthday that we find. There are 365 different possible birthdays. (We’ll ignore leap years.) For each possible birthday, we need to keep track of whether or not we have already found a person who has that birthday. The answer to this question is a boolean value, true or false. To hold the data for all 365 possible birthdays, we can use an array of 365 boolean values: boolean[] used; used = new boolean[365]; The days of the year are numbered from 0 to 364. The value of used[i] is true if someone has been selected whose birthday is day number i. Initially, all the values in the array, used, are false. When we select someone whose birthday is day number i, we first check whether used[i] is true. If so, then this is the second person with that birthday. We are done. If used[i] is false, we set used[i] to be true to record the fact that we’ve encountered someone with that birthday, and we go on to the next person. Here is a subroutine that carries out the simulated experiment (of course, in the subroutine, there are no simulated people, only simulated birthdays): /** * Simulate choosing people at random and checking the day of the year they * were born on. If the birthday is the same as one that was seen previously, * stop, and output the number of people who were checked. */ private static void birthdayProblem() { boolean[] used; // For recording the possible birthdays // that have been seen so far. A value // of true in used[i] means that a person // whose birthday is the i-th day of the // year has been found. int count; // The number of people who have been checked. used = new boolean[365]; // Initially, all entries are false. count = 0; while (true) { // Select a birthday at random, from 0 to 364. // If the birthday has already been used, quit. // Otherwise, record the birthday as used. int birthday; // The selected birthday. birthday = (int)(Math.random()*365); count++; if ( used[birthday] ) // This day was found before; It’s a duplicate. break; used[birthday] = true; } System.out.println("A duplicate birthday was found after "
- 340. 324 CHAPTER 7. ARRAYS + count + " tries."); } // end birthdayProblem() This subroutine makes essential use of the fact that every element in a newly created array of boolean is set to be false. If we wanted to reuse the same array in a second simulation, we would have to reset all the elements in it to be false with a for loop: for (int i = 0; i < 365; i++) used[i] = false; The program that uses this subroutine is BirthdayProblemDemo.java. An applet version of the program can be found in the online version of this section. 7.2.5 Arrays of Objects One of the examples in Subsection 6.4.2 was an applet that shows multiple copies of a message in random positions, colors, and fonts. When the user clicks on the applet, the positions, colors, and fonts are changed to new random values. Like several other examples from that chapter, the applet had a flaw: It didn’t have any way of storing the data that would be necessary to redraw itself. Arrays provide us with one possible solution to this problem. We can write a new version of the RandomStrings applet that uses an array to store the position, font, and color of each string. When the content pane of the applet is painted, this information is used to draw the strings, so the applet will paint itself correctly whenever it has to be redrawn. When the user clicks on the applet, the array is filled with new random values and the applet is repainted using the new data. So, the only time that the picture will change is in response to a mouse click. In this applet, the number of copies of the message is given by a named constant, MESSAGE COUNT. One way to store the position, color, and font of MESSAGE COUNT strings would be to use four arrays: int[] x = new int[MESSAGE COUNT]; int[] y = new int[MESSAGE COUNT]; Color[] color = new Color[MESSAGE COUNT]; Font[] font = new Font[MESSAGE COUNT]; These arrays would be filled with random values. In the paintComponent() method, the i-th copy of the string would be drawn at the point (x[i],y[i]). Its color would be given by color[i]. And it would be drawn in the font font[i]. This would be accomplished by the paintComponent() method public void paintComponent(Graphics g) { super.paintComponent(); // (Fill with background color.) for (int i = 0; i < MESSAGE COUNT; i++) { g.setColor( color[i] ); g.setFont( font[i] ); g.drawString( message, x[i], y[i] ); } } This approach is said to use parallel arrays. The data for a given copy of the message is spread out across several arrays. If you think of the arrays as laid out in parallel columns— array x in the first column, array y in the second, array color in the third, and array font in the fourth—then the data for the i-th string can be found along the the i-th row. There
- 341. 7.2. PROGRAMMING WITH ARRAYS 325 is nothing wrong with using parallel arrays in this simple example, but it does go against the object-oriented philosophy of keeping related data in one object. If we follow this rule, then we don’t have to imagine the relationship among the data, because all the data for one copy of the message is physically in one place. So, when I wrote the applet, I made a simple class to represent all the data that is needed for one copy of the message: /** * An object of this type holds the position, color, and font * of one copy of the string. */ private static class StringData { int x, y; // The coordinates of the left end of baseline of string. Color color; // The color in which the string is drawn. Font font; // The font that is used to draw the string. } (This class is actually defined as a static nested class in the main applet class.) To store the data for multiple copies of the message, I use an array of type StringData[ ]. The array is declared as an instance variable, with the name stringData: StringData[] stringData; Of course, the value of stringData is null until an actual array is created and assigned to it. This is done in the init() method of the applet with the statement stringData = new StringData[MESSAGE COUNT]; The base type of this array is StringData, which is a class. We say that stringData is an array of objects. This means that the elements of the array are variables of type StringData. Like any object variable, each element of the array can either be null or can hold a reference to an object. (Note that the term “array of objects” is a little misleading, since the objects are not in the array; the array can only contain references to objects). When the stringData array is first created, the value of each element in the array is null. The data needed by the RandomStrings program will be stored in objects of type StringData, but no such objects exist yet. All we have so far is an array of variables that are capable of referring to such objects. I decided to create the StringData objects in the applet’s init method. (It could be done in other places—just so long as we avoid trying to use an object that doesn’t exist. This is important: Remember that a newly created array whose base type is an object type is always filled with null elements. There are no objects in the array until you put them there.) The objects are created with the for loop for (int i = 0; i < MESSAGE COUNT; i++) stringData[i] = new StringData(); For the RandomStrings applet, the idea is to store data for the i-th copy of the message in the variables stringData[i].x, stringData[i].y, stringData[i].color, and stringData[i].font. Make sure that you understand the notation here: stringData[i] refers to an object. That object contains instance variables. The notation stringData[i].x tells the computer: “Find your way to the object that is referred to by stringData[i]. Then go to the instance variable named x in that object.” Variable names can get even more com- plicated than this, so it is important to learn how to read them. Using the array, stringData, the paintComponent() method for the applet could be written
- 342. 326 CHAPTER 7. ARRAYS public void paintComponent(Graphics g) { super.paintComponent(g); // (Fill with background color.) for (int i = 0; i < MESSAGE COUNT; i++) { g.setColor( stringData[i].color ); g.setFont( stringData[i].font ); g.drawString( message, stringData[i].x, stringData[i].y ); } } However, since the for loop is processing every value in the array, an alternative would be to use a for-each loop: public void paintComponent(Graphics g) { super.paintComponent(g); for ( StringData data : stringData) { // Draw a copy of the message in the position, color, // and font stored in data. g.setColor( data.color ); g.setFont( data.font ); g.drawString( message, data.x, data.y ); } } In the loop, the loop control variable, data, holds a copy of one of the values from the array. That value is a reference to an object of type StringData, which has instance variables named color, font, x, and y. Once again, the use of a for-each loop has eliminated the need to work with array indices. There is still the matter of filling the array, data, with random values. If you are interested, you can look at the source code for the applet, RandomStringsWithArray.java. ∗ ∗ ∗ The RandomStrings applet uses one other array of objects. The font for a given copy of the message is chosen at random from a set of five possible fonts. In the original version of the applet, there were five variables of type Font to represent the fonts. The variables were named font1, font2, font3, font4, and font5. To select one of these fonts at random, a switch statement could be used: Font randomFont; // One of the 5 fonts, chosen at random. int rand; // A random integer in the range 0 to 4. rand = (int)(Math.random() * 5); switch (rand) { case 0: randomFont = font1; break; case 1: randomFont = font2; break; case 2: randomFont = font3; break; case 3: randomFont = font4; break; case 4:
- 343. 7.2. PROGRAMMING WITH ARRAYS 327 randomFont = font5; break; } In the new version of the applet, the five fonts are stored in an array, which is named fonts. This array is declared as an instance variable of type Font[ ] Font[] fonts; The array is created in the init() method of the applet, and each element of the array is set to refer to a new Font object: fonts = new Font[5]; // Create the array to hold the five fonts. fonts[0] = new Font("Serif", Font.BOLD, 14); fonts[1] = new Font("SansSerif", Font.BOLD + Font.ITALIC, 24); fonts[2] = new Font("Monospaced", Font.PLAIN, 20); fonts[3] = new Font("Dialog", Font.PLAIN, 30); fonts[4] = new Font("Serif", Font.ITALIC, 36); This makes it much easier to select one of the fonts at random. It can be done with the statements Font randomFont; // One of the 5 fonts, chosen at random. int fontIndex; // A random number in the range 0 to 4. fontIndex = (int)(Math.random() * 5); randomFont = fonts[ fontIndex ]; The switch statement has been replaced by a single line of code. In fact, the preceding four lines could be replaced by the single line: Font randomFont = fonts[ (int)(Math.random() * 5) ]; This is a very typical application of arrays. Note that this example uses the random access property of arrays: We can pick an array index at random and go directly to the array element at that index. Here is another example of the same sort of thing. Months are often stored as numbers 1, 2, 3, . . . , 12. Sometimes, however, these numbers have to be translated into the names January, February, . . . , December. The translation can be done with an array. The array can be declared and initialized as static String[] monthName = { "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" }; If mnth is a variable that holds one of the integers 1 through 12, then monthName[mnth-1] is the name of the corresponding month. We need the “-1” because months are numbered starting from 1, while array elements are numbered starting from 0. Simple array indexing does the translation for us! 7.2.6 Variable Arity Methods Arrays are used in the implementation of one of the new features in Java 5.0. Before version 5.0, every method in Java had a fixed arity. (The arity of a subroutine is defined as the number of parameters in a call to the method.) In a fixed arity method, the number of parameters must be the same in every call to the method. Java 5.0 introduced variable arity methods. In a
- 344. 328 CHAPTER 7. ARRAYS variable arity method, different calls to the method can have different numbers of parameters. For example, the formatted output method System.out.printf, which was introduced in Sub- section 2.4.4, is a variable arity method. The first parameter of System.out.printf must be a String, but it can have any number of additional parameters, of any types. Calling a variable arity method is no different from calling any other sort of method, but writing one requires some new syntax. As an example, consider a method that can compute the average of any number of values of type double. The definition of such a method could begin with: public static double average( double... numbers ) { Here, the ... after the type name, double, indicates that any number of values of type double can be provided when the subroutine is called, so that for example average(1,2,3), average(3.14,2.17), average(0.375), and even average() are all legal calls to this method. Note that actual parameters of type int can be passed to average. The integers will, as usual, be automatically converted to real numbers. When the method is called, the values of all the actual parameters that correspond to the variable arity parameter are placed into an array, and it is this array that is actually passed to the method. That is, in the body of a method, a variable arity parameter of type T actually looks like an ordinary parameter of type T[ ]. The length of the array tells you how many actual parameters were provided in the method call. In the average example, the body of the method would see an array named numbers of type double[ ]. The number of actual parameters in the method call would be numbers.length, and the values of the actual parameters would be numbers[0], numbers[1], and so on. A complete definition of the method would be: public static double average( double... numbers ) { double sum; // The sum of all the actual parameters. double average; // The average of all the actual parameters. sum = 0; for (int i = 0; i < numbers.length; i++) { sum = sum + numbers[i]; // Add one of the actual parameters to the sum. } average = sum / numbers.length; return average; } Note that the “...” can be applied only to the last formal parameter in a method definition. Note also that it is possible to pass an actual array to the method, instead of a list of individual values. For example, if salesData is a variable of type double[ ], then it would be legal to call average(salesData), and this would compute the average of all the numbers in the array. As another example, consider a method that can draw a polygon through any number of points. The points are given as values of type Point, where an object of type Point has two instance variables, x and y, of type int. In this case, the method has one ordinary parameter— the graphics context that will be used to draw the polygon—in addition to the variable arity parameter: public static void drawPolygon(Graphics g, Point... points) { if (points.length > 1) { // (Need at least 2 points to draw anything.) for (int i = 0; i < points.length - 1; i++) { // Draw a line from i-th point to (i+1)-th point g.drawline( points[i].x, points[i].y, points[i+1].x, points[i+1].y ); }
- 345. 7.3. DYNAMIC ARRAYS AND ARRAYLISTS 329 // Now, draw a line back to the starting point. g.drawLine( points[points.length-1].x, points[points.length-1].y, points[0].x, points[0].y ); } } Because of automatic type conversion, a variable arity parameter of type “Object...” can take actual parameters of any type whatsoever. Even primitive type values are allowed, because of autoboxing. (A primitive type value belonging to a type such as int is converted to an object belonging to a “wrapper” class such as Integer. See Subsection 5.3.2.) For example, the method definition for System.out.printf could begin: public void printf(String format, Object... values) { This allows the printf method to output values of any type. Similarly, we could write a method that strings together the string representations of all its parameters into one long string: public static String concat( Object... values ) { String str = ""; // Start with an empty string. for ( Object obj : values ) { // A "for each" loop for processing the values. if (obj == null ) str = str + "null"; // Represent null values by "null". else str = str + obj.toString(); } } 7.3 Dynamic Arrays and ArrayLists The size of an array is fixed when it is created. In many cases, however, the number of data items that are actually stored in the array varies with time. Consider the following examples: An array that stores the lines of text in a word-processing program. An array that holds the list of computers that are currently downloading a page from a Web site. An array that contains the shapes that have been added to the screen by the user of a drawing program. Clearly, we need some way to deal with cases where the number of data items in an array is not fixed. 7.3.1 Partially Full Arrays Consider an application where the number of items that we want to store in an array changes as the program runs. Since the size of the array can’t actually be changed, a separate counter variable must be used to keep track of how many spaces in the array are in use. (Of course, every space in the array has to contain something; the question is, how many spaces contain useful or valid items?) Consider, for example, a program that reads positive integers entered by the user and stores them for later processing. The program stops reading when the user inputs a number that is less than or equal to zero. The input numbers can be kept in an array, numbers, of type int[ ]. Let’s say that no more than 100 numbers will be input. Then the size of the array can be fixed at 100. But the program must keep track of how many numbers have actually been read and stored in the array. For this, it can use an integer variable, numCount. Each time a number is stored in the array, numCount must be incremented by one. As a rather silly example, let’s write a program that will read the numbers input by the user and then print them in reverse
- 346. 330 CHAPTER 7. ARRAYS order. (This is, at least, a processing task that requires that the numbers be saved in an array. Remember that many types of processing, such as finding the sum or average or maximum of the numbers, can be done without saving the individual numbers.) public class ReverseInputNumbers { public static void main(String[] args) { int[] numbers; // An array for storing the input values. int numCount; // The number of numbers saved in the array. int num; // One of the numbers input by the user. numbers = new int[100]; // Space for 100 ints. numCount = 0; // No numbers have been saved yet. TextIO.putln("Enter up to 100 positive integers; enter 0 to end."); while (true) { // Get the numbers and put them in the array. TextIO.put("? "); num = TextIO.getlnInt(); if (num <= 0) break; numbers[numCount] = num; numCount++; } TextIO.putln("nYour numbers in reverse order are:n"); for (int i = numCount - 1; i >= 0; i--) { TextIO.putln( numbers[i] ); } } // end main(); } // end class ReverseInputNumbers It is especially important to note that the variable numCount plays a dual role. It is the number of items that have been entered into the array. But it is also the index of the next available spot in the array. For example, if 4 numbers have been stored in the array, they occupy locations number 0, 1, 2, and 3. The next available spot is location 4. When the time comes to print out the numbers in the array, the last occupied spot in the array is location numCount - 1, so the for loop prints out values starting from location numCount - 1 and going down to 0. Let’s look at another, more realistic example. Suppose that you write a game program, and that players can join the game and leave the game as it progresses. As a good object-oriented programmer, you probably have a class named Player to represent the individual players in the game. A list of all players who are currently in the game could be stored in an array, playerList, of type Player[ ]. Since the number of players can change, you will also need a variable, playerCt, to record the number of players currently in the game. Assuming that there will never be more than 10 players in the game, you could declare the variables as: Player[] playerList = new Player[10]; // Up to 10 players. int playerCt = 0; // At the start, there are no players. After some players have joined the game, playerCt will be greater than 0, and the player objects representing the players will be stored in the array elements playerList[0], playerList[1], . . . , playerList[playerCt-1]. Note that the array element
- 347. 7.3. DYNAMIC ARRAYS AND ARRAYLISTS 331 playerList[playerCt] is not in use. The procedure for adding a new player, newPlayer, to the game is simple: playerList[playerCt] = newPlayer; // Put new player in next // available spot. playerCt++; // And increment playerCt to count the new player. Deleting a player from the game is a little harder, since you don’t want to leave a “hole” in the array. Suppose you want to delete the player at index k in playerList. If you are not worried about keeping the players in any particular order, then one way to do this is to move the player from the last occupied position in the array into position k and then to decrement the value of playerCt: playerList[k] = playerList[playerCt - 1]; playerCt--; The player previously in position k is no longer in the array. The player previously in position playerCt - 1 is now in the array twice. But it’s only in the occupied or valid part of the array once, since playerCt has decreased by one. Remember that every element of the array has to hold some value, but only the values in positions 0 through playerCt - 1 will be looked at or processed in any way. (By the way, you should think about what happens if the player that is being deleted is in the last position in the list. The code does still work in this case. What exactly happens?) Suppose that when deleting the player in position k, you’d like to keep the remaining players in the same order. (Maybe because they take turns in the order in which they are stored in the array.) To do this, all the players in positions k+1 and above must move down one position in the array. Player k+1 replaces player k, who is out of the game. Player k+2 fills the spot left open when player k+1 is moved. And so on. The code for this is for (int i = k+1; i < playerCt; i++) { playerList[i-1] = playerList[i]; } playerCt--; ∗ ∗ ∗ It’s worth emphasizing that the Player example deals with an array whose base type is a class. An item in the array is either null or is a reference to an object belonging to the class, Player. The Player objects themselves are not really stored in the array, only references to them. Note that because of the rules for assignment in Java, the objects can actually belong to subclasses of Player. Thus there could be different classes of players such as computer players, regular human players, players who are wizards, . . . , all represented by different subclasses of Player. As another example, suppose that a class Shape represents the general idea of a shape drawn on a screen, and that it has subclasses to represent specific types of shapes such as lines, rectangles, rounded rectangles, ovals, filled-in ovals, and so forth. (Shape itself would be an abstract class, as discussed in Subsection 5.5.5.) Then an array of type Shape[ ] can hold references to objects belonging to the subclasses of Shape. For example, the situation created by the statements Shape[] shapes = new Shape[100]; // Array to hold up to 100 shapes. shapes[0] = new Rect(); // Put some objects in the array. shapes[1] = new Line(); shapes[2] = new FilledOval(); int shapeCt = 3; // Keep track of number of objects in array.
- 348. 332 CHAPTER 7. ARRAYS could be illustrated as: s h a p e s s h a p e s . l e n g t h s h a p e s [ 0 ] s h a p e s [ 1 ] s h a p e s [ 2 ] s h a p e s [ 3 ] s h a p e s [ 4 ] Such an array would be useful in a drawing program. The array could be used to hold a list of shapes to be displayed. If the Shape class includes a method, “void redraw(Graphics g)”, for drawing the shape in a graphics context g, then all the shapes in the array could be redrawn with a simple for loop: for (int i = 0; i < shapeCt; i++) shapes[i].redraw(g); The statement “shapes[i].redraw(g);” calls the redraw() method belonging to the partic- ular shape at index i in the array. Each object knows how to redraw itself, so that repeated executions of the statement can produce a variety of different shapes on the screen. This is nice example both of polymorphism and of array processing. 7.3.2 Dynamic Arrays In each of the above examples, an arbitrary limit was set on the number of items—100 ints, 10 Players, 100 Shapes. Since the size of an array is fixed, a given array can only hold a certain maximum number of items. In many cases, such an arbitrary limit is undesirable. Why should a program work for 100 data values, but not for 101? The obvious alternative of making an array that’s so big that it will work in any practical case is not usually a good solution to the problem. It means that in most cases, a lot of computer memory will be wasted on unused space in the array. That memory might be better used for something else. And what if someone is using a computer that could handle as many data values as the user actually wants to process, but doesn’t have enough memory to accommodate all the extra space that you’ve allocated for your huge array? Clearly, it would be nice if we could increase the size of an array at will. This is not possible, but what is possible is almost as good. Remember that an array variable does not actually hold an array. It just holds a reference to an array object. We can’t make the array bigger, but we can make a new, bigger array object and change the value of the array variable so that it refers to the bigger array. Of course, we also have to copy the contents of the old array into the new array. The array variable then refers to an array object that contains all the data of the old array, with room for additional data. The old array will be garbage collected, since it is no longer in use. Let’s look back at the game example, in which playerList is an array of type Player[ ] and playerCt is the number of spaces that have been used in the array. Suppose that we don’t want to put a pre-set limit on the number of players. If a new player joins the game and the
- 349. 7.3. DYNAMIC ARRAYS AND ARRAYLISTS 333 current array is full, we just make a new, bigger one. The same variable, playerList, will refer to the new array. Note that after this is done, playerList[0] will refer to a different memory location, but the value stored in playerList[0] will still be the same as it was before. Here is some code that will do this: // Add a new player, even if the current array is full. if (playerCt == playerList.length) { // Array is full. Make a new, bigger array, // copy the contents of the old array into it, // and set playerList to refer to the new array. int newSize = 2 * playerList.length; // Size of new array. Player[] temp = new Player[newSize]; // The new array. System.arraycopy(playerList, 0, temp, 0, playerList.length); playerList = temp; // Set playerList to refer to new array. } // At this point, we KNOW there is room in the array. playerList[playerCt] = newPlayer; // Add the new player... playerCt++; // ...and count it. If we are going to be doing things like this regularly, it would be nice to define a reusable class to handle the details. An array-like object that changes size to accommodate the amount of data that it actually contains is called a dynamic array. A dynamic array supports the same operations as an array: putting a value at a given position and getting the value that is stored at a given position. But there is no upper limit on the positions that can be used (except those imposed by the size of the computer’s memory). In a dynamic array class, the put and get operations must be implemented as instance methods. Here, for example, is a class that implements a dynamic array of ints: /** * An object of type DynamicArrayOfInt acts like an array of int * of unlimited size. The notation A.get(i) must be used instead * of A[i], and A.set(i,v) must be used instead of A[i] = v. */ public class DynamicArrayOfInt { private int[] data; // An array to hold the data. /** * Constructor creates an array with an initial size of 1, * but the array size will be increased whenever a reference * is made to an array position that does not yet exist. */ public DynamicArrayOfInt() { data = new int[1]; } /** * Get the value from the specified position in the array. * Since all array elements are initialized to zero, when the * specified position lies outside the actual physical size * of the data array, a value of 0 is returned. Note that * a negative value of position will still produce an * ArrayIndexOutOfBoundsException.
- 350. 334 CHAPTER 7. ARRAYS */ public int get(int position) { if (position >= data.length) return 0; else return data[position]; } /** * Store the value in the specified position in the array. * The data array will increase in size to include this * position, if necessary. */ public void put(int position, int value) { if (position >= data.length) { // The specified position is outside the actual size of // the data array. Double the size, or if that still does // not include the specified position, set the new size // to 2*position. int newSize = 2 * data.length; if (position >= newSize) newSize = 2 * position; int[] newData = new int[newSize]; System.arraycopy(data, 0, newData, 0, data.length); data = newData; // The following line is for demonstration purposes only !! System.out.println("Size of dynamic array increased to " + newSize); } data[position] = value; } } // end class DynamicArrayOfInt The data in a DynamicArrayOfInt object is actually stored in a regular array, but that array is discarded and replaced by a bigger array whenever necessary. If numbers is a variable of type DynamicArrayOfInt, then the command numbers.put(pos,val) stores the value val at position number pos in the dynamic array. The function numbers.get(pos) returns the value stored at position number pos. The first example in this section used an array to store positive integers input by the user. We can rewrite that example to use a DynamicArrayOfInt. A reference to numbers[i] is replaced by numbers.get(i). The statement “numbers[numCount] = num;” is replaced by “numbers.put(numCount,num);”. Here’s the program: public class ReverseWithDynamicArray { public static void main(String[] args) { DynamicArrayOfInt numbers; // To hold the input numbers. int numCount; // The number of numbers stored in the array. int num; // One of the numbers input by the user. numbers = new DynamicArrayOfInt(); numCount = 0; TextIO.putln("Enter some positive integers; Enter 0 to end"); while (true) { // Get numbers and put them in the dynamic array.
- 351. 7.3. DYNAMIC ARRAYS AND ARRAYLISTS 335 TextIO.put("? "); num = TextIO.getlnInt(); if (num <= 0) break; numbers.put(numCount, num); // Store num in the dynamic array. numCount++; } TextIO.putln("nYour numbers in reverse order are:n"); for (int i = numCount - 1; i >= 0; i--) { TextIO.putln( numbers.get(i) ); // Print the i-th number. } } // end main(); } // end class ReverseWithDynamicArray 7.3.3 ArrrayLists The DynamicArrayOfInt class could be used in any situation where an array of int with no preset limit on the size is needed. However, if we want to store Shapes instead of ints, we would have to define a new class to do it. That class, probably named “DynamicArrayOfShape”, would look exactly the same as the DynamicArrayOfInt class except that everywhere the type “int” appears, it would be replaced by the type “Shape”. Similarly, we could define a DynamicArrayOfDouble class, a DynamicArrayOfPlayer class, and so on. But there is something a little silly about this, since all these classes are close to being identical. It would be nice to be able to write some kind of source code, once and for all, that could be used to generate any of these classes on demand, given the type of value that we want to store. This would be an example of generic programming. Some programming languages, including C++, have had support for generic programming for some time. With version 5.0, Java introduced true generic programming, but even before that it had something that was very similar: One can come close to generic programming in Java by working with data structures that contain elements of type Object. We will first consider the almost-generic programming that has been available in Java from the beginning, and then we will look at the change that was introduced in Java 5.0. A full discussion of generic programming will be given in Chapter 10. In Java, every class is a subclass of the class named Object. This means that every object can be assigned to a variable of type Object. Any object can be put into an array of type Object[ ]. If we defined a DynamicArrayOfObject class, then we could store objects of any type. This is not true generic programming, and it doesn’t apply to the primitive types such as int and double. But it does come close. In fact, there is no need for us to define a DynamicArrayOfObject class. Java already has a standard class named ArrayList that serves much the same purpose. The ArrayList class is in the package java.util, so if you want to use it in a program, you should put the directive “import java.util.ArrayList;” at the beginning of your source code file. The ArrayList class differs from my DynamicArrayOfInt class in that an ArrayList object always has a definite size, and it is illegal to refer to a position in the ArrayList that lies outside its size. In this, an ArrayList is more like a regular array. However, the size of an ArrayList can be increased at will. The ArrayList class defines many instance methods. I’ll describe some of the most useful. Suppose that list is a variable of type ArrayList. Then we have:
- 352. 336 CHAPTER 7. ARRAYS • list.size() — This function returns the current size of the ArrayList. The only valid positions in the list are numbers in the range 0 to list.size()-1. Note that the size can be zero. A call to the default constructor new ArrayList() creates an ArrayList of size zero. • list.add(obj) — Adds an object onto the end of the list, increasing the size by 1. The parameter, obj, can refer to an object of any type, or it can be null. • list.get(N) — This function returns the value stored at position N in the ArrayList. N must be an integer in the range 0 to list.size()-1. If N is outside this range, an error of type IndexOutOfBoundsException occurs. Calling this function is similar to referring to A[N] for an array, A, except that you can’t use list.get(N) on the left side of an assignment statement. • list.set(N, obj) — Assigns the object, obj, to position N in the ArrayList, replacing the item previously stored at position N. The integer N must be in the range from 0 to list.size()-1. A call to this function is equivalent to the command A[N] = obj for an array A. • list.remove(obj) — If the specified object occurs somewhere in the ArrayList, it is removed from the list. Any items in the list that come after the removed item are moved down one position. The size of the ArrayList decreases by 1. If obj occurs more than once in the list, only the first copy is removed. • list.remove(N) — For an integer, N, this removes the N-th item in the ArrayList. N must be in the range 0 to list.size()-1. Any items in the list that come after the removed item are moved down one position. The size of the ArrayList decreases by 1. • list.indexOf(obj) — A function that searches for the object, obj, in the ArrayList. If the object is found in the list, then the position number where it is found is returned. If the object is not found, then -1 is returned. For example, suppose again that players in a game are represented by objects of type Player. The players currently in the game could be stored in an ArrayList named players. This variable would be declared as ArrayList players; and initialized to refer to a new, empty ArrayList object with players = new ArrayList(); If newPlayer is a variable that refers to a Player object, the new player would be added to the ArrayList and to the game by saying players.add(newPlayer); and if player number i leaves the game, it is only necessary to say players.remove(i); Or, if player is a variable that refers to the Player that is to be removed, you could say players.remove(player); All this works very nicely. The only slight difficulty arises when you use the function players.get(i) to get the value stored at position i in the ArrayList. The return type of this function is Object. In this case the object that is returned by the function is actually of type Player. In order to do anything useful with the returned value, it’s usually necessary to type-cast it to type Player:
- 353. 7.3. DYNAMIC ARRAYS AND ARRAYLISTS 337 Player plr = (Player)players.get(i); For example, if the Player class includes an instance method makeMove() that is called to allow a player to make a move in the game, then the code for letting every player make a move is for (int i = 0; i < players.size(); i++) { Player plr = (Player)players.get(i); plr.makeMove(); } The two lines inside the for loop can be combined to a single line: ((Player)players.get(i)).makeMove(); This gets an item from the list, type-casts it, and then calls the makeMove() method on the resulting Player. The parentheses around “(Player)players.get(i)” are required because of Java’s precedence rules. The parentheses force the type-cast to be performed before the makeMove() method is called. For-each loops work for ArrayLists just as they do for arrays. But note that since the items in an ArrayList are only known to be Objects, the type of the loop control variable must be Object. For example, the for loop used above to let each Player make a move could be written as the for-each loop for ( Object plrObj : players ) { Player plr = (Player)plrObj; plr.makeMove(); } In the body of the loop, the value of the loop control variable, plrObj, is one of the objects from the list, players. This object must be type-cast to type Player before it can be used. ∗ ∗ ∗ In Subsection 5.5.5, I discussed a program, ShapeDraw, that uses ArrayLists. Here is another version of the same idea, simplified to make it easier to see how ArrayList is being used. The program supports the following operations: Click the large white drawing area to add a colored rectangle. (The color of the rectangle is given by a “rainbow palette” along the bottom of the applet; click the palette to select a new color.) Drag rectangles using the right mouse button. Hold down the Alt key and click on a rectangle to delete it. Shift-click a rectangle to move it out in front of all the other rectangles. You can try an applet version of the program in the on-line version of this section. Source code for the main panel for this program can be found in SimpleDrawRects.java. You should be able to follow the source code in its entirety. (You can also take a look at the file RainbowPalette.java, which defines the color palette shown at the bottom of the applet, if you like.) Here, I just want to look at the parts of the program that use an ArrayList. The applet uses a variable named rects, of type ArrayList, to hold information about the rectangles that have been added to the drawing area. The objects that are stored in the list belong to a static nested class, ColoredRect, that is defined as /** * An object of type ColoredRect holds the data for one colored rectangle. */ private static class ColoredRect { int x,y; // Upper left corner of the rectangle. int width,height; // Size of the rectangle. Color color; // Color of the rectangle. }
- 354. 338 CHAPTER 7. ARRAYS If g is a variable of type Graphics, then the following code draws all the rectangles that are stored in the list rects (with a black outline around each rectangle): for (int i = 0; i < rects.size(); i++) { ColoredRect rect = (ColoredRect)rects.get(i); g.setColor( rect.color ); g.fillRect( rect.x, rect.y, rect.width, rect.height); g.setColor( Color.BLACK ); g.drawRect( rect.x, rect.y, rect.width - 1, rect.height - 1); } The i-th rectangle in the list is obtained by calling rects.get(i). Since this method returns a value of type Object, the return value must be typecast to its actual type, ColoredRect, to get access to the data that it contains. To implement the mouse operations, it must be possible to find the rectangle, if any, that contains the point where the user clicked the mouse. To do this, I wrote the function /** * Find the topmost rect that contains the point (x,y). Return null * if no rect contains that point. The rects in the ArrayList are * considered in reverse order so that if one lies on top of another, * the one on top is seen first and is returned. */ ColoredRect findRect(int x, int y) { for (int i = rects.size() - 1; i >= 0; i--) { ColoredRect rect = (ColoredRect)rects.get(i); if ( x >= rect.x && x < rect.x + rect.width && y >= rect.y && y < rect.y + rect.height ) return rect; // (x,y) is inside this rect. } return null; // No rect containing (x,y) was found. } The code for removing a ColoredRect, rect, from the drawing area is simply rects.remove(rect) (followed by a repaint()). Bringing a given rectangle out in front of all the other rectangles is just a little harder. Since the rectangles are drawn in the order in which they occur in the ArrayList, the rectangle that is in the last position in the list is in front of all the other rectangles on the screen. So we need to move the selected rectangle to the last position in the list. This can most easily be done in a slightly tricky way using built-in ArrayList operations: The rectangle is simply removed from its current position in the list and then adding back at the end of the list: void bringToFront(ColoredRect rect) { if (rect != null) { rects.remove(rect); // Remove rect from the list. rects.add(rect); // Add it back; it will be placed in the last position. repaint(); } } This should be enough to give you the basic idea. You can look in the source code for more details.
- 355. 7.3. DYNAMIC ARRAYS AND ARRAYLISTS 339 7.3.4 Parameterized Types The main difference between true generic programming and the ArrayList examples in the previous subsection is the use of the type Object as the basic type for objects that are stored in a list. This has at least two unfortunate consequences: First, it makes it necessary to use type-casting in almost every case when an element is retrieved from that list. Second, since any type of object can legally be added to the list, there is no way for the compiler to detect an attempt to add the wrong type of object to the list; the error will be detected only at run time when the object is retrieved from the list and the attempt to type-cast the object fails. Compare this to arrays. An array of type BaseType[ ] can only hold objects of type BaseType. An attempt to store an object of the wrong type in the array will be detected by the compiler, and there is no need to type-cast items that are retrieved from the array back to type BaseType. To address this problem, Java 5.0 introduced parameterized types. ArrayList is an ex- ample: Instead of using the plain “ArrayList” type, it is possible to use ArrayList<BaseType>, where BaseType is any object type, that is, the name of a class or of an interface. (BaseType cannot be one of the primitive types.) ArrayList<BaseType> can be used to create lists that can hold only objects of type BaseType. For example, ArrayList<ColoredRect> rects; declares a variable named rects of type ArrayList<ColoredRect>, and rects = new ArrayList<ColoredRect>(); sets rects to refer to a newly created list that can only hold objects belonging to the class ColoredRect (or to a subclass). The funny-looking name “ArrayList<ColoredRect>” is being used here in exactly the same way as an ordinary class name—don’t let the “<ColoredRect>” confuse you; it’s just part of the name of the type. When a statement such as rects.add(x); occurs in the program, the compiler can check whether x is in fact of type ColoredRect. If not, the compiler will report a syntax error. When an object is retrieve from the list, the compiler knows that the object must be of type ColoredRect, so no type-cast is necessary. You can say simply: ColoredRect rect = rects.get(i) You can even refer directly to an instance variable in the object, such as rects.get(i).color. This makes using ArrayList<ColoredRect> very similar to using ColoredRect[ ] with the added advantage that the list can grow to any size. Note that if a for-each loop is used to process the items in rects, the type of the loop control variable can be ColoredRect, and no type-cast is necessary. For example, when using ArrayList<ColoredRect> as the type for the list rects, the code for drawing all the rectangles in the list could be rewritten as: for ( ColoredRect rect : rects ) { g.setColor( rect.color ); g.fillRect( rect.x, rect.y, rect.width, rect.height); g.setColor( Color.BLACK ); g.drawRect( rect.x, rect.y, rect.width - 1, rect.height - 1); } You can use ArrayList<ColoredRect> anyplace where you could use a normal type: to declare variables, as the type of a formal parameter in a subroutine, or as the return type of a subroutine. You can even create a subclass of ArrayList<ColoredRect>! (Nevertheless, technically speaking, ArrayList<ColoredRect> is not considered to be a separate class from ArrayList. An object of
- 356. 340 CHAPTER 7. ARRAYS type ArrayList<ColoredRect> actually belongs to the class ArrayList, but the compiler restricts the type of objects that can be added to the list.) The only drawback to using parameterized types is that the base type cannot be a primitive type. For example, there is no such thing as “ArrayList<int>”. However, this is not such a big drawback as it might seem at first, because of the “wrapper types” and “autoboxing” that were introduced in Subsection 5.3.2. A wrapper type such as Double or Integer can be used as a base type for a parameterized type. An object of type ArrayList<Double> can hold objects of type Double. Since each object of type Double holds a value of type double, it’s almost like having a list of doubles. If numlist is declared to be of type ArrayList<Double> and if x is of type double, then the value of x can be added to the list by saying: numlist.add( new Double(x) ); Furthermore, because of autoboxing, the compiler will automatically do double-to-Double and Double-to-double type conversions when necessary. This means that the compiler will treat “numlist.add(x)” as begin equivalent to “numlist.add( new Double(x) )”. So, behind the scenes, “numlist.add(x)” is actually adding an object to the list, but it looks a lot as if you are working with a list of doubles. ∗ ∗ ∗ The sample program SimplePaint2.java demonstrates the use of parameterized types. In this program, the user can sketch curves in a drawing area by clicking and dragging with the mouse. The curves can be of any color, and the user can select the drawing color using a menu. The background color of the drawing area can also be selected using a menu. And there is a “Control” menu that contains several commands: An “Undo” command, which removes the most recently drawn curve from the screen, a “Clear” command that removes all the curves, and a “Use Symmetry” command that turns a symmetry feature on and off. Curves that are drawn by the user when the symmetry option is on are reflected horizontally and vertically to produce a symmetric pattern. You can try an applet version of the program in the on-line version of this section. Unlike the original SimplePaint program in Subsection 6.4.4, this new version uses a data structure to store information about the picture that has been drawn by the user. This data is used in the paintComponent() method to redraw the picture whenever necessary. Thus, the picture doesn’t disappear when, for example, the picture is covered and then uncovered. The data structure is implemented using ArrayLists. The main data for a curve consists of a list of the points on the curve. This data can be stored in an object of type ArrayList<Point>, where java.awt.Point is one of Java’s standard classes. (A Point object contains two public integer variables x and y that represent the coordinates of a point.) However, to redraw the curve, we also need to know its color, and we need to know whether the symmetry option should be applied to the curve. All the data that is needed to redraw the curve can be grouped into an object of type CurveData that is defined as private static class CurveData { Color color; // The color of the curve. boolean symmetric; // Are horizontal and vertical reflections also drawn? ArrayList<Point> points; // The points on the curve. } However, a picture can contain many curves, not just one, so to store all the data necessary to redraw the entire picture, we need a list of objects of type CurveData. For this list, we can use a variable curves declared as
- 357. 7.3. DYNAMIC ARRAYS AND ARRAYLISTS 341 ArrayList<CurveData> curves = new ArrayList<CurveData>(); Here we have a list of objects, where each object contains a list of points as part of its data! Let’s look at a few examples of processing this data structure. When the user clicks the mouse on the drawing surface, it’s the start of a new curve, and a new CurveData object must be created and added to the list of curves. The instance variables in the new CurveData object must also be initialized. Here is the code from the mousePressed() routine that does this: currentCurve = new CurveData(); // Create a new CurveData object. currentCurve.color = currentColor; // The color of the curve is taken from an // instance variable that represents the // currently selected drawing color. currentCurve.symmetric = useSymmetry; // The "symmetric" property of the curve // is also copied from the current value // of an instance variable, useSymmetry. currentCurve.points = new ArrayList<Point>(); // Create a new point list object. currentCurve.points.add( new Point(evt.getX(), evt.getY()) ); // The point where the user pressed the mouse is the first point on // the curve. A new Point object is created to hold the coordinates // of that point and is added to the list of points for the curve. curves.add(currentCurve); // Add the CurveData object to the list of curves. As the user drags the mouse, new points are added to currentCurve, and repaint() is called. When the picture is redrawn, the new point will be part of the picture. The paintComponent() method has to use the data in curves to draw all the curves. The basic structure is a for-each loop that processes the data for each individual curve in turn. This has the form: for ( CurveData curve : curves ) { . . // Draw the curve represented by the object, curve, of type CurveData. . } In the body of this loop, curve.points is a variable of type ArrayList<Point> that holds the list of points on the curve. The i-th point on the curve can be obtained by calling the get() method of this list: curve.points.get(i). This returns a value of type Point which contains instance variables named x and y. We can refer directly to the x-coordinate of the i-th point as: curve.points.get(i).x This might seem rather complicated, but it’s a nice example of a complex name that specifies a path to a desired piece of data: Go to the object, curve. Inside curve, go to points. Inside points, get the i-th item. And from that item, get the instance variable named x. Here is the complete definition of the paintCompontent() method: public void paintComponent(Graphics g) { super.paintComponent(g); for ( CurveData curve : curves) { g.setColor(curve.color); for (int i = 1; i < curve.points.size(); i++) {
- 358. 342 CHAPTER 7. ARRAYS // Draw a line segment from point number i-1 to point number i. int x1 = curve.points.get(i-1).x; int y1 = curve.points.get(i-1).y; int x2 = curve.points.get(i).x; int y2 = curve.points.get(i).y; g.drawLine(x1,y1,x2,y2); if (curve.symmetric) { // Also draw the horizontal and vertical reflections // of the line segment. int w = getWidth(); int h = getHeight(); g.drawLine(w-x1,y1,w-x2,y2); g.drawLine(x1,h-y1,x2,h-y2); g.drawLine(w-x1,h-y1,w-x2,h-y2); } } } } // end paintComponent() I encourage you to read the full source code, SimplePaint2.java. In addition to serving as an example of using parameterized types, it also serves an another example of creating and using menus. 7.3.5 Vectors The ArrayList class was introduced in Java version 1.2, as one of a group of classes designed for working with collections of objects. We’ll look at these “collection classes” in Chapter 10. Early versions of Java did not include ArrayList, but they did have a very similar class named java.util.Vector. You can still see Vectors used in older code and in many of Java’s standard classes, so it’s worth knowing about them. Using a Vector is similar to using an ArrayList, except that different names are used for some commonly used instance methods, and some instance methods in one class don’t correspond to any instance method in the other class. Like an ArrayList, a Vector is similar to an array of Objects that can grow to be as large as necessary. The default constructor, new Vector(), creates a vector with no elements. Suppose that vec is a Vector. Then we have: • vec.size() — a function that returns the number of elements currently in the vector. • vec.elementAt(N) — returns the N-th element of the vector, for an integer N. N must be in the range 0 to vec.size()-1. This is the same as get(N) for an ArrayList. • vec.setElementAt(obj,N) — sets the N-th element in the vector to be obj. N must be in the range 0 to vec.size()-1. This is the same as set(N,obj) for an ArrayList. • vec.addElement(obj) — adds the Object, obj, to the end of the vector. This is the same as the add() method of an ArrayList. • vec.removeElement(obj) — removes obj from the vector, if it occurs. Only the first occurrence is removed. This is the same as remove(obj) for an ArrayList. • vec.removeElementAt(N) — removes the N-th element, for an integer N. N must be in the range 0 to vec.size()-1. This is the same as remove(N) for an ArrayList. • vec.setSize(N) — sets the size of the vector to N. If there were more than N elements in vec, the extra elements are removed. If there were fewer than N elements, extra spaces are filled with null. The ArrayList class, unfortunately, does not have a setSize() method.
- 359. 7.4. SEARCHING AND SORTING 343 The Vector class includes many more methods, but these are probably the most commonly used. Note that in Java 5.0, Vector can be used as a paramaterized type in exactly the same way as ArrayList. That is, if BaseType is any class or interface name, then Vector<BaseType> represents vectors that can hold only objects of type BaseType. 7.4 Searching and Sorting Two array processing techniques that are particularly common are searching and sort- ing. Searching here refers to finding an item in the array that meets some specified criterion. Sorting refers to rearranging all the items in the array into increasing or decreasing order (where the meaning of increasing and decreasing can depend on the context). Sorting and searching are often discussed, in a theoretical sort of way, using an array of numbers as an example. In practical situations, though, more interesting types of data are usually involved. For example, the array might be a mailing list, and each element of the array might be an object containing a name and address. Given the name of a person, you might want to look up that person’s address. This is an example of searching, since you want to find the object in the array that contains the given name. It would also be useful to be able to sort the array according to various criteria. One example of sorting would be ordering the elements of the array so that the names are in alphabetical order. Another example would be to order the elements of the array according to zip code before printing a set of mailing labels. (This kind of sorting can get you a cheaper postage rate on a large mailing.) This example can be generalized to a more abstract situation in which we have an array that contains objects, and we want to search or sort the array based on the value of one of the instance variables in that array. We can use some terminology here that originated in work with “databases,” which are just large, organized collections of data. We refer to each of the objects in the array as a record. The instance variables in an object are then called fields of the record. In the mailing list example, each record would contain a name and address. The fields of the record might be the first name, last name, street address, state, city and zip code. For the purpose of searching or sorting, one of the fields is designated to be the key field. Searching then means finding a record in the array that has a specified value in its key field. Sorting means moving the records around in the array so that the key fields of the record are in increasing (or decreasing) order. In this section, most of my examples follow the tradition of using arrays of numbers. But I’ll also give a few examples using records and keys, to remind you of the more practical applications. 7.4.1 Searching There is an obvious algorithm for searching for a particular item in an array: Look at each item in the array in turn, and check whether that item is the one you are looking for. If so, the search is finished. If you look at every item without finding the one you want, then you can be sure that the item is not in the array. It’s easy to write a subroutine to implement this algorithm. Let’s say the array that you want to search is an array of ints. Here is a method that will search the array for a specified integer. If the integer is found, the method returns the index of the location in the array where it is found. If the integer is not in the array, the method returns the value -1 as a signal that the integer could not be found: /**
- 360. 344 CHAPTER 7. ARRAYS * Searches the array A for the integer N. If N is not in the array, * then -1 is returned. If N is in the array, then return value is * the first integer i that satisfies A[i] == N. */ static int find(int[] A, int N) { for (int index = 0; index < A.length; index++) { if ( A[index] == N ) return index; // N has been found at this index! } // If we get this far, then N has not been found // anywhere in the array. Return a value of -1. return -1; } This method of searching an array by looking at each item in turn is called linear search. If nothing is known about the order of the items in the array, then there is really no better alternative algorithm. But if the elements in the array are known to be in increasing or decreas- ing order, then a much faster search algorithm can be used. An array in which the elements are in order is said to be sorted. Of course, it takes some work to sort an array, but if the array is to be searched many times, then the work done in sorting it can really pay off. Binary search is a method for searching for a given item in a sorted array. Although the implementation is not trivial, the basic idea is simple: If you are searching for an item in a sorted list, then it is possible to eliminate half of the items in the list by inspecting a single item. For example, suppose that you are looking for the number 42 in a sorted array of 1000 integers. Let’s assume that the array is sorted into increasing order. Suppose you check item number 500 in the array, and find that the item is 93. Since 42 is less than 93, and since the elements in the array are in increasing order, we can conclude that if 42 occurs in the array at all, then it must occur somewhere before location 500. All the locations numbered 500 or above contain values that are greater than or equal to 93. These locations can be eliminated as possible locations of the number 42. The next obvious step is to check location 250. If the number at that location is, say, -21, then you can eliminate locations before 250 and limit further search to locations between 251 and 499. The next test will limit the search to about 125 locations, and the one after that to about 62. After just 10 steps, there is only one location left. This is a whole lot better than looking through every element in the array. If there were a million items, it would still take only 20 steps for binary search to search the array! (Mathematically, the number of steps is approximately equal to the logarithm, in the base 2, of the number of items in the array.) In order to make binary search into a Java subroutine that searches an array A for an item N, we just have to keep track of the range of locations that could possibly contain N. At each step, as we eliminate possibilities, we reduce the size of this range. The basic operation is to look at the item in the middle of the range. If this item is greater than N, then the second half of the range can be eliminated. If it is less than N, then the first half of the range can be eliminated. If the number in the middle just happens to be N exactly, then the search is finished. If the size of the range decreases to zero, then the number N does not occur in the array. Here is a subroutine that returns the location of N in a sorted array A. If N cannot be found in the array, then a value of -1 is returned instead: /**
- 361. 7.4. SEARCHING AND SORTING 345 * Searches the array A for the integer N. * Precondition: A must be sorted into increasing order. * Postcondition: If N is in the array, then the return value, i, * satisfies A[i] == N. If N is not in the array, then the * return value is -1. */ static int binarySearch(int[] A, int N) { int lowestPossibleLoc = 0; int highestPossibleLoc = A.length - 1; while (highestPossibleLoc >= lowestPossibleLoc) { int middle = (lowestPossibleLoc + highestPossibleLoc) / 2; if (A[middle] == N) { // N has been found at this index! return middle; } else if (A[middle] > N) { // eliminate locations >= middle highestPossibleLoc = middle - 1; } else { // eliminate locations <= middle lowestPossibleLoc = middle + 1; } } // At this point, highestPossibleLoc < LowestPossibleLoc, // which means that N is known to be not in the array. Return // a -1 to indicate that N could not be found in the array. return -1; } 7.4.2 Association Lists One particularly common application of searching is with association lists. The standard example of an association list is a dictionary. A dictionary associates definitions with words. Given a word, you can use the dictionary to look up its definition. We can think of the dictionary as being a list of pairs of the form (w,d), where w is a word and d is its definition. A general association list is a list of pairs (k,v), where k is some “key” value, and v is a value associated to that key. In general, we want to assume that no two pairs in the list have the same key. There are two basic operations on association lists: Given a key, k, find the value v associated with k, if any. And given a key, k, and a value v, add the pair (k,v) to the association list (replacing the pair, if any, that had the same key value). The two operations are usually called get and put. Association lists are very widely used in computer science. For example, a compiler has to keep track of the location in memory associated with each variable. It can do this with an association list in which each key is a variable name and the associated value is the address of that variable in memory. Another example would be a mailing list, if we think of it as associating an address to each name on the list. As a related example, consider a phone directory that
- 362. 346 CHAPTER 7. ARRAYS associates a phone number to each name. The items in the list could be objects belonging to the class: class PhoneEntry { String name; String phoneNum; } The data for a phone directory consists of an array of type PhoneEntry[ ] and an integer variable to keep track of how many entries are actually stored in the directory. The technique of “dynamic arrays” (Subsection 7.3.2) can be used in order to avoid putting an arbitrary limit on the number of entries that the phone directory can hold. Using an ArrayList would be another possibility. A PhoneDirectory class should include instance methods that implement the “get” and “put” operations. Here is one possible simple definition of the class: /** * A PhoneDirectory holds a list of names with a phone number for * each name. It is possible to find the number associated with * a given name, and to specify the phone number for a given name. */ public class PhoneDirectory { /** * An object of type PhoneEntry holds one name/number pair. */ private static class PhoneEntry { String name; // The name. String number; // The associated phone number. } private PhoneEntry[] data; // Array that holds the name/number pairs. private int dataCount; // The number of pairs stored in the array. /** * Constructor creates an initially empty directory. */ public PhoneDirectory() { data = new PhoneEntry[1]; dataCount = 0; } /** * Looks for a name/number pair with a given name. If found, the index * of the pair in the data array is returned. If no pair contains the * given name, then the return value is -1. */ private int find( String name ) { for (int i = 0; i < dataCount; i++) { if (data[i].name.equals(name)) return i; // The name has been found in position i. } return -1; // The name does not exist in the array. } /** * Finds the phone number, if any, for a given name.
- 363. 7.4. SEARCHING AND SORTING 347 * @return The phone number associated with the name; if the name does * not occur in the phone directory, then the return value is null. */ public String getNumber( String name ) { int position = find(name); if (position == -1) return null; // There is no phone entry for the given name. else return data[position].number; } /** * Associates a given name with a given phone number. If the name * already exists in the phone directory, then the new number replaces * the old one. Otherwise, a new name/number pair is added. The * name and number should both be non-null. An IllegalArgumentException * is thrown if this is not the case. */ public void putNumber( String name, String number ) { if (name == null || number == null) throw new IllegalArgumentException("name and number cannot be null"); int i = find(name); if (i >= 0) { // The name already exists, in position i in the array. // Just replace the old number at that position with the new. data[i].number = number; } else { // Add a new name/number pair to the array. If the array is // already full, first create a new, larger array. if (dataCount == data.length) { PhoneEntry[] newData = new PhoneEntry[ 2*data.length ]; System.arraycopy(newData,0,data,0,dataCount); data = newData; } PhoneEntry newEntry = new PhoneEntry(); // Create a new pair. newEntry.name = name; newEntry.number = number; data[dataCount] = newEntry; // Add the new pair to the array. dataCount++; } } } // end class PhoneDirectory The class defines a private instance method, find(), that uses linear search to find the position of a given name in the array of name/number pairs. The find() method is used both in the getNumber() method and in the putNumber() method. Note in particular that putNumber(name,number) has to check whether the name is in the phone directory. If so, it just changes the number in the existing entry; if not, it has to create a new phone entry and add it to the array. This class could use a lot of improvement. For one thing, it would be nice to use binary search instead of simple linear search in the getNumber method. However, we could only do that if the list of PhoneEntries were sorted into alphabetical order according to name. In fact,
- 364. 348 CHAPTER 7. ARRAYS it’s really not all that hard to keep the list of entries in sorted order, as you’ll see in the next subsection. 7.4.3 Insertion Sort We’ve seen that there are good reasons for sorting arrays. There are many algorithms available for doing so. One of the easiest to understand is the insertion sort algorithm. This method is also applicable to the problem of keeping a list in sorted order as you add new items to the list. Let’s consider that case first: Suppose you have a sorted list and you want to add an item to that list. If you want to make sure that the modified list is still sorted, then the item must be inserted into the right location, with all the smaller items coming before it and all the bigger items after it. This will mean moving each of the bigger items up one space to make room for the new item. /* * Precondition: itemsInArray is the number of items that are * stored in A. These items must be in increasing order * (A[0] <= A[1] <= ... <= A[itemsInArray-1]). * The array size is at least one greater than itemsInArray. * Postcondition: The number of items has increased by one, * newItem has been added to the array, and all the items * in the array are still in increasing order. * Note: To complete the process of inserting an item in the * array, the variable that counts the number of items * in the array must be incremented, after calling this * subroutine. */ static void insert(int[] A, int itemsInArray, int newItem) { int loc = itemsInArray - 1; // Start at the end of the array. /* Move items bigger than newItem up one space; Stop when a smaller item is encountered or when the beginning of the array (loc == 0) is reached. */ while (loc >= 0 && A[loc] > newItem) { A[loc + 1] = A[loc]; // Bump item from A[loc] up to loc+1. loc = loc - 1; // Go on to next location. } A[loc + 1] = newItem; // Put newItem in last vacated space. } Conceptually, this could be extended to a sorting method if we were to take all the items out of an unsorted array, and then insert them back into the array one-by-one, keeping the list in sorted order as we do so. Each insertion can be done using the insert routine given above. In the actual algorithm, we don’t really take all the items from the array; we just remember what part of the array has been sorted: static void insertionSort(int[] A) { // Sort the array A into increasing order. int itemsSorted; // Number of items that have been sorted so far. for (itemsSorted = 1; itemsSorted < A.length; itemsSorted++) {
- 365. 7.4. SEARCHING AND SORTING 349 // Assume that items A[0], A[1], ... A[itemsSorted-1] // have already been sorted. Insert A[itemsSorted] // into the sorted part of the list. int temp = A[itemsSorted]; // The item to be inserted. int loc = itemsSorted - 1; // Start at end of list. while (loc >= 0 && A[loc] > temp) { A[loc + 1] = A[loc]; // Bump item from A[loc] up to loc+1. loc = loc - 1; // Go on to next location. } A[loc + 1] = temp; // Put temp in last vacated space. } } The following is an illustration of one stage in insertion sort. It shows what happens during one execution of the for loop in the above method, when itemsSorted is 5: S t a r t w i t h a p a r t i a l l y s o r t e d l i s t o f i t e m s : S o r t e d I t e m s I t e m s s t i l l t o b e s o r t e d S o r t e d I t e m s I t e m s s t i l l t o b e s o r t e d T e m p : T e m p : C o p y n e x t u n s o r t e d i t e m i n t o T e m p , l e a v i n g a " h o l e " i n t h e a r r a y . M o v e i t e m s i n s o r t e d p a r t o f a r r a y t o m a k e r o o m f o r T e m p . N o w , t h e s o r t e d p a r t o f t h e l i s t h a s i n c r e a s e d i n s i z e b y o n e i t e m . 7.4.4 Selection Sort Another typical sorting method uses the idea of finding the biggest item in the list and moving it to the end—which is where it belongs if the list is to be in increasing order. Once the biggest item is in its correct location, you can then apply the same idea to the remaining items. That is, find the next-biggest item, and move it into the next-to-last space, and so forth. This algorithm is called selection sort. It’s easy to write:
- 366. 350 CHAPTER 7. ARRAYS static void selectionSort(int[] A) { // Sort A into increasing order, using selection sort for (int lastPlace = A.length-1; lastPlace > 0; lastPlace--) { // Find the largest item among A[0], A[1], ..., // A[lastPlace], and move it into position lastPlace // by swapping it with the number that is currently // in position lastPlace. int maxLoc = 0; // Location of largest item seen so far. for (int j = 1; j <= lastPlace; j++) { if (A[j] > A[maxLoc]) { // Since A[j] is bigger than the maximum we’ve seen // so far, j is the new location of the maximum value // we’ve seen so far. maxLoc = j; } } int temp = A[maxLoc]; // Swap largest item with A[lastPlace]. A[maxLoc] = A[lastPlace]; A[lastPlace] = temp; } // end of for loop } Insertion sort and selection sort are suitable for sorting fairly small arrays (up to a few hun- dred elements, say). There are more complicated sorting algorithms that are much faster than insertion sort and selection sort for large arrays. I’ll discuss one such algorithm in Chapter 9. ∗ ∗ ∗ A variation of selection sort is used in the Hand class that was introduced in Subsection 5.4.1. (By the way, you are finally in a position to fully understand the source code for both the Hand class and the Deck class from that section. See the source files Deck.java and Hand.java.) In the Hand class, a hand of playing cards is represented by a Vector. This is older code, which used Vector instead of ArrayList, and I have chosen not to modify it so that you would see at least one example of using Vectors. See Subsection 7.3.5 for a discussion of Vectors. The objects stored in the Vector are of type Card. A Card object contains instance methods getSuit() and getValue() that can be used to determine the suit and value of the card. In my sorting method, I actually create a new vector and move the cards one-by-one from the old vector to the new vector. The cards are selected from the old vector in increasing order. In the end, the new vector becomes the hand and the old vector is discarded. This is certainly not the most efficient procedure! But hands of cards are so small that the inefficiency is negligible. Here is the code for sorting cards by suit: /** * Sorts the cards in the hand so that cards of the same suit are * grouped together, and within a suit the cards are sorted by value. * Note that aces are considered to have the lowest value, 1. */ public void sortBySuit() { Vector newHand = new Vector(); while (hand.size() > 0) {
- 367. 7.4. SEARCHING AND SORTING 351 int pos = 0; // Position of minimal card found so far. Card c = (Card)hand.elementAt(0); // The minimal card. for (int i = 1; i < hand.size(); i++) { Card c1 = (Card)hand.elementAt(i); if ( c1.getSuit() < c.getSuit() || (c1.getSuit() == c.getSuit() && c1.getValue() < c.getValue()) ) { pos = i; c = c1; } } hand.removeElementAt(pos); newHand.addElement(c); } hand = newHand; } This example illustrates the fact that comparing items in a list is not usually as simple as using the operator “<”. In this case, we consider one card to be less than another if the suit of the first card is less than the suit of the second, and also if the suits are the same and the value of the second card is less than the value of the first. The second part of this test ensures that cards with the same suit will end up sorted by value. Sorting a list of Strings raises a similar problem: the “<” operator is not defined for strings. However, the String class does define a compareTo method. If str1 and str2 are of type String, then str1.compareTo(str2) returns an int that is 0 when str1 is equal to str2, is less than 0 when str1 preceeds str2, and is greater than 0 when str1 follows str2. The definition of “succeeds” and “follows” for strings uses what is called lexicographic ordering, which is based on the Unicode values of the characters in the strings. Lexicographic ordering is not the same as alphabetical ordering, even for strings that consist entirely of letters (because in lexicographic ordering, all the upper case letters come before all the lower case letters). However, for words consisting strictly of the 26 lower case letters in the English alphabet, lexicographic and alphabetic ordering are the same. Thus, if str1 and str2 are strings containing only letters from the English alphabet, then the test str1.toLowerCase().compareTo(str2.toLowerCase()) < 0 is true if and only if str1 comes before str2 in alphabetical order. 7.4.5 Unsorting I can’t resist ending this section on sorting with a related problem that is much less common, but is a bit more fun. That is the problem of putting the elements of an array into a random order. The typical case of this problem is shuffling a deck of cards. A good algorithm for shuffling is similar to selection sort, except that instead of moving the biggest item to the end of the list, an item is selected at random and moved to the end of the list. Here is a subroutine to shuffle an array of ints: /** * Postcondition: The items in A have been rearranged into a random order. */ static void shuffle(int[] A) {
- 368. 352 CHAPTER 7. ARRAYS for (int lastPlace = A.length-1; lastPlace > 0; lastPlace--) { // Choose a random location from among 0,1,...,lastPlace. int randLoc = (int)(Math.random()*(lastPlace+1)); // Swap items in locations randLoc and lastPlace. int temp = A[randLoc]; A[randLoc] = A[lastPlace]; A[lastPlace] = temp; } } 7.5 Multi-dimensional Arrays Any type can be used as the base type of an array. You can have an array of ints, an array of Strings, an array of Objects, and so on. In particular, since an array type is a first-class Java type, you can have an array of arrays. For example, an array of ints has type int[ ]. This means that there is automatically another type, int[ ][ ], which represents an “array of arrays of ints”. Such an array is said to be a two-dimensional array. Of course once you have the type int[ ][ ], there is nothing to stop you from forming the type int[ ][ ][ ], which represents a three-dimensional array—and so on. There is no limit on the number of dimensions that an array type can have. However, arrays of dimension three or higher are fairly uncommon, and I concentrate here mainly on two-dimensional arrays. The type BaseType[ ][ ] is usually read “two-dimensional array of BaseType” or “BaseType array array”. 7.5.1 Creating Two-dimensional Arrays The declaration statement “int[][] A;” declares a variable named A of type int[ ][ ]. This variable can hold a reference to an object of type int[ ][ ]. The assignment statement “A = new int[3][4];” creates a new two-dimensional array object and sets A to point to the newly cre- ated object. As usual, the declaration and assignment could be combined in a single declaration statement “int[][] A = new int[3][4];”. The newly created object is an array of arrays- of-ints. The notation int[3][4] indicates that there are 3 arrays-of-ints in the array A, and that there are 4 ints in each array-of-ints. However, trying to think in such terms can get a bit confusing—as you might have already noticed. So it is customary to think of a two-dimensional array of items as a rectangular grid or matrix of items. The notation “new int[3][4]” can then be taken to describe a grid of ints with 3 rows and 4 columns. The following picture might help:
- 369. 7.5. MULTI-DIMENSIONAL ARRAYS 353 1 0 1 2 ! 1 7 ! 3 2 5 ! 5 ! 2 2 ! 9 For the most part, you can ignore the reality and keep the picture of a grid in mind. Sometimes, though, you will need to remember that each row in the grid is really an array in itself. These arrays can be referred to as A[0], A[1], and A[2]. Each row is in fact a value of type int[ ]. It could, for example, be passed to a subroutine that asks for a parameter of type int[ ]. The notation A[1] refers to one of the rows of the array A. Since A[1] is itself an array of ints, you can use another subscript to refer to one of the positions in that row. For example, A[1][3] refers to item number 3 in row number 1. Keep in mind, of course, that both rows and columns are numbered starting from zero. So, in the above example, A[1][3] is 5. More generally, A[i][j] refers to the grid position in row number i and column number j. The 12 items in A are named as follows: A[0][0] A[0][1] A[0][2] A[0][3] A[1][0] A[1][1] A[1][2] A[1][3] A[2][0] A[2][1] A[2][2] A[2][3] A[i][j] is actually a variable of type int. You can assign integer values to it or use it in any other context where an integer variable is allowed. It might be worth noting that A.length gives the number of rows of A. To get the number of columns in A, you have to ask how many ints there are in a row; this number would be given by A[0].length, or equivalently by A[1].length or A[2].length. (There is actually no rule that says that all the rows of an array must have the same length, and some advanced applications of arrays use varying-sized rows. But if you use the new operator to create an array in the manner described above, you’ll always get an array with equal-sized rows.) Three-dimensional arrays are treated similarly. For example, a three-dimensional array of ints could be created with the declaration statement “int[][][] B = new int[7][5][11];”. It’s possible to visualize the value of B as a solid 7-by-5-by-11 block of cells. Each cell holds an int and represents one position in the three-dimensional array. Individual positions in the array can be referred to with variable names of the form B[i][j][k]. Higher-dimensional arrays
- 370. 354 CHAPTER 7. ARRAYS follow the same pattern, although for dimensions greater than three, there is no easy way to visualize the structure of the array. It’s possible to fill a multi-dimensional array with specified items at the time it is declared. Recall that when an ordinary one-dimensional array variable is declared, it can be assigned an “array initializer,” which is just a list of values enclosed between braces, { and }. Array initializers can also be used when a multi-dimensional array is declared. An initializer for a two-dimensional array consists of a list of one-dimensional array initializers, one for each row in the two-dimensional array. For example, the array A shown in the picture above could be created with: int[][] A = { { 1, 0, 12, -1 }, { 7, -3, 2, 5 }, { -5, -2, 2, -9 } }; If no initializer is provided for an array, then when the array is created it is automatically filled with the appropriate value: zero for numbers, false for boolean, and null for objects. 7.5.2 Using Two-dimensional Arrays Just as in the case of one-dimensional arrays, two-dimensional arrays are often processed using for statements. To process all the items in a two-dimensional array, you have to use one for statement nested inside another. If the array A is declared as int[][] A = new int[3][4]; then you could store a zero into each location in A with: for (int row = 0; row < 3; row++) { for (int column = 0; column < 4; column++) { A[row][column] = 0; } } The first time the outer for loop executes (with row = 0), the inner for loop fills in the four values in the first row of A, namely A[0][0] = 0, A[0][1] = 0, A[0][2] = 0, and A[0][3] = 0. The next execution of the outer for loop fills in the second row of A. And the third and final execution of the outer loop fills in the final row of A. Similarly, you could add up all the items in A with: int sum = 0; for (int i = 0; i < 3; i++) for (int j = 0; j < 4; j++) sum = sum + A[i][j]; This could even be done with nested for-each loops. Keep in mind that the elements in A are objects of type int[ ], while the elements in each row of A are of type int: int sum = 0; for ( int[] row : A ) { // For each row in A... for ( int item : row ) // For each item in that row... sum = sum + item; // Add item to the sum. }
- 371. 7.5. MULTI-DIMENSIONAL ARRAYS 355 To process a three-dimensional array, you would, of course, use triply nested for loops. ∗ ∗ ∗ A two-dimensional array can be used whenever the data that is being represented can be arranged into rows and columns in a natural way. Often, the grid is built into the problem. For example, a chess board is a grid with 8 rows and 8 columns. If a class named ChessPiece is available to represent individual chess pieces, then the contents of a chess board could be represented by a two-dimensional array: ChessPiece[][] board = new ChessPiece[8][8]; Or consider the “mosaic” of colored rectangles used in an example in Subsection 4.6.2. The mosaic is implemented by a class named MosaicCanvas.java. The data about the color of each of the rectangles in the mosaic is stored in an instance variable named grid of type Color[ ][ ]. Each position in this grid is occupied by a value of type Color. There is one position in the grid for each colored rectangle in the mosaic. The actual two-dimensional array is created by the statement: grid = new Color[ROWS][COLUMNS]; where ROWS is the number of rows of rectangles in the mosaic and COLUMNS is the number of columns. The value of the Color variable grid[i][j] is the color of the rectangle in row number i and column number j. When the color of that rectangle is changed to some color, c, the value stored in grid[i][j] is changed with a statement of the form “grid[i][j] = c;”. When the mosaic is redrawn, the values stored in the two-dimensional array are used to decide what color to make each rectangle. Here is a simplified version of the code from the MosaicCanvas class that draws all the colored rectangles in the grid. You can see how it uses the array: int rowHeight = getHeight() / ROWS; int colWidth = getWidth() / COLUMNS; for (int row = 0; row < ROWS; row++) { for (int col = 0; col < COLUMNS; col++) { g.setColor( grid[row][col] ); // Get color from array. g.fillRect( col*colWidth, row*rowHeight, colWidth, rowHeight ); } } Sometimes two-dimensional arrays are used in problems in which the grid is not so visually obvious. Consider a company that owns 25 stores. Suppose that the company has data about the profit earned at each store for each month in the year 2006. If the stores are numbered from 0 to 24, and if the twelve months from January ’06 through December ’06 are numbered from 0 to 11, then the profit data could be stored in an array, profit, constructed as follows: double[][] profit = new double[25][12]; profit[3][2] would be the amount of profit earned at store number 3 in March, and more generally, profit[storeNum][monthNum] would be the amount of profit earned in store number storeNum in month number monthNum. In this example, the one-dimensional array profit[storeNum] has a very useful meaning: It is just the profit data for one particular store for the whole year. Let’s assume that the profit array has already been filled with data. This data can be processed in a lot of interesting ways. For example, the total profit for the company—for the whole year from all its stores—can be calculated by adding up all the entries in the array:
- 372. 356 CHAPTER 7. ARRAYS double totalProfit; // Company’s total profit in 2006. totalProfit = 0; for (int store = 0; store < 25; store++) { for (int month = 0; month < 12; month++) totalProfit += profit[store][month]; } Sometimes it is necessary to process a single row or a single column of an array, not the entire array. For example, to compute the total profit earned by the company in December, that is, in month number 11, you could use the loop: double decemberProfit = 0.0; for (storeNum = 0; storeNum < 25; storeNum++) decemberProfit += profit[storeNum][11]; Let’s extend this idea to create a one-dimensional array that contains the total profit for each month of the year: double[] monthlyProfit; // Holds profit for each month. monthlyProfit = new double[12]; for (int month = 0; month < 12; month++) { // compute the total profit from all stores in this month. monthlyProfit[month] = 0.0; for (int store = 0; store < 25; store++) { // Add the profit from this store in this month // into the total profit figure for the month. monthlyProfit[month] += profit[store][month]; } } As a final example of processing the profit array, suppose that we wanted to know which store generated the most profit over the course of the year. To do this, we have to add up the monthly profits for each store. In array terms, this means that we want to find the sum of each row in the array. As we do this, we need to keep track of which row produces the largest total. double maxProfit; // Maximum profit earned by a store. int bestStore; // The number of the store with the // maximum profit. double total = 0.0; // Total profit for one store. // First compute the profit from store number 0. for (int month = 0; month < 12; month++) total += profit[0][month]; bestStore = 0; // Start by assuming that the best maxProfit = total; // store is store number 0. // Now, go through the other stores, and whenever we // find one with a bigger profit than maxProfit, revise // the assumptions about bestStore and maxProfit. for (store = 1; store < 25; store++) { // Compute this store’s profit for the year. total = 0.0;
- 373. 7.5. MULTI-DIMENSIONAL ARRAYS 357 for (month = 0; month < 12; month++) total += profit[store][month]; // Compare this store’s profits with the highest // profit we have seen among the preceding stores. if (total > maxProfit) { maxProfit = total; // Best profit seen so far! bestStore = store; // It came from this store. } } // end for // At this point, maxProfit is the best profit of any // of the 25 stores, and bestStore is a store that // generated that profit. (Note that there could also be // other stores that generated exactly the same profit.) 7.5.3 Example: Checkers For the rest of this section, we’ll look at a more substantial example. We look at a program that lets two users play checkers against each other. A player moves by clicking on the piece to be moved and then on the empty square to which it is to be moved. The squares that the current player can legally click are hilited. The square containing a piece that has been selected to be moved is surrounded by a white border. Other pieces that can legally be moved are surrounded by a cyan-colored border. If a piece has been selected, each empty square that it can legally move to is hilited with a green border. The game enforces the rule that if the current player can jump one of the opponent’s pieces, then the player must jump. When a player’s piece becomes a king, by reaching the opposite end of the board, a big white “K” is drawn on the piece. You can try an applet version of the program in the on-line version of this section. Here is what it looks like: I will only cover a part of the programming of this applet. I encourage you to read the complete source code, Checkers.java. At over 750 lines, this is a more substantial example than anything you’ve seen before in this course, but it’s an excellent example of state-based, event-driven programming. The data about the pieces on the board are stored in a two-dimensional array. Because of the complexity of the program, I wanted to divide it into several classes. In addition to the
- 374. 358 CHAPTER 7. ARRAYS main class, there are several nested classes. One of these classes is CheckersData, which handles the data for the board. It is mainly this class that I want to talk about. The CheckersData class has an instance variable named board of type int[][]. The value of board is set to “new int[8][8]”, an 8-by-8 grid of integers. The values stored in the grid are defined as constants representing the possible contents of a square on a checkerboard: static final int EMPTY = 0, // Value representing an empty square. RED = 1, // A regular red piece. RED KING = 2, // A red king. BLACK = 3, // A regular black piece. BLACK KING = 4; // A black king. The constants RED and BLACK are also used in my program (or, perhaps, misused) to represent the two players in the game. When a game is started, the values in the variable, board, are set to represent the initial state of the board. The grid of values looks like B L A C K E M P T Y B L A C K E M P T Y B L A C K E M P T Y B L A C K E M P T Y 0 B L A C K E M P T Y B L A C K E M P T Y B L A C K E M P T Y B L A C K E M P T Y 1 B L A C K E M P T Y B L A C K E M P T Y B L A C K E M P T Y B L A C K E M P T Y 2 E M P T Y E M P T Y E M P T Y E M P T Y 3 E M P T Y E M P T Y E M P T Y E M P T Y E M P T Y E M P T Y E M P T Y E M P T Y 4 E M P T Y E M P T Y E M P T Y E M P T Y 5 R E D 6 R E D E M P T Y E M P T Y E M P T Y E M P T Y 7 R E D R E D R E D E M P T Y E M P T Y E M P T Y E M P T Y R E D R E D R E D 0 1 2 3 4 5 6 7 R E D E M P T Y E M P T Y E M P T Y E M P T Y R E D R E D R E D A black piece can only move “down” the grid. That is, the row number of the square it moves to must be greater than the row number of the square it comes from. A red piece can only move up the grid. Kings of either color, of course, can move in both directions. One function of the CheckersData class is to take care of all the details of making moves on the board. An instance method named makeMove() is provided to do this. When a player moves a piece from one square to another, the values stored at two positions in the array are changed. But that’s not all. If the move is a jump, then the piece that was jumped is removed from the board. (The method checks whether the move is a jump by checking if the square to which the piece is moving is two rows away from the square where it starts.) Furthermore, a RED piece that moves to row 0 or a BLACK piece that moves to row 7 becomes a king. This is good programming: the rest of the program doesn’t have to worry about any of these details. It just calls this makeMove() method: /** * Make the move from (fromRow,fromCol) to (toRow,toCol). It is * ASSUMED that this move is legal! If the move is a jump, the * jumped piece is removed from the board. If a piece moves * to the last row on the opponent’s side of the board, the * piece becomes a king. */ void makeMove(int fromRow, int fromCol, int toRow, int toCol) {
- 375. 7.5. MULTI-DIMENSIONAL ARRAYS 359 board[toRow][toCol] = board[fromRow][fromCol]; // Move the piece. board[fromRow][fromCol] = EMPTY; if (fromRow - toRow == 2 || fromRow - toRow == -2) { // The move is a jump. Remove the jumped piece from the board. int jumpRow = (fromRow + toRow) / 2; // Row of the jumped piece. int jumpCol = (fromCol + toCol) / 2; // Column of the jumped piece. board[jumpRow][jumpCol] = EMPTY; } if (toRow == 0 && board[toRow][toCol] == RED) board[toRow][toCol] = RED KING; // Red piece becomes a king. if (toRow == 7 && board[toRow][toCol] == BLACK) board[toRow][toCol] = BLACK KING; // Black piece becomes a king. } // end makeMove() An even more important function of the CheckersData class is to find legal moves on the board. In my program, a move in a Checkers game is represented by an object belonging to the following class: /** * A CheckersMove object represents a move in the game of * Checkers. It holds the row and column of the piece that is * to be moved and the row and column of the square to which * it is to be moved. (This class makes no guarantee that * the move is legal.) */ private static class CheckersMove { int fromRow, fromCol; // Position of piece to be moved. int toRow, toCol; // Square it is to move to. CheckersMove(int r1, int c1, int r2, int c2) { // Constructor. Set the values of the instance variables. fromRow = r1; fromCol = c1; toRow = r2; toCol = c2; } boolean isJump() { // Test whether this move is a jump. It is assumed that // the move is legal. In a jump, the piece moves two // rows. (In a regular move, it only moves one row.) return (fromRow - toRow == 2 || fromRow - toRow == -2); } } // end class CheckersMove. The CheckersData class has an instance method which finds all the legal moves that are currently available for a specified player. This method is a function that returns an array of type CheckersMove[ ]. The array contains all the legal moves, represented as CheckersMove objects. The specification for this method reads
- 376. 360 CHAPTER 7. ARRAYS /** * Return an array containing all the legal CheckersMoves * for the specified player on the current board. If the player * has no legal moves, null is returned. The value of player * should be one of the constants RED or BLACK; if not, null * is returned. If the returned value is non-null, it consists * entirely of jump moves or entirely of regular moves, since * if the player can jump, only jumps are legal moves. */ CheckersMove[] getLegalMoves(int player) A brief pseudocode algorithm for the method is Start with an empty list of moves Find any legal jumps and add them to the list if there are no jumps: Find any other legal moves and add them to the list if the list is empty: return null else: return the list Now, what is this “list”? We have to return the legal moves in an array. But since an array has a fixed size, we can’t create the array until we know how many moves there are, and we don’t know that until near the end of the method, after we’ve already made the list! A neat solution is to use an ArrayList instead of an array to hold the moves as we find them. In fact, I use an object defined by the parameterized type ArrayList<CheckersMove> so that the list is restricted to holding objects of type CheckersMove. As we add moves to the list, it will grow just as large as necessary. At the end of the method, we can create the array that we really want and copy the data into it: Let "moves" be an empty ArrayList<CheckerMove> Find any legal jumps and add them to moves if moves.size() is 0: Find any other legal moves and add them to moves if moves.size() is 0: return null else: Let moveArray be an array of CheckersMoves of length moves.size() Copy the contents of moves into moveArray return moveArray Now, how do we find the legal jumps or the legal moves? The information we need is in the board array, but it takes some work to extract it. We have to look through all the positions in the array and find the pieces that belong to the current player. For each piece, we have to check each square that it could conceivably move to, and check whether that would be a legal move. There are four squares to consider. For a jump, we want to look at squares that are two rows and two columns away from the piece. Thus, the line in the algorithm that says “Find any legal jumps and add them to moves” expands to: For each row of the board: For each column of the board: if one of the player’s pieces is at this location: if it is legal to jump to row + 2, column + 2 add this move to moves
- 377. 7.5. MULTI-DIMENSIONAL ARRAYS 361 if it is legal to jump to row - 2, column + 2 add this move to moves if it is legal to jump to row + 2, column - 2 add this move to moves if it is legal to jump to row - 2, column - 2 add this move to moves The line that says “Find any other legal moves and add them to moves” expands to some- thing similar, except that we have to look at the four squares that are one column and one row away from the piece. Testing whether a player can legally move from one given square to another given square is itself non-trivial. The square the player is moving to must actually be on the board, and it must be empty. Furthermore, regular red and black pieces can only move in one direction. I wrote the following utility method to check whether a player can make a given non-jump move: /** * This is called by the getLegalMoves() method to determine * whether the player can legally move from (r1,c1) to (r2,c2). * It is ASSUMED that (r1,c1) contains one of the player’s * pieces and that (r2,c2) is a neighboring square. */ private boolean canMove(int player, int r1, int c1, int r2, int c2) { if (r2 < 0 || r2 >= 8 || c2 < 0 || c2 >= 8) return false; // (r2,c2) is off the board. if (board[r2][c2] != EMPTY) return false; // (r2,c2) already contains a piece. if (player == RED) { if (board[r1][c1] == RED && r2 > r1) return false; // Regular red piece can only move down. return true; // The move is legal. } else { if (board[r1][c1] == BLACK && r2 < r1) return false; // Regular black piece can only move up. return true; // The move is legal. } } // end canMove() This method is called by my getLegalMoves() method to check whether one of the possible moves that it has found is actually legal. I have a similar method that is called to check whether a jump is legal. In this case, I pass to the method the square containing the player’s piece, the square that the player might move to, and the square between those two, which the player would be jumping over. The square that is being jumped must contain one of the opponent’s pieces. This method has the specification: /** * This is called by other methods to check whether * the player can legally jump from (r1,c1) to (r3,c3). * It is assumed that the player has a piece at (r1,c1), that * (r3,c3) is a position that is 2 rows and 2 columns distant * from (r1,c1) and that (r2,c2) is the square between (r1,c1) * and (r3,c3).
- 378. 362 CHAPTER 7. ARRAYS */ private boolean canJump(int player, int r1, int c1, int r2, int c2, int r3, int c3) { . . . Given all this, you should be in a position to understand the complete getLegalMoves() method. It’s a nice way to finish off this chapter, since it combines several topics that we’ve looked at: one-dimensional arrays, ArrayLists, and two-dimensional arrays: CheckersMove[] getLegalMoves(int player) { if (player != RED && player != BLACK) return null; int playerKing; // The constant for a King belonging to the player. if (player == RED) playerKing = RED KING; else playerKing = BLACK KING; ArrayList<ChecherMove> moves = new ArrayList<CheckerMove>(); // Moves will be stored in this list. /* First, check for any possible jumps. Look at each square on the board. If that square contains one of the player’s pieces, look at a possible jump in each of the four directions from that square. If there is a legal jump in that direction, put it in the moves ArrayList. */ for (int row = 0; row < 8; row++) { for (int col = 0; col < 8; col++) { if (board[row][col] == player || board[row][col] == playerKing) { if (canJump(player, row, col, row+1, col+1, row+2, col+2)) moves.add(new CheckersMove(row, col, row+2, col+2)); if (canJump(player, row, col, row-1, col+1, row-2, col+2)) moves.add(new CheckersMove(row, col, row-2, col+2)); if (canJump(player, row, col, row+1, col-1, row+2, col-2)) moves.add(new CheckersMove(row, col, row+2, col-2)); if (canJump(player, row, col, row-1, col-1, row-2, col-2)) moves.add(new CheckersMove(row, col, row-2, col-2)); } } } /* If any jump moves were found, then the user must jump, so we don’t add any regular moves. However, if no jumps were found, check for any legal regular moves. Look at each square on the board. If that square contains one of the player’s pieces, look at a possible move in each of the four directions from that square. If there is a legal move in that direction, put it in the moves ArrayList. */ if (moves.size() == 0) { for (int row = 0; row < 8; row++) { for (int col = 0; col < 8; col++) { if (board[row][col] == player || board[row][col] == playerKing) {
- 379. 7.5. MULTI-DIMENSIONAL ARRAYS 363 if (canMove(player,row,col,row+1,col+1)) moves.add(new CheckersMove(row,col,row+1,col+1)); if (canMove(player,row,col,row-1,col+1)) moves.add(new CheckersMove(row,col,row-1,col+1)); if (canMove(player,row,col,row+1,col-1)) moves.add(new CheckersMove(row,col,row+1,col-1)); if (canMove(player,row,col,row-1,col-1)) moves.add(new CheckersMove(row,col,row-1,col-1)); } } } } /* If no legal moves have been found, return null. Otherwise, create an array just big enough to hold all the legal moves, copy the legal moves from the ArrayList into the array, and return the array. */ if (moves.size() == 0) return null; else { CheckersMove[] moveArray = new CheckersMove[moves.size()]; for (int i = 0; i < moves.size(); i++) moveArray[i] = moves.get(i); return moveArray; } } // end getLegalMoves
- 380. 364 CHAPTER 7. ARRAYS Exercises for Chapter 7 1. An example in Subsection 7.2.4 tried to answer the question, How many random people do you have to select before you find a duplicate birthday? The source code for that program can be found in the file BirthdayProblemDemo.java. Here are some related questions: • How many random people do you have to select before you find three people who share the same birthday? (That is, all three people were born on the same day in the same month, but not necessarily in the same year.) • Suppose you choose 365 people at random. How many different birthdays will they have? (The number could theoretically be anywhere from 1 to 365). • How many different people do you have to check before you’ve found at least one person with a birthday on each of the 365 days of the year? Write three programs to answer these questions. Each of your programs should sim- ulate choosing people at random and checking their birthdays. (In each case, ignore the possibility of leap years.) 2. Write a program that will read a sequence of positive real numbers entered by the user and will print the same numbers in sorted order from smallest to largest. The user will input a zero to mark the end of the input. Assume that at most 100 positive numbers will be entered. 3. A polygon is a geometric figure made up of a sequence of connected line segments. The points where the line segments meet are called the vertices of the polygon. The Graph- ics class includes commands for drawing and filling polygons. For these commands, the coordinates of the vertices of the polygon are stored in arrays. If g is a variable of type Graphics then • g.drawPolygon(xCoords, yCoords, pointCt) will draw the outline of the polygon with vertices at the points (xCoords[0],yCoords[0]), (xCoords[1],yCoords[1]), . . . , (xCoords[pointCt-1],yCoords[pointCt-1]). The third parameter, pointCt, is an int that specifies the number of vertices of the polygon. Its value should be 3 or greater. The first two parameters are arrays of type int[]. Note that the polygon automatically includes a line from the last point, (xCoords[pointCt-1],yCoords[pointCt-1]), back to the starting point (xCoords[0],yCoords[0]). • g.fillPolygon(xCoords, yCoords, pointCt) fills the interior of the polygon with the current drawing color. The parameters have the same meaning as in the drawPolygon() method. Note that it is OK for the sides of the polygon to cross each other, but the interior of a polygon with self-intersections might not be exactly what you expect. Write a panel class that lets the user draw polygons, and use your panel as the content pane in an applet (or standalone application). As the user clicks a sequence of points, count them and store their x- and y-coordinates in two arrays. These points will be the vertices of the polygon. Also, draw a line between each consecutive pair of points to give the user some visual feedback. When the user clicks near the starting point, draw the
- 381. Exercises 365 complete polygon. Draw it with a red interior and a black border. The user should then be able to start drawing a new polygon. When the user shift-clicks on the applet, clear it. For this exercise, there is no need to store information about the contents of the applet. Do the drawing directly in the mouseDragged() routine, and use the getGraphics() method to get a Graphics object that you can use to draw the line. (Remember, though, that this is considered to be bad style.) You will not need a paintComponent() method, since the default action of filling the panel with its background color is good enough. Here is a picture of my solution after the user has drawn a few polygons: 4. For this problem, you will need to use an array of objects. The objects belong to the class MovingBall, which I have already written. You can find the source code for this class in the file MovingBall.java. A MovingBall represents a circle that has an associated color, radius, direction, and speed. It is restricted to moving in a rectangle in the (x,y) plane. It will “bounce back” when it hits one of the sides of this rectangle. A MovingBall does not actually move by itself. It’s just a collection of data. You have to call instance methods to tell it to update its position and to draw itself. The constructor for the MovingBall class takes the form new MovingBall(xmin, xmax, ymin, ymax) where the parameters are integers that specify the limits on the x and y coordinates of the ball. In this exercise, you will want balls to bounce off the sides of the applet, so you will create them with the constructor call new MovingBall(0, getWidth(), 0, getHeight()) The constructor creates a ball that initially is colored red, has a radius of 5 pixels, is located at the center of its range, has a random speed between 4 and 12, and is headed in a random direction. There is one problem here: You can’t use this constructor until the width and height of the component are known. It would be OK to use it in the init() method of an applet, but not in the constructor of an applet or panel class. If you are using a panel class to display the ball, one slightly messy solution is to create the MovingBall objects in the panel’s paintComponent() method the first time that method is called. You can be sure that the size of the panel has been determined before paintComponent() is called. This is what I did in my own solution to this exercise.
- 382. 366 CHAPTER 7. ARRAYS If ball is a variable of type MovingBall, then the following methods are available: • ball.draw(g) — draw the ball in a graphics context. The parameter, g, must be of type Graphics. (The drawing color in g will be changed to the color of the ball.) • ball.travel() — change the (x,y)-coordinates of the ball by an amount equal to its speed. The ball has a certain direction of motion, and the ball is moved in that direction. Ordinarily, you will call this once for each frame of an animation, so the speed is given in terms of “pixels per frame”. Calling this routine does not move the ball on the screen. It just changes the values of some instance variables in the object. The next time the object’s draw() method is called, the ball will be drawn in the new position. • ball.headTowards(x,y) — change the direction of motion of the ball so that it is headed towards the point (x,y). This does not affect the speed. These are the methods that you will need for this exercise. There are also methods for setting various properties of the ball, such as ball.setColor(color) for changing the color and ball.setRadius(radius) for changing its size. See the source code for more information. For this exercise, you should create an applet that shows an animation of balls bouncing around on a black background. Use a Timer to drive the animation. (See Subsection 6.5.1.) Use an array of type MovingBall[] to hold the data for the balls. In addition, your program should listen for mouse and mouse motion events. When the user presses the mouse or drags the mouse, call each of the ball’s headTowards() methods to make the balls head towards the mouse’s location. My solution uses 50 balls and a time delay of 50 milliseconds for the timer. 5. The sample program RandomArtPanel.java from Subsection 6.5.1 shows a different ran- dom “artwork” every four seconds. There are three types of “art”, one made from lines, one from circles, and one from filled squares. However, the program does not save the data for the picture that is shown on the screen. As a result, the picture can