ArrayList Solution

Description

Style and Formatting

It is important that your code is not only functional, but written clearly and with good programming style. Your code will be checked against a style checker. The style checker is provided to you, and is located on Canvas. It can be found under Files, along with instructions on how to use it. A point is deducted for every style error that occurs. If there is a discrepancy between what you wrote in accordance with good style and the style checker, then address your concerns with the Head TA.

Javadocs

Javadoc any helper methods you create in a style similar to the existing javadocs. Any javadocs you write must be useful and describe the contract, parameters, and return value of the method. Random or useless javadocs added only to appease checkstyle will lose points.

Vulgar/Obscene Language

Any submission that contains profanity, vulgar, or obscene language will receive an automatic zero on the assignment. This policy applies not only to comments/javadocs, but also things like variable names.

Exceptions

When throwing exceptions, you must include a message by passing in a String as a parameter. The message must be useful and tell the user what went wrong. \Error”, \BAD THING HAP-PENED”, and \fail” are not good messages. The name of the exception itself is not a good message. For example:

Bad: throw new IndexOutOfBoundsException(‘‘Index is out of bounds.’’);

Good: throw new IllegalArgumentException(‘‘Cannot insert null data into data structure.’’);

In addition, you may not use try catch blocks to catch an exception unless you catching an exception you have explicitly thrown yourself with the throw new ExceptionName(‘‘Exception Message’’); syn-tax (replacing ExceptionName and Exception Message with the actual exception name and message respectively).

Generics

If available, use the generic type of the class; do not use the raw type of the class. For example, use new LinkedList<Integer>() instead of new LinkedList(). Using the raw type of the class will result in a penalty.

Forbidden Statements

You may not use these in your code at any time in CS 1332.

• package

• System.arraycopy()

• clone()

• assert()

• Arrays class

• Array class

• Thread class

Homework 1: ArrayList Due: See Canvas

• Collections class

• Collection.toArray()

• Re ection APIs

• Inner or nested classes

• Lambda Expressions

• Method References (using the :: operator to obtain a reference to a method)

If you’re not sure on whether you can use something, and it’s not mentioned here or anywhere else in the homework les, just ask.

Debug print statements are ne, but nothing should be printed when we run your code. We expect clean runs – printing to the console when we’re grading will result in a penalty. If you submit these, we will take o points.

JUnits

We have provided a very basic set of tests for your code. These tests do not guarantee the correctness of your code (by any measure), nor do they guarantee you any grade. You may additionally post your own set of tests for others to use on the Georgia Tech GitHub as a gist. Do NOT post your tests on the public GitHub. There will be a link to the Georgia Tech GitHub as well as a list of JUnits other students have posted on the class Piazza.

If you need help on running JUnits, there is a guide, available on Canvas under Files, to help you run JUnits on the command line or in IntelliJ.

Homework 1: ArrayList Due: See Canvas

made for the object. For example, in that Person example above, we may want two objects to be con-sidered equal if they have the same name and id.

Keep in mind which makes more sense to use while you are coding. You will want to use value equality in most cases in this course when comparing objects. Notable cases where you’d use reference equality include checking for null or comparing primitives (in this case, it’s just the == operator being overloaded).

Di erences between Java API and This Assignment

Some of the methods in this assignment are called di erent things or don’t exist in Java’s ArrayList class. This won’t matter until you tackle coding questions on the rst exam, but it’s something to be aware of. The list below shows all methods with a di erent name and their Java API equivalent if it exists. The format is assignment method name ) Java API name.

• addAtIndex(int index, T data) ) add(int index, T data)

• addToFront(T data) ) no explicit method

• addToBack(T data) ) add(T data)

• removeAtIndex(int index) ) remove(int index)

• removeFromFront() ) no explicit method

• removeFromBack() ) no explicit method

Homework 1: ArrayList Due: See Canvas

Grading

Here is the grading breakdown for the assignment. There are various deductions not listed that are incurred when breaking the rules listed in this PDF and in other various circumstances.

Methods:
constructor	1pts
addAtIndex	15pts
addToFront	11pts
addToBack	11pts
removeAtIndex	11pts
removeFromFront	7pts
removeFromBack	7pts
get	6pts
isEmpty	3pts
clear	3pts
Other:
Checkstyle	10pts
E ciency	15pts
Total:	100pts

Provided

The following le(s) have been provided to you. There are several, but we’ve noted the ones to edit.

1. ArrayList.java

This is the class in which you will implement the ArrayList. Feel free to add private helper methods but do not add any new public methods, inner/nested classes, instance vari-ables, or static variables.

2. ArrayListStudentTest.java

This is the test class that contains a set of tests covering the basic operations on the ArrayList class. It is not intended to be exhaustive and does not guarantee any type of grade. Write your own tests to ensure you cover all edge cases.

Deliverables

You must submit all of the following le(s). Make sure all le(s) listed below are in each submission, as only the last submission will be graded. Make sure the lename(s) matches the lename(s) below, and that only the following le(s) are present. If there are multiple les, do not zip up the les before submitting; submit them all as separate les.

Once submitted, double check that it has uploaded properly on Gradescope. To do this, download your uploaded le(s) to a new folder, copy over the support le(s), recompile, and run. It is your sole responsibility to re-test your submission and discover editing oddities, upload issues, etc.

1. ArrayList.java

6