Java Journal Template

Java Journal Template Directions: Follow the directions for each part of the journal template. Include in your response all the elements listed under the Requirements section. Prompts in the Inspiration section are not required; however, they may help you to fully think through your response. Remember to review the Touchstone page for entry requirements, examples, and grading specifics. Name: Cameron Thistle Date: 03/19/2023 Complete the following template. Fill out all entries using complete sentences. 1 PART 1: Defining Your Problem Task State the problem you are planning to solve. Requirements ● Describe the problem you are trying to solve. ● Describe any input data you expect to use. ● Describe what the program will do to solve the problem. ● Describe any outputs or results the program will provide. Inspiration When writing your entry below, ask yourself the following questions: ● Is your problem clearly defined? ● Why do you want to solve this particular problem? ● What source(s) of data do you believe you will need? Will the user need to supply that data, or will you get it from an external file or another source? ● Will you need to interact with the user throughout the program? Will users continually need to enter data in and see something to continue? ● What are your expected results or what will be the end product? What will you need to tell a user of your program when it is complete? Random Number Generator – The basic principle of the project is to input a value between 1 and 20 and press initialize the code. A user wins if their guess matches the computer's guess. If not, one loses, though. The difficulty is that each guess entry is limited to one. Thus, the odds of matching the Random generated value are very little. Firstly, will need to create two classes (Main.java and GameLog). Then in the GameLog.Java file, I will create rules for the game and a method for generating random numbers. To synthesize different numbers, I will import the java.util.Random class and then create an instance of it with the following syntax: Random rand = new Random (). Additionally, there will be logic for taking in user input and comparing it based on the rules and random numbers generated from Gamelog.Java class. Thus, the final out of winning or losing will be given here. Finally, in the main file, it will give a welcoming message and the GameLog class will be imported to give feedback to the user on win/lose, to continue playing and give a goodbye message on closure. 2 PART 2: Working Through Specific Examples Task Write down clear and specific steps to solve a simple version of your problem you identified in Part 1. Requirements Complete the three steps below for at least two distinct examples/scenarios. ● State any necessary input data for your simplified problem. ● Write clear and specific steps in English (not Java) detailing what the program will do to solve the problem. ● Describe the specific result of your example/scenario. Inspiration When writing your entry below, ask yourself the following questions: ● Are there any steps that you don’t fully understand? These are places to spend more time working out the details. Consider adding additional smaller steps in these spots. ● Remember that a computer program is very literal. Are there any steps that are unclear? Try giving the steps of your example/scenario to a friend or family member to read through and ask you questions about parts they don’t understand. Rewrite these parts as clearly as you can. ● Are there interesting edge cases for your program? Try to start one of your examples/scenarios with input that matches this edge case. How does it change how your program might work? Scenario 1 1. Deciding not to play the game. Scenario 2 1. 2. 3. 4. Play game Picks numbers between 1 and 20. The number does not match the generated one and the user loses. Deciding Not to play game Scenario 3 1. Play game 2. Picks a number between 1 and 20 3. The number does not match the generated one and the user loses 4. Deciding to continue playing the game Scenario 4 1. 2. 3. 4. Playing game. Picking numbers between 1 and 20. The number matches with the generated one. Deciding to stop playing the game. 3 PART 3: Generalizing Into Pseudocode Task Write out the general sequence your program will use, including all specific examples/scenarios you provided in Part 2. Requirements ● Write pseudocode for the program in English but refer to Java program elements where they are appropriate. The pseudocode should represent the full functionality of the program, not just a simplified version. Pseudocode is broken down enough that the details of the program are no longer in any paragraph form. One statement per line is ideal. Help With Writing Pseudocode ● Here are a few links that can help you write pseudocode with examples. Remember to check out part 3 of the Example Journal Template Submission if you have not already. Note: everyone will write pseudocode differently. There is no right or wrong way to write it, other than to make sure you write it clearly and in as much detail as you can so that it should be easy to convert to code later. ○ https://www.geeksforgeeks.org/how-to-write-a-pseudo-code/ ○ https://www.wikihow.com/Write-Pseudocode Inspiration When writing your entry below, ask yourself the following questions: ● Do you see common program elements and patterns in your specific examples/scenarios in Part 2, like variables, conditionals, functions, loops, and classes? These should be part of your pseudocode for the general sequence as well. ● Are there places where the steps for your examples/scenarios in Part 2 diverged? These may be places where errors may occur later in the project. Make note of them. ● When you are finished with your pseudocode, does it make sense, even to a person that does not know Java? Aim for the clearest description of the steps, as this will make it easier to convert into program code later. 1. Main Welcome user Call all methods and logic from Game Log Class Show whether lost or won Give the option to play or not Close and Give a Goodbye message. 2. Class Game Log Set Rules Create Play method() Get User Input (Between 1 and 20) Generate random number Compare and give win/loss. 4 PART 4: Testing Your Program Task While writing and testing your program code, describe your tests, record any errors, and state your approach to fixing the errors. Requirements ● For at least one of your test cases, describe how your choices for the test helped you understand whether the program was running correctly or not. For each error that occurs while writing and testing your code: ● Record the details of the error from Replit. A screenshot or copy-and-paste of the text into the journal entry is acceptable. ● Describe what you attempted in order to fix the error. Clearly identify which approach was the one that worked. Inspiration When writing your entry below, ask yourself the following questions: ● Have you tested edge cases and special cases for the inputs of your program code? Often these unexpected values can cause errors in the operation of your program. ● Have you tested opportunities for user error? If a user is asked to provide an input, what happens when they give the wrong type of input, like a letter instead of a number, or vice versa? ● Did the outcome look the way you expected? Was it formatted correctly? ● Does your output align with the solution to the problem you coded for? I had errors like the following while trying to key in any alphabet instead of numbers run the program:- 5 Upon fixing all the errors the successful output was shown below:- Another successful example of closing the program was:- 6 PART 5: Commenting Your Program Task Submit your full program code, including thorough comments describing what each portion of the program should do when working correctly. Requirements ● The purpose of the program and each of its parts should be clear to a reader that does not know the Java programming language. Inspiration When writing your entry, you are encouraged to consider the following: ● Is each section or sub-section of your code commented to describe what the code is doing? ● Give your code with comments to a friend or family member to review. Add additional comments to spots that confuse them to make it clearer. 7 The code files are Two as shown below:(Main.java) //importing library utility import java.util.Scanner; //main class public class Main { public static void main(String[] args) { // Greet user System.out.println("Welcome to Random Number Generator!\n"); // GameLog newgame = new GameLog(); // import previous class with the play function and rules // Display the rules newgame.rules(); // Ask user if they want to play System.out.println("Do you want to play now? (1 = Yes / 0 = No) "); Scanner playControl = new Scanner(System.in); int doPlay = playControl.nextInt(); // Loops play as long as doPlay = 1 while (doPlay == 1) { newgame.play(); System.out.println("Do you want to play again? (1 = Yes / 0 = No) "); doPlay = playControl.nextInt(); } // Display goodbye message System.out.println("Good Bye. Thank you for playing.\n\n"); } } (GameLog.java) //importing java utility libraries import java.util.Scanner; import java.util.Random; //creating a java class public class GameLog { // creating the rules for the game public void rules() { // Display the rules of game System.out.println(" --- Listed below are the rules of the game:"); System.out.println("Enter a number between 1 and 20 and press enter."); System.out.println("If you pick a number at random and is equivalent to the computer’s guess, you win!"); System.out.println("If not, then you lose. Remember, you are only allocated one! Have Fun.\n\n"); 8 } // creating the method (function) of playing public void play() { // The engine that runs the game // Prompt user for input / guess System.out.print("Ok, so what is your guess? (Between 1-20)"); Scanner input = new Scanner(System.in); int userNum = input.nextInt(); // Generate a random number (computer’s number) in the range 1-20 // 1 is added after receiving the random number, change from 0-19 to 1-20 Random randNum = new Random(); int cpuNum = 1 + randNum.nextInt(20); // If user’s input number matches computer’s number display it will give output of “You Win!” if (userNum == cpuNum) { System.out.println("\nYou Win!\n\n"); } else { // Otherwise display “You Lose!” and the computer’s number System.out.printf("\nYou Lose! The computer guessed %d\n\n", cpuNum); } } The Output is shown below:- PART 6: Your Completed Program Task Provide the Replit link to your full program code. Requirements ● The program must work correctly with all the comments included in the program. Inspiration ● Check before submitting your Touchstone that your final version of the program is running successfully. 9 https://replit.com/@cameronthistle/Game-Test 10