Lab: Inheritance

Assigned
Monday, 19 February 2024
Summary
In today’s laboratory, you will explore inheritance in Java by building and extending some simple classes.

Preparation

a. Create a VSCode Java project for this lab.

b. Add the JUnit library to your project.

c. Create a package, groupname.util, substituting the name of your group for groupname. (You can choose the name of your group, as long as you keep it appropriate.)

Add the following interface to package groupname.util (substituting the name of your group for groupname).

package groupname.util;

/**
 * Things that count.
 */
public interface Counter {
  /**
   * Count something.
   *
   * @exception Exception
   *   When the count gets too large.
   */
  public void increment() throws Exception;

  /**
   * Reset the counter.
   */
  public void reset();

  /**
   * Get the value of the counter.
   */
  public int get();
} // interface Counter

Exercises

Exercise 1: Your base class

Write a class, BasicCounter, in package groupname.util, that implements the Counter interface. The class will allow clients to build objects that count things, starting at some value.

The class should contain

  • Two int fields, count and start. Do not make them private or public. They can be protected or package (i.e., with no explicit modifier).
  • One constructor that takes a starting value as a parameter. The constructor should initialize both count and start to that value.
  • Four methods:
    • increment(), which adds 1 to count (note that increment may throw an exception);
    • reset(), which resets count to start;
    • toString(), which returns a string of the form "[" + this.count + "]".
    • get(), which returns the value of count.

Here is a simple, not so systematic, test for that class.

package groupname.util;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.fail;

import org.junit.jupiter.api.Test;

/**
 * Test for counters.
 */
public class CounterTests {
  @Test
  public void test1() throws Exception {
    Counter alpha = new BasicCounter(0);
    Counter beta = new BasicCounter(123);
    Counter gamma = new BasicCounter(-5);
    assertEquals(0, alpha.get(), "original alpha");
    assertEquals(123, beta.get(), "original beta");
    assertEquals(-5, gamma.get(), "original gamma");
    for (int i = 0; i < 10; i++) {
      alpha.increment();
      beta.increment();
      gamma.increment();
    } // for
    assertEquals(10, alpha.get(), "updated alpha");
    assertEquals(133, beta.get(), "updated beta");
    assertEquals(5, gamma.get(), "updated gamma");
    alpha.reset();
    beta.reset();
    gamma.reset();
    assertEquals(0, alpha.get(), "reset alpha");
    assertEquals(123, beta.get(), "reset beta");
    assertEquals(-5, gamma.get(), "reset gamma");
  } // test1()
} // class CounterTests

And here is an equally simple experiment.

package groupname.util;

import java.io.PrintWriter;

/**
 * A simple experiment to allow us to explore our counter classes.
 */
public class CounterExpt {
  public static void main(String[] args) throws Exception {
    // Set up output
    PrintWriter pen = new PrintWriter(System.out, true);

    // Set up some counters
    Counter alpha = new BasicCounter(0);
    Counter beta = new BasicCounter(123);
    Counter gamma = new BasicCounter(-5);

    // Print original values
    pen.println("Original alpha = " + alpha);
    pen.println("Original beta = " + beta);
    pen.println("Original gamma = " + gamma);
  
    // Print incremented values
    alpha.increment();
    beta.increment();
    gamma.increment();
    pen.println("Updated alpha = " + alpha);
    pen.println("Updated beta = " + beta);
    pen.println("Updated gamma = " + gamma);

    // And we're done
    pen.close();
  } // main(String[])
} // class CounterExpt

Exercise 2: Tallys

One of the key ideas of inheritance is that you can create new classes in place of old. So let’s try it. We’ll create a class, Tally, that behaves much like our BasicCounter class.

a. Create a new class, Tally, that has the following form:

public class Tally extends BasicCounter {
  public Tally(int start) {
    super(start);
  } // Tally(int)
} // class Tally

b. Change the initialization of alpha in the tests and experiments so that it reads

  Counter alpha = new Tally(0);

c. What effect to you expect this change to have on the tests or experiments?

d. Check your answer experimentally.

e. How do Tally objects differ from BasicCounter objects? Right now, not at all. How might they differ? We might want to make Tally objects always start at 0, rather than a designated start value. How can we do that? With a slightly different constructor. Replace the constructor of Tally with the following.

public Tally() {
  super(0);
} // Tally()

f. What effect do you expect this change to have?

g. Check your answer experimentally.

h. As you might have predicted, Java issues an error message because you are calling the constructor with the wrong number of parameters. Rewrite the initialization in CounterTests and CounterExpt to the following and predict the effect.

  Counter alpha = new Tally();

i. Check your answer experimentally.

j. Summarize what you learned in this exercise.

Exercise 3: Decrementable BasicCounters

a. Create a new class, DecrementableCounter, that has the following form:

public class DecrementableCounter extends BasicCounter {
  public DecrementableCounter(int start) {
    super(start);
  } // DecrementableCounter(int)
} // class DecrementableCounter

b. Change the initialization of gamma so that it reads

    Counter gamma = new DecrementableCounter(-5);

c. What effect to you expect this change to have on the tests or experiments?

d. Check your answer experimentally.

e. Add a decrement() method to DecrementableCounter This method should subtract one from the count field.

f. What do you expect to happen if we add the following lines to our test?

    gamma.reset();
    assertEquals(-5, gamma.get(), "reset gamma");
    gamma.decrement();
    assertEquals(-6, gamma.get(), "decremented gamma");

g. Check your answer experimentally.

h. Change the declaration of gamma to

  DecrementableCounter gamma = new DecrementableCounter(-5);

i. What effect do you expect this change to have?

j. Check your answer experimentally.

k. Change the initialization of gamma so that it reads

  DecrementableCounter gamma = new BasicCounter(-5);

l. What effect to you expect this change to have?

m. Check your answer experimentally.

n. Restore the initialization of gamma to

  DecrementableCounter gamma = new DecrementableCounter(-5);

o. Summarize what you learned in this exercise.

Exercise 4: Naming BasicCounters

a. Create a new class, NamedCounter, that has the following form

public class NamedCounter extends BasicCounter {
  String name;
  public NamedCounter(String name, int start) {
    super(start);
    this.name = name;
  } // NamedCounter(String, int)
} // class NamedCounter 

b. Update your test and experiment so that the initialization of alpha reads

    Counter alpha = new NamedCounter("alfa", 0);

c. What effect do you expect this change to have?

d. Check your prediction experimentally.

e. Override the toString method by inserting the following code into NamedCounter.

  @Override
  public String toString() {
    return this.name + super.toString();
  } // toString()

f. What effect do you expect this change to have?

g. Check your prediction experimentally.

h. Swap the two lines in the constructor for NamedCounter and determine what errors, if any, you get.

i. Restore the constructor.

j. Summarize what you’ve learned from this exercise.

Exercise 5: Named counters, revisited

a. What effect do you expect if we have NamedCounter extend DecrementableCounter instead of BasicCounter? For example, will we still be able to write the following declaration?

    Counter alpha = new NamedCounter("alfa", 0);

b. Check your answer experimentally.

c. Add a call to System.err.println to each of the constructors so that you can observe when they are called. For example, you might change the NamedCounter constructor to read as follows.

  public NamedCounter(String name, int start) {
    super(start);
    System.err.println("NamedCounter(\"" + name + "\", " + start + ")");
    this.name = name;
  } // NamedCounter(String, int)

What do you expect to see as output when your create alpha?

d. Check your answer experimentally.

e. Summarize what you learned from this exercise.

Exercise 6: Double counters

a. Create a new class, DoubleCounter, that has the following form

public class DoubleCounter extends BasicCounter {
} // class DoubleCounter 

b. What do you expect to happen when you compile this class?

c. Check your answer experimentally.

d. Insert a constructor for DoubleCounter of the following form.

public DoubleCounter(int start) {
  super(start);
} // DoubleCounter(int)

e. Update your experiment so that the initialization of beta reads

    Counter beta = new DoubleCounter(123);

f. What effect do you expect this change to have on your tests or experiments?

g. Check your prediction experimentally.

h. Override the increment method by inserting the following code into DoubleCounter

  @Override
  public void increment() { 
    super.increment();
    super.increment();
  } // increment()

i. What effect do you expect this change to have on your tests and experiments?

j. Check your prediction experimentally.

k. Summarize what you’ve learned from this exercise.

Exercise 7: Bounded counters

a. Create a subclass of BasicCounter called BoundedCounter that includes

  • an int field named bound;
  • a constructor that takes two parameters: a starting value and an upper bound (that is, a value for the bound field); and
  • a modified increment method that throws an exception when count exceeds the bound.

b. In your test, determine the results of changing the initialization of gamma to

  BasicCounter gamma = new BoundedCounter(-5,3);

c. Summarize what you’ve learned from this exercise.

Exercise 8: Double Counters, Revisited

Note that for this exercise, you probably just want to use the experiment, rather than the test.

a. Add the following class to your project.

package groupname.util;

public class DblCtr implements Counter {
  /**
   * The underlying counter.
   */
  Counter base;

  /**
   * Build a new counter that counts twice as fast as counter.
   */
  public DblCtr(Counter counter) {
    this.base = counter;
  } // DblCtr(Counter)

  /**
   * Increment the counter, twice.
   */
  @Override
  public void increment() { 
    this.base.increment();
    this.base.increment();
  } // increment()

  /**
   * Reset the counter.
   */
  @Override
  public void reset() {
    this.base.reset();
  } // reset()

  /**
   * Get the value.
   */
  @Override
  public int get() {
    return this.base.get();
  } // get()

  /**
   * Convert to a string.
   */
  @Override
  public String toString() {
    return this.base.toString();
  } // toString()
} // class DblCtr

b. Update your experiment so that the initialization of beta reads

    Counter beta = new DblCtr(new BasicCounter());

c. What effect do you expect this change to have on the output?

d. Check your prediction experimentally.

e. Update your experiment so that the initialization of beta reads

    Counter beta = new DblCtr(new DblCtr(new BasicCounter()));

f. What effect do you expect this change to have on the output?

g. Check your prediction experimentally.

h. Summarize what you learned from this exercise.