Goals for This Assignment
By the time you have completed this work, you should be able to:
- Use class-based inheritance to implement different behaviors for the same method
- Implement an immutable list
- Use recursion to implement basic list operations
Provided files:
Step-by-Step Instructions
Step 1: Download Needed Code
Download everything from the links above into a single directory.
Step 2: Read and Understand Provided Code
For this assignment, you’ll be working with an immutable linked list implementation, a type of . While you (hopefully!) are familiar with linked lists, this implementation is likely very different from the one you’re used to. Notably:
- Existing lists cannot be modified (the immutable/persistant part). Operations which would normally modify the list (like
append) instead return a new list, reflecting the result of the operation. For example,[1, 2].append([3, 4, 5])returns the list[1, 2, 3, 4, 5], leaving the original lists[1, 2]and[3, 4, 5]unmodified. - Instead of using
nullto represent the end of a list, we instead use an instance of classNil. - Class
Conscorresponds to the normalNodeclass, with the caveat thattail(representing the rest of the list) cannot benull. Per the prior bullet, if we want to represent a list wheretailis empty, then we should have an instance ofNilthere. - There is no special class holding the head of a list. Instead,
ConsandNilare both fully-featured lists in and of themselves. This is one of the reasons we useNilinstead ofnull, as we can meaningfully call methods onNil(unlikenull). ConsandNilboth implement theImmutableListinterface. If something wants to take a list as a parameter, it should take anImmutableList; which could be either an empty list (Nil) or a non-empty list (Cons).
In addition to the above bullets, there is a provided test suite in ImmutableListTest.java.
Step 3: (Try to) Compile and Run the Tests
You will need to compile and run the code. If the code fails to compile, do not try to run it; it either won’t work, or you’ll run an old, previously-compiled version. The two commands below compile and run the code, respectively. The two commands are slightly different, depending on what system you’re running with. If you’re on a UNIX-based system (e.g., Mac OS X, Linux), use:
javac -cp .:hamcrest-2.2.jar:junit-4.13.jar -Xlint:all ImmutableList.java Cons.java Nil.java ImmutableListTest.javajava -cp .:hamcrest-2.2.jar:junit-4.13.jar org.junit.runner.JUnitCore ImmutableListTest
If you’re on Windows command prompt, use these two commands, which use semicolons instead of colons:
javac -cp .;hamcrest-2.2.jar;junit-4.13.jar -Xlint:all ImmutableList.java Cons.java Nil.java ImmutableListTest.javajava -cp .;hamcrest-2.2.jar;junit-4.13.jar org.junit.runner.JUnitCore ImmutableListTest
If you’re on Windows Powershell, use these two commands, which put some arguments in single quotes:
javac -cp '.;hamcrest-2.2.jar;junit-4.13.jar' -Xlint:all ImmutableList.java Cons.java Nil.java ImmutableListTest.javajava -cp '.;hamcrest-2.2.jar;junit-4.13.jar' org.junit.runner.JUnitCore ImmutableListTest
If all tests are passing, you’ll see output like the following:
JUnit version 4.13....................................Time: 0.053OK (36 tests)
If tests are failing, the output will instead show which tests are failing. From there, you can look to see what those tests are doing in the test suite (ImmutableList.java), which will inform you of what needs to be modified.
Note that the provided code will not compile as provided. It’s missing the implementations of multiple methods which are needed to make the tests compile.
Step 4: Implement Missing Code, with Restrictions
Add code to Cons.java and Nil.java to get it to compile and pass the tests. Specifically, you need to implement the following methods for each:
length: returns the length of a list. As a hint, empty lists (Nil) have length0.sum: returns the sum of all the elements of the list. For our purposes, empty lists (Nil) have a sum of0.append: appends two lists together, returning a new list.contains: returnstrueif the given list contains the given element, elsefalse.
Example calls to these methods are in ImmutableList.java.
Restrictions
For full credit, your code:
- Can only modify
Cons.javaandNil.java; I’ll only look at these two files when grading, so any other modifications will be ignored. - CANNOT use loops (no
for, foreach,while, ordo-while). Any code I provided that uses loops is ok, and should not be modified. - CANNOT use conditionals (no
if,switch, or ternary ((...) ? ... : ...)). Any code I provided that uses loops is ok, and should not be modified.
These restrictions will force you to use recursion for a correct solution, and will also force you to fully exploit (also known as dynamic dispatch, polymorphism, and ad-hoc polymorphism). While these restrictions will likely be annoying, it will force you to use a key object-oriented feature (virtual dispatch), as well as serve as good practice for later in the course (recursion).
Hints
- It’s recommended to first write for all the methods you need to implement. This will get all the code compiling, but the tests won’t pass. This is still progress, and this way you can focus on getting one set of tests (or even just one test) to pass at a time.
- Mentally, whenever you think something like:
if (list is empty) { do empty thing} else { do non-empty thing}…you must instead use virtual dispatch. For this example,
do empty thingwould go into the corresponding method definition inNil, anddo non-empty thingwould go into the corresponding method definition inCons. - While you only have to implement 4 operations, each of these has a different implementation for
ConsandNil, so you really have to implement 8 methods. That said, the body of each of these methods need only be a single line of code. If you need much more than a single line for any method, you are likely making this more difficult than it needs to be. If you’re stuck, talk to me. - Once you think you have an operation working, run the tests again using the instructions in step 3. It’s probably best to focus on getting one set of tests (or even just one test) passing at a time.
- Specific to
contains, you do not need to useif, though you’ll need to use the short-circuiting nature of||. Specifically you can implement this using something like the following:return head == value || <<recursive call>>;
Step 5: Turn in Your Code
you need to upload the following files:
Cons.javaNil.java
