Project: Review

Table of Contents

• Project: Review
  • Table of Contents
  • Good work pledge
  • Getting started
  • The Project
    • ShapeMaker
    • BankAccountManager
    • ArrayListPractice
  • Unit Tests
  • Bonus Assignment
  • A Note About Extra Credit and Bonus Assignments
  • Committing your Changes and Turning In The Project
  • Grading

Good work pledge

We are here to broaden your exposure to Computer Science. We can only achieve that purpose when you work hard and honestly. It may be tempting to copy-paste code from a classmate, or let a classmate do all your work for you—don't! You will be cheating yourself from the most valuable thing course has to offer—overcoming challenges.

We know that hard, and honest work doesn't come easily. If you feel like you are falling behind

1. Don't copy-paste code, or let someone do your work for you
2. Ask for help!
3. Tell the teaching-team you need more time

Getting started

1. Open the assignment link your teacher posts in Teams or OneNote, and accept the assignment. GitHub will create a private project just for you.
2. On your new project page, click the green Code button, copy the link, and clone the project into IntelliJ (File → New → Project from Version Control, then paste the link).
3. When IntelliJ asks if you trust the project, say yes / trust it so it can finish setting things up.
4. If IntelliJ asks you to pick a Java version (JDK), choose 17 or newer.
5. Use the green play dropdown near the top-right of IntelliJ to run the program (Main) or the tests. Start with AllTestsNoExtraCredit while you work on the required parts. When you try the extra-credit methods, use AllTestsWithExtraCredit (or the individual ExtraCredit run configs). You can stay in the file you are editing — you do not need to open a different file first.

If anything looks confusing the first time you open the project, ask a teacher — IntelliJ asks a few one-time setup questions, and then day-to-day work is just writing code and using that green play button.

The Project

This project has three parts — work through them in this order: ShapeMaker → BankAccount → ArrayListPractice.

1. ShapeMaker: In ShapeMaker, you will implement functions that print out shapes using the '*' symbol and whitespaces (spaces, tabs, and newlines). It will be a good exercise to warm up your for loops and if statements.
2. BankAccountManager: The BankAccountManager is a bare bones application that allows the user to manage a single bank account by making withdrawals, deposits, and checking the balance. You will implement a BankAcocunt class that manages all of the functionality of a bank account. This part will be a good exercise to review constructors, member variables, and other things about classes.
3. ArrayListPractice: In ArrayListPractice, you will implement several functions that involve working with ArrayLists. In some of the functions, the ArrayLists will contain integers, and in others, the ArrayLists will contain Student objects, where Student is a class that represents a student. This section will be good practice for working with ArrayLists and clases/objects.

ShapeMaker

In order to run ShapeMaker, click on the dropdown next to the play button in the top right, select "Main", and at the prompt, type "s". Since none of the functions have been implemented yet, the program will print nothing. That's okay, though! You shouldn't have hit any compile errors, and that means you are in the perfect place to start.

All of the functionality that you will need to implement is located in the ShapeMaker class. Open this class, and you will see a list of functions that must be implemented, with instructions above each function. Follow the instructions exactly.

Start by implementing the first function. Then hit play and see the program run, and see if you implemented it properly. If you get it right, move onto the next function. Otherwise, make whatever corrections you need to make and run it again. I recommend running the program very often. That will allow you to make sure you are on the right track. You should absolutely be running it after each function that you implement.

Each function's Javadoc shows ASCII examples of the expected output. Count spaces carefully against those pictures — required tests ignore trailing spaces after the last *, but leading spaces and spaces between stars must match. Extra credit (no trailing spaces) uses ShapeMakerExtraCreditTest.

Extra Credit Opportunity: write the functions so they don't have extra spaces at the end of the line if they are not needed. So the first line of PrintSquare() should be "* * *" rather than "* * * " (the second one has an extra space at the end). The extra "ShapeMakerExtraCreditTest" config is so that you can test your functions for the extra credit (More on unit tests below).

BankAccountManager

The BankAccountManager is a command line application that allows you to maintain a bank account. First you set up the bank account with a name and a starting balance. After that, it continuously asks the user for a command. It can take several commands:

Command	Description
Balance	Prints the name and account balance.
Deposit (ex. "Deposit 43")	Deposit takes in a dollar amount and adds it to the account balance.
Withdraw (ex. "Withdraw 13")	Withdraw takes in a dollar amount and subtracts it from the account balance, as long as there is enough money in the account. Otherwise, it just prints an error message to the user.
AddInterest (ex. "AddInterest 2 .05")	Takes in a number of years and an interest rate and calculates the new balance with interest added. For our purposes, we're just using simple interest (Interest = Balance * Time * Rate and New Balance = Old Balance + Interest).
Quit	Exits the program.

Your job is to implement the BankAccount class so that it keeps track of the name and account balance. You will have to implement the constructor, a couple of getters, and a couple of methods. All of those methods can be found in the BankAccount class. You will also have to implement "PrintAccountInfo" function, located in BankAccountManager.

You can test your BankAccount class using the BankAccountManager configuration in the dropdown next to the play button.

ArrayListPractice

The functions needed to be implemented are in the ArrayListPractice class. ArrayListPractice is similar to ShapeMaker in that all of the functions are static, standalone functions. You don't need to implement one function for another to work.

Your job is to implement each of the functions according to the comment above the function definition. Some of the functions involve Student objects. You can find the member variables and member functions of the Student class in the Student class file. One of the functions uses the BankAccount class that you implemented in part #2. You will need to finish the BankAccount class before implementing this function.

Extra Credit Opportunity: The last two functions in the ArrayListPractice, UpdateGradeLevels and SortByGradeAndName, are extra credit.

Unit Tests

Along with Main, the green-play dropdown includes ready-made options for running tests:

• ShapeMakerTest, BankAccountTest, ArrayListPracticeTest
• AllTestsNoExtraCredit (required tests only)
• ShapeMakerExtraCreditTest, ArrayListPracticeExtraCreditTest
• AllTestsWithExtraCredit

These let you run tests without leaving the source file you are editing. Recommended order: after you implement PrintSquare, run ShapeMakerTest first; then continue ShapeMaker → BankAccountTest → ArrayListPracticeTest. Use AllTestsNoExtraCredit once all required parts pass.

We'll learn more about unit tests in the next unit, but for now: a passing test means you are on the right track. The provided tests are not comprehensive — they do not cover every possible input — so they do not guarantee your code is completely correct. Still, a major portion of the grade is based on these tests, so run them before you turn the project in. You only need the Extra Credit options if you plan to attempt the extra credit.

Bonus Assignment

Before you work on the bonus assignment, make sure you commit and push, so you don't accidentally break your program for the rest of the assignment. Modify BankAccountManager to support two more commands:

Command	Description
AddUser ("AddUser John 40")	First check if an account already exists with the given name. If it does, print an error such as "Sorry, that user already exists. Please pick a new name". If there is no account with that name, then create a new account with that name and balance.
SwitchUser ("SwitchUser John")	If the user doesn't exist, print an error ("Sorry, that user doesn't exist. Please create an account for that user first."). Switch the current bank account to the account specified. Once you switch users all of the other commands apply to the new user (Balance shows the new user's balance). For example, if the current account name is "Amy", and the input is "SwitchUser John", first check if the account exists. If it does, set it as the current account. Now when the user inputs "Deposit 10", it will add 10 to John's account.

In order to support this functionality, you will need to keep track of and store all of the bank accounts. To do that, you will need to use an ArrayList. Whenever you create a new bank account object, you will need to add the bank accounts to this array. You'll need to do this in two places: when you create the first account and when you call "AddUser". When "SwitchUser" is called, you will need to switch the current account to the new account that is specified. You should create a helper function to go through the array and return the account with a given name.

Note: You should not do this in the BankAccount class. In our program, each class has a responsibility. BankAccount has the responsibility to do all operations associated with a single BankAccount. BankAccountManager has the responsibility to tell the BankAccount objects what to do (this includes creating them, storing them, and telling them to deposit or withdraw). So we should be creating the ArrayList and adding all of the new functionality in our BankAccountManager class, and using that to store and fetch BankAccounts. FYI, this isn't the only way to design this program, but it's the way I chose to design it.

A Note About Extra Credit and Bonus Assignments

You may have noticed that there are a lot of extra credit opportunities and bonus assignments in this project. That will be a common theme in all of our projects. Our goal is to challenge you by giving you assignments that are just a little above what you are comfortable with, because working on problems at that level is when you learn the most. We have extra credit to challenge students at all levels. This means different parts of the extra credit are different levels of difficulty. Some are similar difficulty to the assignment, and some are significantly harder. Try as much of the extra credit as you feel is within your grasp, and don't feel discouraged if parts of the extra credit doesn't make sense. They're designed to be hard!

In terms of grades, you can achieve Exceeds Expectations by doing all of the ShapeMaker extra credit and the UpdateGradeLevels function in ArrayListPractice. However, if you feel up to the challenge, we encourage you try as much of the extra credit as you can.

Committing your Changes and Turning In The Project

At the end of every class period, you should commit your changes. "Committing your changes" is basically a fancy way of saving the changes you made. It is very important and useful for two reasons:

1. You save your changes online, so you can never lose them. Even if your computer breaks, your changes will still be saved somewhere.
2. You can go back to any previous version that you committed. So if you accidentally make a wrong change that breaks your program, you can always go back to a state where the program was working.

You can commit and push ("push" means send it to GitHub.com to save it there) from IntelliJ:

1. Click Git > Commit… (or use the Commit tool window).
2. Review the changed files. You can double-click a file to see the diff.
3. Enter a short commit message, then choose Commit and Push….
4. Confirm the push to your repository's main branch.
5. On GitHub, confirm your latest commits are visible.

Pushing to main is how you turn in work for this assignment. Autograding runs on those pushes. You can keep improving and pushing after the deadline if your teacher allows late work — ask about any late penalty.

Grading

Your grade for each project will fall into one of four categories:

Grade Level	Explanation
Exceeds Expectations	Quality is outstanding. Extra credit and/or independent improvements apparent. All tests are passing.
Excellent	Overall quality is high. All tests are passing.
Satisfactory	Overall quality is good. Most tests are passing. Improvements can be made to bring the quality up to Excellent.
Needs Improvement	Overall quality is not yet high enough and the submission will not be accepted. Improvements must be made to bring the quality up to at least Satisfactory.