-
Notifications
You must be signed in to change notification settings - Fork 41
/
ch03.tex
858 lines (611 loc) · 32.8 KB
/
ch03.tex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
\chapter{Input and Output}
The programs you've looked at so far simply display messages, which doesn't really involve that much computation.
This chapter shows you how to read input from the keyboard, use that input to calculate a result, and then format that result for output.
%We will also look at some technical details about how operating systems work.
\section{The System Class}
\index{System.out}
We have been using \java{System.out.println} for a while, but you might not have thought about what it means.
\java{System} is a class that provides methods related to the ``system'', or environment, where programs run.
It also provides \java{System.out}, which is a special value that has additional methods (like \java{println}) for displaying output.
\index{System.out}
In fact, we can use \java{System.out.println} to display the value of \java{System.out}:
\begin{code}
System.out.println(System.out);
\end{code}
The result is shown here:
\begin{stdout}
java.io.PrintStream@685d72cd
\end{stdout}
\index{package}
\index{java.io}
This output indicates that \java{System.out} is a \java{PrintStream}, which is defined in a package called \java{java.io}.
A {\bf package} is a collection of related classes; \java{java.io} contains classes for I/O which stands for ``input and output''.
\index{address}
\index{hexadecimal}
The numbers and letters after the {\tt @} sign are the {\bf address} of \java{System.out}, represented as a hexadecimal (base 16) number.
The address of a value is its location in the computer's memory, which might be different on different computers.
In this example, the address is \java{685d72cd}, but if you run the same code, you will likely get something else.
%You can think of the address as a unique identifier for the object.
\index{library}
As shown in Figure~\ref{fig.system}, \java{System} is defined in a file called {\it System.java}, and \java{PrintStream} is defined in {\it PrintStream.java}.
These files are part of the Java {\bf library}, which is an extensive collection of classes that you can use in your programs.
The source code for these classes is usually included with the compiler (see Section~\ref{src.zip}).
\begin{figure}[!ht]
\begin{center}
\includegraphics{figs/system.pdf}
\caption{\java{System.out.println} refers to the \java{out} variable of the \java{System} class, which is a \java{PrintStream} that provides a method called \java{println}.}
\label{fig.system}
\end{center}
\end{figure}
\section{The Scanner Class}
\label{scanner}
%\index{byte}
%
%From the operating system's point of view, data from the keyboard arrives in a series of hardware control signals.
%The operating system translates these signals into a stream of {\bf bytes} (small integers), which in turn need to be translated into characters.
%\java{System.in} provides the means for reading one byte of input at a time, which is hardly useful for programs that would rather read in an entire word or line of input.
\index{Scanner}
\index{System.in}
The \java{System} class also provides the special value \java{System.in}, which is an \java{InputStream} that has methods for reading input from the keyboard.
These methods are not convenient to use, but fortunately Java provides other classes that make it easy to handle common input tasks.
\index{class!utility}
\index{utility class}
\index{java.util}
For example, \java{Scanner} is a class that provides methods for inputting words, numbers, and other data.
\java{Scanner} is provided by \java{java.util}, which is a package that contains various ``utility classes''.
Before you can use \java{Scanner}, you have to import it like this:
\begin{code}
import java.util.Scanner;
\end{code}
\index{import statement}
\index{statement!import}
This {\bf import statement} tells the compiler that when you refer to \java{Scanner}, you mean the one defined in \java{java.util}.
Using an import statement is necessary because there might be another class named \java{Scanner} in another package.
%Using an import statement makes your code unambiguous.
Next you have to initialize the \java{Scanner}.
This line declares a \java{Scanner} variable named \java{in} and creates a \java{Scanner} that reads input from \java{System.in}:
%We'll explain the \java{new} operator in more detail in Section~\ref{point}.
\index{new}
\index{operator!new}
\begin{code}
Scanner in = new Scanner(System.in);
\end{code}
The \java{Scanner} class provides a method called \java{nextLine} that reads a line of input from the keyboard and returns a \java{String}.
Here's a complete example that reads two lines and repeats them back to the user:
\index{Echo.java}
\begin{trinket}{Echo.java}
import java.util.Scanner;
public class Echo {
public static void main(String[] args) {
String line;
Scanner in = new Scanner(System.in);
System.out.print("Type something: ");
line = in.nextLine();
System.out.println("You said: " + line);
System.out.print("Type something else: ");
line = in.nextLine();
System.out.println("You also said: " + line);
}
}
\end{trinket}
Import statements can't be inside a class definition.
By convention, they are usually at the beginning of the file.
If you omit the import statement, you get a compiler error like ``cannot find symbol''.
That means the compiler doesn't know where to find the definition for \java{Scanner}.
\index{java.lang}
You might wonder why we can use the \java{System} class without importing it.
\java{System} belongs to the \java{java.lang} package, which is imported automatically.
According to the documentation, \java{java.lang} ``provides classes that are fundamental to the design of the Java programming language.''
The \java{String} class is also part of \java{java.lang}.
\section{Language Elements}
\index{language!elements}
At this point, we have seen nearly all of the organizational units that make up Java programs.
Figure~\ref{fig.package} shows how these ``language elements'' are related.
\begin{figure}[!ht]
\begin{center}
\includegraphics[width=284pt]{figs/package.pdf}
\caption{Elements of the Java language, from largest to smallest.}
\label{fig.package}
\end{center}
\end{figure}
\index{token}
Java applications are typically organized into packages (like \java{java.io} and \java{java.util}) that include multiple classes (like \java{PrintStream} and \java{Scanner}).
Each class defines its own methods (like \java{println} and \java{nextLine}), and each method is a sequence of statements.
Each statement performs one or more computations, depending on how many expressions it has, and each expression represents a single value to compute.
For example, the assignment statement \java{hours = minutes / 60.0;} contains a single expression: \java{minutes / 60.0}.
{\bf Tokens} are the most basic elements of a program, including numbers, variable names, operators, keywords, parentheses, braces, and semicolons.
In the previous example, the tokens are \java{hours}, \java{=}, \java{minutes}, \java{/}, \java{60.0}, and \java{;} (spaces are ignored by the compiler).
%\index{syntax}
%\index{semantics}
Knowing this terminology is helpful, because error messages often say things like ``not a statement'' or ``illegal start of expression'' or ``unexpected token''.
Comparing Java to English, statements are complete sentences, expressions are phrases, and tokens are individual words and punctuation marks.
Note there is a big difference between the Java {\em language}, which defines the elements in Figure~\ref{fig.package}, and the Java {\em library}, which provides the built-in classes that you can import.
For example, the keywords \java{public} and \java{class} are part of the Java language, but the names \java{PrintStream} and \java{Scanner} are not.
The standard edition of Java comes with {\em several thousand} classes you can use, which can be both exciting and intimidating.
You can browse this library on Oracle's website (\url{https://thinkjava.org/apidoc}).
Interestingly, most of the Java library is written in Java.
%\section{Inches to Centimeters}
\section{Literals and Constants}
%Now let's work through an example that's a little more useful.
Although most of the world has adopted the metric system for weights and measures, some countries are stuck with imperial units.
For example, when talking with friends in Europe about the weather, people in the United States might have to convert from Celsius to Fahrenheit and back.
%And when making an international purchase online, you may have to convert your nation's currency into another based on the exchange rate.
Or they might want to convert height in inches to centimeters.
%An everyday problem that computers are great at solving is converting numbers from one unit into another.
%For the rest of the chapter, we will look at how to write programs that solve these types of problems.
%Specifically, each program will 1) prompt the user for input, 2) read input from the keyboard, 3) calculate a result, and 4) format the result for output.
%The focus will not only be on Java syntax and language features, but also on the {\em process} of solving the problem, documenting the code, and testing the solution.
We can write a program to help.
We'll use a \java{Scanner} to input a measurement in inches, convert to centimeters, and then display the results.
The following lines declare the variables and create the \java{Scanner}:
\begin{code}
int inch;
double cm;
Scanner in = new Scanner(System.in);
\end{code}
\index{prompt}
\index{nextInt!Scanner}
The next step is to prompt the user for the input.
We'll use \java{print} instead of \java{println} so the user can enter the input on the same line as the {\bf prompt}.
And we'll use the \java{Scanner} method \java{nextInt}, which reads input from the keyboard and converts it to an integer:
\begin{code}
System.out.print("How many inches? ");
inch = in.nextInt();
\end{code}
Next we multiply the number of inches by 2.54, since that's how many centimeters there are per inch, and display the results:
\begin{code}
cm = inch * 2.54;
System.out.print(inch + " in = ");
System.out.println(cm + " cm");
\end{code}
This code works correctly, but it has a minor problem.
If another programmer reads this code, they might wonder where 2.54 comes from.
For the benefit of others (and yourself in the future), it would be better to assign this value to a variable with a meaningful name.
%We'll demonstrate in the next section.
%\section{Literals and Constants}
\index{literal}
A value that appears in a program, like the number 2.54, is called a {\bf literal}.
In general, there's nothing wrong with literals.
But when numbers like 2.54 appear in an expression with no explanation, they make the code hard to read.
And if the same value appears many times and could change in the future, it makes the code hard to maintain.
\index{magic number}
Values like 2.54 are sometimes called {\bf magic numbers} (with the implication that being magic is not a good thing).
A good practice is to assign magic numbers to variables with meaningful names, like this:
\begin{code}
double cmPerInch = 2.54;
cm = inch * cmPerInch;
\end{code}
This version is easier to read and less error-prone, but it still has a problem.
Variables can vary (hence the term), but the number of centimeters in an inch does not.
Once we assign a value to \java{cmPerInch}, it should never change.
Java provides the keyword \java{final}, a language feature that enforces this rule:
\begin{code}
final double CM_PER_INCH = 2.54;
\end{code}
\index{final}
\index{constant}
Declaring that a variable is \java{final} means that it cannot be reassigned once it has been initialized.
If you try, the compiler gives an error.
Variables declared as \java{final} are called {\bf constants}.
By convention, names for constants are all uppercase, with the underscore character (\java{_}) between words.
\section{Formatting Output}
\label{printf}
When you output a \java{double} by using \java{print} or \java{println}, it displays up to 16 decimal places:
\begin{code}
System.out.print(4.0 / 3.0);
\end{code}
The result is as follows:
\begin{stdout}
1.3333333333333333
\end{stdout}
\index{printf}
That might be more than you want.
\java{System.out} provides another method, called \java{printf}, that gives you more control of the format.
The ``f'' in \java{printf} stands for ``formatted''.
Here's an example:
\begin{code}
System.out.printf("Four thirds = %.3f", 4.0 / 3.0);
\end{code}
\index{format string}
\index{format specifier}
The first value in the parentheses is a {\bf format string} that specifies how the output should be displayed.
This format string contains ordinary text followed by a {\bf format specifier}, which is a special sequence that starts with a percent sign.
The format specifier \java{\%.3f} indicates that the following value should be displayed as floating-point, rounded to three decimal places:
%The result is shown here:
\begin{stdout}
Four thirds = 1.333
\end{stdout}
The format string can contain any number of format specifiers; here's an example with two of them:
\begin{code}
int inch = 100;
double cm = inch * CM_PER_INCH;
System.out.printf("%d in = %f cm\n", inch, cm);
\end{code}
The result is as follows:
\begin{stdout}
100 in = 254.000000 cm
\end{stdout}
Like \java{print}, \java{printf} does not append a newline.
So format strings often end with a newline character.
The format specifier \java{\%d} displays integer values (``d'' stands for ``decimal'', meaning base 10 integer).
The values are matched up with the format specifiers in order, so \java{inch} is displayed using \java{\%d}, and \java{cm} is displayed using \java{\%f}.
Learning about format strings is like learning a sublanguage within Java.
There are many options, and the details can be overwhelming.
Table~\ref{tab:format} lists a few common uses, to give you an idea of how things work.
\index{hexadecimal}
\begin{table}[!ht]
\begin{center}
\begin{tabular}{|l|l|l|}
\hline
\java{\%d} & Integer in base 10 (``decimal'') & \java{12345} \\
\hline
\java{\%,d} & Integer with comma separators & \java{12,345} \\
\hline
\java{\%08d} & Padded with zeros, at least 8 digits wide & \java{00012345} \\
\hline
\java{\%f} & Floating-point number & \java{6.789000} \\
\hline
\java{\%.2f} & Rounded to 2 decimal places & \java{6.79} \\
\hline
\java{\%s} & String of characters & \java{"Hello"} \\
\hline
\java{\%x} & Integer in base 16 (``hexadecimal'') & \java{bc614e} \\
\hline
\end{tabular}
\caption{Example format specifiers}
\label{tab:format}
\end{center}
\end{table}
For more details, refer to the documentation of \java{java.util.Formatter}.
The easiest way to find documentation for Java classes is to do a web search for ``Java'' and the name of the class.
\section{Reading Error Messages}
Notice that the values you pass to \java{printf} are separated by commas.
If you are used to using the \java{+} operator to concatenate strings, you might write something like this by accident:
\begin{code}
System.out.printf("inches = %d" + inch); // error
\end{code}
This line of code is legal, so the compiler won't catch the mistake.
Instead, when you run the program, it causes an exception:
\index{MissingFormatArgumentException}
\index{exception!MissingFormatArgument}
\begin{small}
\begin{stdout}
Exception in thread "main" java.util.MissingFormatArgumentException:
Format specifier '%d'
at java.util.Formatter.format(Formatter.java:2519)
at java.io.PrintStream.format(PrintStream.java:970)
at java.io.PrintStream.printf(PrintStream.java:871)
at Example.main(Example.java:10)
\end{stdout}
\end{small}
As you saw in Section~\ref{exception}, the error message includes the name of the exception, \java{MissingFormatArgumentException}, followed by additional details, \verb"Format specifier '%d'".
That means it doesn't know what value to substitute for \java{\%d}.
%CSM: we don't introduce the terms "argument" and "invoke" until the next chapter,
%but I think it's okay here since we're explaining MissingFormatArgumentException
The problem is that concatenation happens first, before \java{printf} executes.
If the value of \java{inch} is \java{100}, the result of concatenation is \verb'"inches = %d100"'.
So \java{printf} gets the format string, but it doesn't get any values to format.
\index{stack trace}
The error message also includes a {\bf stack trace} that shows the method that was running when the error was detected, \java{java.util.Formatter.format}; the method that ran it, \java{java.io.PrintStream.format}; the method that ran {\em that}, \java{java.io.PrintStream.printf}; and finally the method you actually wrote, \java{Example.main}.
Each line also names the source file of the method and the line it was on (e.g., \java{Example.java:10}).
That's a lot of information, and it includes method names and filenames you have no reason to know at this point.
But don't be overwhelmed.
When you see an error message like this, read the first line carefully to see {\em what} happened.
Then read the last line to see {\em where} it happened.
In some IDEs, you can click the error message, and it will take you to the line of code that was running.
But remember that where the error is discovered is not always where it was caused.
%\section{Centimeters to Inches}
\section{Type Cast Operators}
Now suppose we have a measurement in centimeters, and we want to round it off to the nearest inch.
It is tempting to write this:
\begin{code}
inch = cm / CM_PER_INCH; // syntax error
\end{code}
But the result is an error---you get something like, ``incompatible types: possible lossy conversion from double to int''.
The problem is that the value on the right is floating-point, and the variable on the left is an integer.
\index{automatic conversion}
Java converts an \java{int} to a \java{double} automatically, since no information is lost in the process.
On the other hand, going from \java{double} to \java{int} would lose the decimal places.
Java doesn't perform this operation automatically in order to ensure that you are aware of the loss of the fractional part of the number.
\index{type cast}
\index{operator!cast}
The simplest way to convert a floating-point value to an integer is to use a {\bf type cast}, so called because it molds, or ``casts'', a value from one type to another.
The syntax for type casting is to put the name of the type in parentheses and use it as an operator:
\begin{code}
double pi = 3.14159;
int x = (int) pi;
\end{code}
The \java{(int)} operator has the effect of converting what follows into an integer.
In this example, \java{x} gets the value \java{3}.
Like integer division, casting to an integer always rounds toward zero, even if the fractional part is \java{0.999999} (or \java{-0.999999}).
In other words, it simply throws away the fractional part.
In order to use a cast operator, the types must be compatible.
For example, you can't cast a \java{String} to an \java{int} because a string is not a number:
\begin{code}
String str = "3";
int x = (int) str; // error: incompatible types
\end{code}
Type casting takes precedence over arithmetic operations.
In the following example, the value of \java{pi} gets converted to an integer before the multiplication:
\begin{code}
double pi = 3.14159;
double x = (int) pi * 20.0; // result is 60.0, not 62.0
\end{code}
%Operator precedence and integer truncation make type casting somewhat error-prone.
Keeping that in mind, here's how we can convert centimeters to inches:
\begin{code}
inch = (int) (cm / CM_PER_INCH);
System.out.printf("%f cm = %d in\n", cm, inch);
\end{code}
The parentheses after the cast operator require the division to happen before the type cast.
And the result is rounded toward zero.
You will see in the next chapter how to round floating-point numbers to the closest integer.
\section{Remainder Operator}
Let's take the example one step further: suppose you have a measurement in inches and you want to convert to feet and inches.
The goal is divide by 12 (the number of inches in a foot) and keep the remainder.
\index{modulo}
\index{\% remainder operator}
\index{operator!remainder}
\index{remainder}
You have already seen the division operation (\java{/}), which computes the quotient of two numbers.
If the numbers are integers, the operation is integer division.
Java also provides the {\bf modulo} operation (\java{\%}), which divides two numbers and computes the remainder.
Using division and modulo, we can convert to feet and inches like this:
\begin{code}
feet = 76 / 12; // quotient
inches = 76 % 12; // remainder
\end{code}
The first line yields 6.
The second line, which is pronounced ``76 mod 12'', yields 4.
So 76 inches is 6 feet, 4 inches.
\index{modulus}
Many people (and textbooks) incorrectly refer to \java{\%} as the ``modulus operator''.
In mathematics, however, {\bf modulus} is the number you're dividing by.
In the previous example, the modulus is 12.
The Java language specification refers to \java{\%} as the ``remainder operator''.
The remainder operator looks like a percent sign, but you might find it helpful to think of it as a division sign ($\div$) rotated to the left.
%Note that both \java{/} and \java{\%} perform {\em integer division}, so the result always rounds down.
%The reason why integer division ``rounds down'' is that the hardware computes the quotient and remainder separately.
\index{divisible}
\index{extract digits}
Modular arithmetic turns out to be surprisingly useful.
For example, you can check whether one number is divisible by another: if \java{x \% y} is \java{0}, then \java{x} is divisible by \java{y}.
You can use the remainder operator to ``extract'' digits from a number: \java{x \% 10} yields the rightmost digit of \java{x}, and \java{x \% 100} yields the last two digits.
And many encryption algorithms use remainders extensively.
\section{Putting It All Together}
At this point, you have seen enough Java to write useful programs that solve everyday problems.
You can (1) import Java library classes, (2) create a \java{Scanner}, (3) get input from the keyboard, (4) format output with \java{printf}, and (5) divide and mod integers.
Now we will put everything together in a complete program:
%Since we've looked at each of these topics in isolation, it's important to see how they fit together in a complete program.
%If you've been working through the examples on your computer as you've been reading (like we recommended in Section~\ref{sec:examples}), then good job!
\index{Convert.java}
\begin{trinket}{Convert.java}
import java.util.Scanner;
/**
* Converts centimeters to feet and inches.
*/
public class Convert {
public static void main(String[] args) {
double cm;
int feet, inches, remainder;
final double CM_PER_INCH = 2.54;
final int IN_PER_FOOT = 12;
Scanner in = new Scanner(System.in);
// prompt the user and get the value
System.out.print("Exactly how many cm? ");
cm = in.nextDouble();
// convert and output the result
inches = (int) (cm / CM_PER_INCH);
feet = inches / IN_PER_FOOT;
remainder = inches % IN_PER_FOOT;
System.out.printf("%.2f cm = %d ft, %d in\n",
cm, feet, remainder);
}
}
\end{trinket}
Although not required, all variables and constants are declared at the top of \java{main}.
This practice makes it easier to find their types later on, and it helps the reader know what data is involved in the algorithm.
\index{documentation}
For readability, each major step of the algorithm is separated by a blank line and begins with a comment.
The class also includes a documentation comment (\java{/**}), which you can learn more about in Appendix~\ref{javadoc}.
Many algorithms, including the \java{Convert} program, perform division and modulo together.
In both steps, you divide by the same number (\java{IN_PER_FOOT}).
When statements including \java{System.out.printf} get long (generally wider than 80 characters), a common style convention is to break them across multiple lines.
The reader should never have to scroll horizontally.
\section{The Scanner Bug}
Now that you've had some experience with \java{Scanner}, we want to warn you about an unexpected behavior.
The following code fragment asks users for their name and age:
\begin{code}
System.out.print("What is your name? ");
name = in.nextLine();
System.out.print("What is your age? ");
age = in.nextInt();
System.out.printf("Hello %s, age %d\n", name, age);
\end{code}
The output might look something like this:
\begin{stdout}
Hello Grace Hopper, age 45
\end{stdout}
When you read a \java{String} followed by an \java{int}, everything works just fine.
But when you read an \java{int} followed by a \java{String}, something strange happens:
\begin{code}
System.out.print("What is your age? ");
age = in.nextInt();
System.out.print("What is your name? ");
name = in.nextLine();
System.out.printf("Hello %s, age %d\n", name, age);
\end{code}
Try running this example code.
It doesn't let you input your name, and it immediately displays the output:
\begin{stdout}
What is your name? Hello , age 45
\end{stdout}
To understand what is happening, you need to realize that \java{Scanner} doesn't see input as multiple lines as we do.
Instead, it gets a {\em stream of characters} as shown in Figure~\ref{fig.hopper1}.
\begin{figure}[!ht]
\begin{center}
\includegraphics{figs/hopper1.pdf}
\caption{A stream of characters as seen by a \java{Scanner}.}
\label{fig.hopper1}
\end{center}
\end{figure}
\index{state}
The arrow indicates the next character to be read by \java{Scanner}.
When you run \java{nextInt}, it reads characters until it gets to a non-digit.
Figure~\ref{fig.hopper2} shows the state of the stream after \java{nextInt} runs.
\begin{figure}[!ht]
\begin{center}
\includegraphics{figs/hopper2.pdf}
\caption{A stream of characters after \java{nextInt} runs.}
\label{fig.hopper2}
\end{center}
\end{figure}
At this point, \java{nextInt} returns the value \java{45}.
The program then displays the prompt \java{"What is your name? "} and runs \java{nextLine}, which reads characters until it gets to a newline.
But since the next character is already a newline, \java{nextLine} returns the empty string \java{""}.
To solve this problem, you need an extra \java{nextLine} after \java{nextInt}:
\begin{code}
System.out.print("What is your age? ");
age = in.nextInt();
in.nextLine(); // read the newline
System.out.print("What is your name? ");
name = in.nextLine();
System.out.printf("Hello %s, age %d\n", name, age);
\end{code}
This technique is common when reading \java{int} or \java{double} values that appear on their own line.
First you read the number, and then you read the rest of the line, which is just a newline character.
% DW suggests we also cover PrintWriter to write files --
% add an appendix on File I/O since it involves try/catch?
\section{Vocabulary}
\begin{description}
\term{package}
A directory of classes that are related to each other.
%Java classes are organized into packages.
\term{address}
The location of a value in computer memory, often represented as a hexadecimal integer.
\term{library}
A collection of packages and classes that are available for use in other programs.
%Libraries are often distributed in {\it .jar} (Java Archive) files.
%\term{abstraction}
%The process of reducing information and/or detail to focus on high-level concepts.
%\term{operating system}
%Software that is always running behind the scenes on your computer.
%It controls the execution of application programs and manages hardware resources.
%\term{byte}
%A single unit of data on a computer; enough to represent one character.
%\term{utility class}
%A class that provides commonly needed functionality.
\term{import statement}
A statement that allows programs to use classes defined in other packages.
\term{token}
The smallest unit of source code, such as an individual word, literal value, or symbol.
%\term{syntax}
%The structure of a program; the arrangement of the words and symbols it contains.
%\term{semantics}
%The meaning of a program; the low-level instructions it should perform.
\term{literal}
A value that appears in source code.
For example, \java{"Hello"} is a string literal, and \java{74} is an integer literal.
\term{prompt}
A brief message displayed in a print statement that asks the user for input.
\term{magic number}
A number that appears without explanation as part of an expression.
It should generally be replaced with a constant.
\term{constant}
A variable, declared as \java{final}, whose value cannot be changed.
\term{format string}
The string in \java{System.out.printf} that specifies the format of the output.
\term{format specifier}
A special code that begins with a percent sign and specifies the data type and format of the corresponding value.
\term{stack trace}
An error message that shows the methods that were running when an exception occurs.
\term{type cast}
An operation that explicitly converts one data type into another.
In Java, it appears as a type name in parentheses, like \java{(int)}.
%\term{truncate}
%To make shorter by cutting something off.
%Casting a floating-point value to an integer simply removes the fractional part.
\term{modulo}
An operation that yields the remainder when one integer is divided by another.
In Java, it is denoted with a percent sign: \java{5 \% 2} is \java{1}.
\term{modulus}
The value of \java{b} in the expression \java{a \% b}.
It often represents unit conversions, such as 24 hours in a day, 60 minutes in an hour, etc.
\end{description}
\section{Exercises}
The code for this chapter is in the {\it ch03} directory of {\it ThinkJavaCode2}.
See page~\pageref{code} for instructions on how to download the repository.
Before you start the exercises, we recommend that you compile and run the examples.
If you have not already read Appendix~\ref{commandline}, now might be a good time.
It describes the command-line interface, which is a powerful and efficient way to interact with your computer.
\begin{exercise} %%V6 Ex3.1
When you use \java{printf}, the Java compiler does not check your format string.
See what happens if you try to display a value with type \java{int} using \java{\%f}.
And what happens if you display a \java{double} using \java{\%d}?
What if you use two format specifiers, but then provide only one value?
\end{exercise}
%If you try to print an integer with \java{\%f} or a floating-point number using \java{\%d}, you get an \java{IllegalFormatConversionException}.
\begin{exercise} %%V6 Ex3.2
Write a program that converts a temperature from Celsius to Fahrenheit.
It should (1) prompt the user for input, (2) read a \java{double} value from the keyboard, (3) calculate the result, and (4) format the output to one decimal place.
When it's finished, it should work like this:
\begin{stdout}
Enter a temperature in Celsius: 24
24.0 C = 75.2 F
\end{stdout}
Here is the formula to do the conversion:
%
\[ F = C \times \frac{9}{5} + 32 \]
%
{\em Hint:} Be careful not to use integer division!
\end{exercise}
\begin{exercise} %%V6 Ex3.3
Write a program that converts a total number of seconds to hours, minutes, and seconds.
It should (1) prompt the user for input, (2) read an integer from the keyboard, (3) calculate the result, and (4) use \java{printf} to display the output.
For example, {\tt "5000 seconds = 1 hours, 23 minutes, and 20 seconds"}.
{\em Hint:} Use the remainder operator.
\end{exercise}
\begin{exercise} %%V6 Ex3.4
\label{guess}
The goal of this exercise is to program a {\it Guess My Number} game.
When it's finished, it should work like this:
\begin{stdout}
I'm thinking of a number between 1 and 100
(including both). Can you guess what it is?
Type a number: 45
Your guess is: 45
The number I was thinking of is: 14
You were off by: 31
\end{stdout}
To choose a random number, you can use the \java{Random} class in \java{java.util}.
Here's how it works:
\index{GuessStarter.java}
\begin{trinket}{GuessStarter.java}
import java.util.Random;
public class GuessStarter {
public static void main(String[] args) {
// pick a random number
Random random = new Random();
int number = random.nextInt(100) + 1;
System.out.println(number);
}
}
\end{trinket}
\index{new}
\index{operator!new}
Like the \java{Scanner} class in this chapter, \java{Random} has to be imported before we can use it.
And as with \java{Scanner}, we have to use the \java{new} operator to create a \java{Random} (number generator).
Then we can use the method \java{nextInt} to generate a random number.
In this example, the result of \java{nextInt(100)} will be between 0 and 99, including both.
Adding 1 yields a number between 1 and 100, including both.
\begin{enumerate}
\item The definition of \java{GuessStarter} is in a file called {\it GuessStarter.java}, in the directory called {\it ch03}, in the repository for this book.
%Instructions for downloading this code are on page~\pageref{code}.
\item Compile and run this program.
\item Modify the program to prompt the user; then use a \java{Scanner} to read a line of user input.
Compile and test the program.
\item Read the user input as an integer and display the result.
Again, compile and test.
\item Compute and display the difference between the user's guess and the number that was generated.
\end{enumerate}
\end{exercise}