Untitled

This guide walks through how to make progress on the homework. The Homework Testing guide goes into more detail on how to test the homework code locally and remotely.

Table of Contents

Working on Homework

To figure out what you need to do for a homework assignment, you need to look at the following:

• Look at the homework writeup. For example, FileStemmer gives a brief description of the homework assignment along with some hints.
• Look at the homework code and comments. There should be TODO comments in the code indicating where you need to add code. The /** ... */ Javadoc comments in the code indicate what functionality you need to implement. It can be helpful to view these in the “Javadoc” viewer in Eclipse.
• Look at the homework tests. The tests give you an idea of the desired output for different test cases. It can be helpful to view these in the”JUnit” viewer in Eclipse.

When you are addressing the TODO comments in the code, you may:

• You MAY add additional members and methods as needed to the code.
• You MAY add additional classes and imports for those classes as long as they are a part of core Java or one of the pre-approved third-party libraries (Apache OpenNLP, Apache Commons Text, Apache Log4j2, Jetty, MariaDB).
• You MAY add comments to clarify code for yourself. You can add comments to already defined methods if you want.
• You MAY change a return statement in a method with a TODO comment as needed. (You may not change the return type in the method declaration, however.)
• You MAY remove the main method if you do not need it for debugging.
• You MAY remove the TODO comments when you are done. This removes them from the “Tasks” view in Eclipse. If you want to keep the comment around, you can change the text TODO to DONE instead.

However, be careful to avoid making the following modifications: