HaQT Object-Oriented Programming

Lab 5. OOP - More Classes and Objects

Writing Good Programs

The only way to learn programming is program, program and program. Learning
programming is like learning cycling, swimming or any other sports. You can’t learn
by watching or reading books. Start to program immediately. On the other hands, to
improve your programming, you need to read many books and study how the masters
program.
It is easy to write programs that work. It is much harder to write programs that not
only work but also easy to maintain and understood by others – I call these good
programs. In the real world, writing program is not meaningful. You have to write
good programs, so that others can understand and maintain your programs.
Pay particular attention to:

1. Coding style:

• Read Java code convention: ”Java Style and Commenting Guide”.

• Follow the Java Naming Conventions for variables, methods, and classes
STRICTLY. Use CamelCase for names. Variable and method names begin
with lowercase, while class names begin with uppercase. Use nouns for
variables (e.g., radius) and class names (e.g., Circle). Use verbs for methods
(e.g., getArea(), isEmpty()).
• Use Meaningful Names: Do not use names like a, b, c, d, x, x1, x2,
and x1688 - they are meaningless. Avoid single-alphabet names like i, j, k.
They are easy to type, but usually meaningless. Use single-alphabet names
only when their meaning is clear, e.g., x, y, z for co-ordinates and i for array
index. Use meaningful names like row and col (instead of x and y, i and j,
x1 and x2), numStudents (not n), maxGrade, size (not n), and upperbound
(not n again). Differentiate between singular and plural nouns (e.g., use
books for an array of books, and book for each item).
• Use consistent indentation and coding style. Many IDEs (such as Eclipse /
NetBeans) can re-format your source codes with a single click.

2. Program Documentation: Comment! Comment! and more Comment to

explain your code to other people and to yourself three days later.

3. The only way to learn programming is program, program and program on chal-
lenging problems. The problems in this tutorial are certainly NOT challenging.
There are tens of thousands of challenging problems available – used in training
for various programming contests (such as International Collegiate Programming
Contest (ICPC), International Olympiad in Informatics (IOI)).

1
HaQT Object-Oriented Programming

1 More Exercises on Classes

1.1 The MyComplex class
A class called MyComplex, which models a complex number with real and imaginary parts,
is designed as shown in the class diagram.

It contains:

• Two instance variable named real (double) and imag (double) which stores the real
and imaginary parts of the complex number, respectively.

• A constructor that creates a MyComplex instance with the given real and imaginary
values.

• A default constructor that create a MyComplex at 0.0 + 0.0i.

• Getters and setters for instance variables real and imag.

• A method setValue() to set the value of the complex number.

• A toString() that returns ”(x + yi)” where x and y are the real and imaginary parts,
respectively.

• Methods isReal() and isImaginary() that returns true if this complex number is real
or imaginary, respectively.

Hints

2
HaQT Object-Oriented Programming

1 r e t u r n ( imag = = 0 ) ;

• A method equals(double real, double imag) that returns true if this complex number is
equal to the given complex number (real, imag).

Hints

r e t u r n ( t h i s . r e a l = = r e a l && t h i s . imag = = imag ) ;

• An overloaded equals(MyComplex another) that returns true if this complex number

is equal to the given MyComplex instance another.

Hints

r e t u r n ( t h i s . r e a l = = a n o t h e r . r e a l && t h i s . imag = = a n o t h e r . imag ) ;

• A method magnitude() that returns the magnitude of this complex number.

magnitude ( x+y i ) = Math . s q r t ( x∗x + y∗y )

• Methods addInto(MyComplex right) that adds and subtract the given MyComplex
instance (called right) into this instance and returns this instance.

(a + bi ) + ( c + di ) = (a + c ) + (b + d) i

Hints

return this ; // r e t u r n ” t h i s ” i n s t a n c e

3
HaQT Object-Oriented Programming

• Methods addNew(MyComplex right) that adds this instance with the given MyComplex
instance called right, and returns a new MyComplex instance containing the result.

Hints

// c o n s t r u c t a new i n s t a n c e and r e t u r n t h e c o n s t r u c t e d i n s t a n c e
2 r e t u r n new MyComplex ( . . . , . . . ) ;

You are required to:

1. Write the MyComplex class.

2. Write a test driver to test all the public methods defined in the class.

3. Write an application called MyComplexApp that uses the MyComplex class. The
application shall prompt the user for two complex numbers, print their values, check
for real, imaginary and equality, and carry out all the arithmetic operations.

Command window

1 Enter complex number 1 ( r e a l and i m a g i n a r y p a r t ) : 1 . 1 2 . 2

Enter complex number 2 ( r e a l and i m a g i n a r y p a r t ) : 3 . 3 4 . 4
3
Number 1 i s : ( 1 . 1 + 2 . 2 i )
5 ( 1 . 1 + 2 . 2 i ) i s NOT a pure r e a l number
( 1 . 1 + 2 . 2 i ) i s NOT a pure i m a g i n a r y number
7
Number 2 i s : ( 3 . 3 + 4 . 4 i )
9 ( 3 . 3 + 4 . 4 i ) i s NOT a pure r e a l number
( 3 . 3 + 4 . 4 i ) i s NOT a pure i m a g i n a r y number
11

( 1 . 1 + 2 . 2 i ) i s NOT e q u a l t o ( 3 . 3 + 4 . 4 i )
13 ( 1 . 1 + 2.2 i ) + ( 3 . 3 + 4.4 i ) = ( 4 . 4 + 6.6000000000000005 i )

Try
A (more) complete design of MyComplex class is shown below:

4
HaQT Object-Oriented Programming

• Methods argument() that returns the argument of this complex number in radians
(double).

a r g ( x+y i ) = Math . atan2 ( y , x ) ( i n r a d i a n s )

Note: The Math library has two arc-tangent methods, Math.atan2(double, double) and
Math.atan(double). We commonly use the Math.atan2(y, x) instead of Math.atan(y/x)
to avoid division by zero. Read the documentation of Math class in package java.lang.

• The method addInto() is renamed add(). Also added subtract() and subtractNew().

• Methods multiply(MyComplex right) and divide(MyComplex right) that multiplies and

divides this instance with the given MyComplex instance right, and keeps the result
in this instance, and returns this instance.

( a + b i ) ∗ ( c + d i ) = ( ac − bd ) + ( ad + bc ) i
2 ( a + b i ) / ( c + d i ) = [ ( a + b i ) ∗ ( c − d i ) ] / ( c ∗ c + d∗d )

5
HaQT Object-Oriented Programming

• A method conjugate() that operates on this instance and returns this instance contain-
ing the complex conjugate.

1 c o n j u g a t e ( x+y i ) = x − y i

Take note that there are a few flaws in the design of this class, which was introduced solely
for teaching purpose:

• Comparing doubles in equal() using ”==” may produce unexpected outcome. For
example, (2.2 + 4.4) == 6.6 returns false. It is common to define a small threshold
called EPSILON (set to about 10−8 ) for comparing floating point numbers.

• The method addNew(), subtractNew() produce new instances, whereas add(), sub-
tract(), multiply(), divide() and conjugate() modify this instance. There is inconsis-
tency in the design (introduced for teaching purpose).

Also take note that methods such as add() returns an instance of MyComplex. Hence, you
can place the result inside a System.out.println() (which implicitly invoke the toString()).
You can also chain the operations, e.g., complex1.add(complex2).add(complex3) (same as
(complex1.add(complex2)).add(complex3)), or complex1.add(complex2).subtract(complex3).

1.2 The MyPolynomial Class

A class called MyPolynomial, which models polynomials of degree-n (see equation), is de-
signed as shown in the class diagram.

cn xn + cn−1 xn−1 + · · · + c1 x + c0 .
It contains:

• A constructor MyPolynomial(coeffs: double...) that takes a variable number of doubles

to initialize the coeffs array, where the first argument corresponds to c0.

6
HaQT Object-Oriented Programming

• The three dots is known as varargs (variable number of arguments), which is a new
feature introduced in JDK 1.5. It accepts an array or a sequence of comma-separated
arguments. The compiler automatically packs the comma-separated arguments in an
array. The three dots can only be used for the last argument of the method.

Hints

p u b l i c c l a s s MyPolynomial {
2 p r i v a t e double [ ] c o e f f s ;
p u b l i c MyPolynomial ( d o u b l e . . . coeffs ) { // v a r a r g s
4 this . coeffs = coeffs ; // v a r a r g s i s t r e a t e d a s
,→ a r r a y
}
6 ......
}
8
// Test program
10 // Can i n v o k e with a v a r i a b l e number o f arguments
MyPolynomial p o l y n o m i a l 1 = new MyPolynomial ( 1 . 1 , 2 . 2 , 3 . 3 ) ;
12 MyPolynomial p o l y n o m i a l 1 = new MyPolynomial ( 1 . 1 , 2 . 2 , 3 . 3 , 4 . 4 , 5 . 5 )
,→ ;
// Can a l s o i n v o k e with an a r r a y
14 Double c o e f f s = { 1 . 2 , 3 . 4 , 5 . 6 , 7 . 8 }
MyPolynomial p o l y n o m i a l 2 = new MyPolynomial ( c o e f f s ) ;

• A method getDegree() that returns the degree of this polynomial.

• A method toString() that returns ”cn xn + cn−1 xn−1 + · · · + c1 x + c0 .”.

• A method evaluate(double x) that evaluate the polynomial for the given x, by substi-
tuting the given x into the polynomial expression.

• Methods add() and multiply() that adds and multiplies this polynomial with the given
MyPolynomial instance another, and returns this instance that contains the result.
Write the MyPolynomial class. Also write a test driver (called TestMyPolynomial) to test
all the public methods defined in the class.
Question: Do you need to keep the degree of the polynomial as an instance variable in the
MyPolynomial class in Java? How about C/C++? Why?

1.3 Using JDK’s BigInteger Class

Recall that primitive integer type byte, short, int and long represent 8-, 16-, 32-, and 64-bit
signed integers, respectively. You cannot use them for integers bigger than 64 bits. Java
API provides a class called BigInteger in a package called java.math. Study the API of
the BigInteger class (Java API ⇒ From ”Packages”, choose ”java.math” ” From ”classes”,
choose ”BigInteger” ” Study the constructors (choose ”CONSTR”) on how to construct

7
HaQT Object-Oriented Programming

a BigInteger instance, and the public methods available (choose ”METHOD”). Look for
methods for adding and multiplying two BigIntegers.
Write a program called TestBigInteger that:

1. adds ”11111111111111111111111111111111111111111111111111111111111111”
to ”22222222222222222222222222222222222222222222222222” and prints the result.

2. multiplies the above two number and prints the result.

Hints

import j a v a . math . B i g I n t e g e r
2
public c l a s s TestBigInteger {
4 p u b l i c s t a t i c v o i d main ( S t r i n g [ ] a r g s ) {
B i g I n t e g e r i 1 = new B i g I n t e g e r ( . . . ) ;
6 B i g I n t e g e r i 2 = new B i g I n t e g e r ( . . . ) ;
System . out . p r i n t l n ( i 1 . add ( i 2 ) ) ;
8 .......
}
10 }

1.4 The MyTime Class

8
HaQT Object-Oriented Programming

A class called MyTime, which models a time instance, is designed as shown in the class
diagram.
It contains the following private instance variables:

• hour: between 0 to 23.

• minute: between 0 to 59.

• Second: between 0 to 59.

You are required to perform input validation.

It contains the following public methods:

• setTime(int hour, int minute, int second): It shall check if the given hour, minute and
second are valid before setting the instance variables.
(Advanced: Otherwise, it shall throw an IllegalArgumentException with the message
”Invalid hour, minute, or second!”.)

• Setters setHour(int hour), setMinute(int minute), setSecond(int second): It shall check

if the parameters are valid, similar to the above.

• Getters getHour(), getMinute(), getSecond().

• toString(): returns ”HH:MM:SS”.

• nextSecond(): Update this instance to the next second and return this instance. Take
note that the nextSecond() of 23 : 59 : 59 is 00 : 00 : 00.

• nextMinute(), nextHour(), previousSecond(), previousMinute(), previousHour(): simi-

lar to the above.

Write the code for the MyTime class. Also write a test driver (called TestMyTime) to test
all the public methods defined in the MyTime class.

9
HaQT Object-Oriented Programming

1.5 The MyDate Class

A class called MyDate, which models a date instance, is defined as shown in the class diagram.
The MyDate class contains the following private instance variables:

• year (int): Between 1 to 9999.

• month (int): Between 1 (Jan) to 12 (Dec).

• day (int): Between 1 to 28|29|30|31, where the last day depends on the month and
whether it is a leap year for Feb (28|29).

It also contains the following public static final variables (drawn with underlined in the class
diagram):
• MONTHS (String[ ]), DAYS (String[ ]), and DAY IN MONTHS (int[ ]): static vari-
ables, initialized as shown, which are used in the methods.
The MyDate class has the following public static methods (drawn with underlined in the
class diagram):

10
HaQT Object-Oriented Programming

• isLeapYear(int year): returns true if the given year is a leap year. A year is a leap year
if it is divisible by 4 but not by 100, or it is divisible by 400.

• isValidDate(int year, int month, int day): returns true if the given year, month, and
day constitute a valid date. Assume that year is between 1 and 9999, month is between
1 (Jan) to 12 (Dec) and day shall be between 1 and 28|29|30|31 depending on the month
and whether it is a leap year on Feb.

• getDayOfWeek(int year, int month, int day): returns the day of the week, where 0 for
Sun, 1 for Mon, ..., 6 for Sat, for the given date. Assume that the date is valid. Read
the earlier exercise on how to determine the day of the week (or Wiki ”Determination
of the day of the week”).

The MyDate class has one constructor, which takes 3 parameters: year, month and day. It
shall invoke setDate() method (to be described later) to set the instance variables.
The MyDate class has the following public methods:

• setDate(int year, int month, int day): It shall invoke the static method isValidDate()
to verify that the given year, month and day constitute a valid date.
(Advanced: Otherwise, it shall throw an IllegalArgumentException with the message
”Invalid year, month, or day!”.)

• setYear(int year): It shall verify that the given year is between 1 and 9999.
(Advanced: Otherwise, it shall throw an IllegalArgumentException with the message
”Invalid year!”.)

• setMonth(int month): It shall verify that the given month is between 1 and 12.
(Advanced: Otherwise, it shall throw an IllegalArgumentException with the message
”Invalid month!”.)

• setDay(int day): It shall verify that the given day is between 1 and dayMax, where
dayMax depends on the month and whether it is a leap year for Feb.
(Advanced: Otherwise, it shall throw an IllegalArgumentException with the message
”Invalid month!”.)

• getYear(), getMonth(), getDay(): return the value for the year, month and day, re-
spectively.

• toString(): returns a date string in the format ”xxxday d mmm yyyy”, e.g., ”Tuesday
14 Feb 2012”.

• nextDay(): update this instance to the next day and return this instance. Take note
that nextDay() for 31 Dec 2000 shall be 1 Jan 2001.

• nextMonth(): update this instance to the next month and return this instance. Take
note that nextMonth() for 31 Oct 2012 shall be 30 Nov 2012.

11
HaQT Object-Oriented Programming

• nextYear(): update this instance to the next year and return this instance. Take note
that nextYear() for 29 Feb 2012 shall be 28 Feb 2013.
(Advanced: throw an IllegalStateException with the message ”Year out of range!” if
year > 9999.)

• previousDay(), previousMonth(), previousYear(): similar to the above.

Write the code for the MyDate class.

Use the following test statements to test the MyDate class:

MyDate d a t e 1 = new MyDate ( 2 0 1 2 , 2 , 2 8 ) ;

2 System . out . p r i n t l n ( d a t e 1 ) ; // Tuesday 28 Feb 2012
System . out . p r i n t l n ( d a t e 1 . nextDay ( ) ) ; // Wednesday 29 Feb 2012
4 System . out . p r i n t l n ( d a t e 1 . nextDay ( ) ) ; // Thursday 1 Mar 2012
System . out . p r i n t l n ( d a t e 1 . nextMonth ( ) ) ; // Sunday 1 Apr 2012
6 System . out . p r i n t l n ( d a t e 1 . nextYear ( ) ) ; // Monday 1 Apr 2013

8 MyDate d a t e 2 = new MyDate ( 2 0 1 2 , 1 , 2 ) ;

System . out . p r i n t l n ( d a t e 2 ) ; // Monday 2 Jan 2012
10 System . out . p r i n t l n ( d a t e 2 . previousDay ( ) ) ; // Sunday 1 Jan 2012
System . out . p r i n t l n ( d a t e 2 . previousDay ( ) ) ; // Saturday 31 Dec 2011
12 System . out . p r i n t l n ( d a t e 2 . previousMonth ( ) ) ; // Wednesday 30 Nov 2011
System . out . p r i n t l n ( d a t e 2 . p r e v i o u s Y e a r ( ) ) ; // Tuesday 30 Nov 2010
14
MyDate d a t e 3 = new MyDate ( 2 0 1 2 , 2 , 2 9 ) ;
16 System . out . p r i n t l n ( d a t e 3 . p r e v i o u s Y e a r ( ) ) ; // Monday 28 Feb 2011

18 // MyDate d a t e 4 = new MyDate ( 2 0 9 9 , 1 1 , 3 1 ) ; // I n v a l i d year , month , o r

,→ day !
// MyDate d a t e 5 = new MyDate ( 2 0 1 1 , 2 , 2 9 ) ; // I n v a l i d year , month , o r
,→ day !

Write a test program that tests the nextDay() in a loop, by printing the dates from 28 Dec
2011 to 2 Mar 2012.

12
HaQT Object-Oriented Programming

1.6 Bouncing Balls - Ball and Container Classes

A class called Ball is designed as shown in the class diagram.

The Ball class contains the following private instance variables:

• x, y and radius, which represent the ball’s center (x, y) co-ordinates and the radius,
respectively.

• xDelta (∆x) and yDelta (∆y), which represent the displacement (movement) per step,
in the x and y direction respectively.

The Ball class contains the following public methods:

• A constructor which accepts x, y, radius, speed, and direction as arguments. For user
friendliness, user specifies speed (in pixels per step) and direction (in degrees in the
range of (-180°, 180°]). For the internal operations, the speed and direction are to be
converted to (∆x, ∆y) in the internal representation. Note that the y-axis of the Java
graphics coordinate system is inverted, i.e., the origin (0, 0) is located at the top-left
corner.

13
HaQT Object-Oriented Programming

∆x = d cos(θ)
∆y = d sin(θ)

• Getter and setter for all the instance variables.

• A method move() which move the ball by one step.

x += ∆x
y += ∆y

• reflectHorizontal() which reflects the ball horizontally (i.e., hitting a vertical wall)

∆x = −∆x
∆y no changes

• reflectVertical() (the ball hits a horizontal wall).

∆x no changes
∆y = −∆y

• toString() which prints the message ”Ball at (x, y) of velocity (∆x, ∆y)”.

Write the Ball class. Also write a test program to test all the methods defined in the class.

14
HaQT Object-Oriented Programming

A class called Container, which represents the enclosing box for the ball, is designed as shown
in the class diagram. It contains:

• Instance variables (x1, y1) and (x2, y2) which denote the top-left and bottom-right
corners of the rectangular box.

• A constructor which accepts (x, y) of the top-left corner, width and height as argument,
and converts them into the internal representation (i.e., x2 = x1 + width − 1). Width
and height is used in the argument for safer operation (there is no need to check the
validity of x2 > x1, etc.).

• A toString() method that returns ”Container at (x1, y1) to (x2, y2)”.

• A boolean method called collidesWith(Ball), which check if the given Ball is outside
the bounds of the container box. If so, it invokes the Ball’s reflectHorizontal() and/or
reflectVertical() to change the movement direction of the ball, and returns true.

1 public boolean collidesWith ( Ball b a l l ) {

i f ( ( b a l l . getX ( ) − b a l l . g e t R a d i u s ( ) <= t h i s . x1 ) | |
3 ( b a l l . getX ( ) − b a l l . g e t R a d i u s ( ) >= t h i s . x2 ) ) {
ball . reflectHorizontal () ;
5 return true ;
}
7 ......
}

Use the following statements to test your program:

1 B a l l b a l l = new B a l l ( 5 0 , 5 0 , 5 , 1 0 , 3 0 ) ;
C o n t a i n e r box = new C o n t a i n e r ( 0 , 0 , 1 0 0 , 1 0 0 ) ;
3 f o r ( i n t s t e p = 0 ; s t e p < 1 0 0 ; ++ s t e p ) {
b a l l . move ( ) ;
5 box . c o l l i d e s W i t h ( b a l l ) ;
System . out . p r i n t l n ( b a l l ) ; // manual check t h e p o s i t i o n o f t h e b a l l
7 }

15
HaQT Object-Oriented Programming

1.7 The Ball and Player Classes

The Ball class, which models the ball in a soccer game, is designed as shown in the class
diagram. Write the codes for the Ball class and a test driver to test all the public methods.

The Player class, which models the players in a soccer game, is designed as shown in the
class diagram. The Player interacts with the Ball (written earlier). Write the codes for the
Player class and a test driver to test all the public methods. Make your assumption for the
kick().
Can you write a very simple soccer game with 2 teams of players and a ball, inside a soccer
field?

16