Days In A Month

From CompSciWiki
Revision as of 15:27, 8 December 2011 by RyanV (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Back to the Program-A-Day homepage

Problem

Write a Java program DaysInAMonth, that prompts for a month and year and determines the amount of days that will be in the month.

Your program should do the following:

  • prompt the user for the month as an integer (for this example we used 0 based on numbering i.e. 0 for Jan)
  • prompt the user for the year as an integer
  • some form of input validation, use sentinel values and determine if invalid month or years are entered
  • print out a friendly message to System.out stating the result


This problem will cover the following topics:


Example: User inputs "2" for the month and "2004" for the year would result in something like "February 2004 has 29 days."

 

...By Students

"I remember coming into COMP 1010 having taken AP Computer Science in high school. One thing to note is the KISS theory, Keep it Simple Stupid. In other words, don't over complicate the matter where even yourself can't understand your own code looking over it.

Back in my day it was a bit of a game to try and code the fewest lines as possible, I think now it is more about code readability and code cleanliness, the flow of logic. Does it make sense? Is it readable? Can someone easily follow the thought process?

You also don't realize how important and how much you will appreciate comments until you have to debug code that has not been commented or that you haven't touched in a while. I used to be lazy to comment one day I was at work and I had to fix a bug in a program that I wrote. It was quite the adventure trying to remember what I was thinking back when I wrote it to which I am now appreciative of comments that people write including my own. Computers are fast these days; one core, two core, three core, and more, and number of lines is a story of the past."


Solution

Start by importing the swing java package.

 import javax.swing.*;
import java.util.Scanner; 


Define your named constants and provide them with appropriate values, in this example there is one constant for 31 days one for 30 days and one for February. You can name them however you want but be sure to declare them as static constants since we are working in static main. Also note that it is declared outside of main, more often named constants are used throughout the java class where multiple functions can access it.

 final static int MONTH30 = 30;
final static int FEB = 28;
final static int MONTH31 = 31; 


Next define your local variables and initialize them to sentinel values for future error checking described later. We will need a year, monthNum and monthName as defined accordingly.

 int year, monthNum;
String monthName;
Scanner input = new Scanner(System.in);
	
//sentinel values for error checking 
monthNum = -1;
year = -1;
monthName = ""; 


Capturing the user input using Scanner and to make sure the user did not enter non-numeric value

 System.out.print("Please enter the month [Jan(1) to Dec(12)]: ");
if(input.hasNextInt())
{
	monthNum = input.nextInt();

	System.out.print("Please enter the Year: ");
	if(input.hasNextInt())
	{

                //code here

	}
	else
	{
		System.out.println("Please try again, there was an error with the month or the year you have entered");
	}
}
else
{
	System.out.println("Invalid month number entered, choose between 1 - 12 (Jan - Dec)");
} 
 Please enter the month [Jan(1) to Dec(12)]: abcd
Please enter the Year: 2009
Invalid input of month 
 Please enter the month [Jan(1) to Dec(12)]: 12
Please enter the Year: asdf
Invalid Input of Year 


Now we have to break up the problem into a series of cases and separate the conditions into if statements. The first 3 if statements is for error checking and validate the user input to make sure valid numbers were entered for month and year.

First case, if user left both month and year blank.

 if (monthNum <= 0 && year <= 999)		
	System.out.println("Please try again, there was an error with the month and the year you have entered"); 
 Please enter the month [Jan(1) to Dec(12)]: -1
Please enter the Year: 987
Please try again, there was an error with the month and the year you have entered 


Second case, if user entered an invalid monthNumber like a negative month number

 else if (monthNum <= 0)
{
	System.out.println("Please try again, there was an error with the month you have entered");	
} 
 Please enter the month [Jan(1) to Dec(12)]: -1
Please enter the Year: 2009
Please try again, there was an error with the month you have entered 


Third case, if user entered an invalid year, i.e. negative or in this problem we assume year 1000 is the first year

 else if (year <= 999)
{
	System.out.println("Please try again, there was an error with the month you have entered");	
} 
 Please enter the month [Jan(1) to Dec(12)]: 12
Please enter the Year: 987
Please try again, there was an error with the month you have entered 


The last case, which is most important since it is processing the valid input will be the next step. In this case there is a set of nested cases. Again, we will have to separate the conditions into statements. In this problem we separated the months by 31 days, 30 days, and February as a case of its own for calculating leap years.

Months with 31 days, since we are assuming Jan = 0, the condition will "or" all integer representations of the months with 31 days. Remember July and August are back to back months with 31 days! The first condition checks for the appropriate monthNum and the nested conditions will assign the appropriate monthName depending on which integer was chosen. There may be alternate solutions and methods to solve this problem but for the sake of example and topics to cover we have chosen this method. Lastly, System.out.println prints an meaningful output message.

 //JAN //MAR //MAY //JUL //AUG //OCT //DEC
if (monthNum == 1 || monthNum == 3 || monthNum == 5 || 
	monthNum == 7 || monthNum == 8 || monthNum == 10 ||
	monthNum == 12)
{
	if (monthNum == 1)
		monthName = "January";
	else if (monthNum == 3)
		monthName = "March";
	else if (monthNum == 5)
		monthName = "May";
	else if (monthNum == 7)
		monthName = "July";
	else if (monthNum == 8)
		monthName = "August";
	else if (monthNum == 10)
		monthName = "October";
	else if (monthNum == 12)
		monthName = "December";
		
	System.out.println(monthName + " " + year + " has " + MONTH31 + " days.");
} 
 Please enter the month [Jan(1) to Dec(12)]: 3
Please enter the Year: 2009
March 2009 has 31 days. 


The case of February checks if monthNum = 1 but for the nested conditions, it checks if the year is divisible by 4 by using the mod operator. If it is in fact a leap year, 1 is added to the constant.

 //FEB
else if (monthNum == 2)
{
	monthName = "February";

	//check for leap
	if (year % 4 == 0)
		System.out.println(monthName + " " + year + " has " + (FEB + 1) + " days.");
	else
		System.out.println(monthName + " " + year + " has " + FEB + " days.");				
} 
 Please enter the month [Jan(1) to Dec(12)]: 2
Please enter the Year: 2008
February 2009 has 29 days. 
 Please enter the month [Jan(1) to Dec(12)]: 2
Please enter the Year: 2009
February 2009 has 28 days. 


Months with 30 days are the last group of valid inputs to check. Similar to the months with 31 days, the first condition checks for an appropriate monthNum and the nested condition assigns the appropriate monthName.

 //APR //JUN //SEP //NOV
else if (monthNum == 4|| monthNum == 6 || monthNum == 9 || monthNum == 11)
{
	if (monthNum == 4)
		monthName = "April";
	else if (monthNum == 6)
		monthName = "June";
	else if (monthNum == 9)
		monthName = "September";
	else if (monthNum == 11)
		monthName = "November";
			
	System.out.println(monthName + " " + year + " has " + MONTH30 + " days.");
} 
 Please enter the month [Jan(1) to Dec(12)]: 11
Please enter the Year: 2009
November 2009 has 30 days. 


Lastly, for additional robustness, you can check if the user enters a monthNum that is too high. Remember, initially we checked for negative monthNum, but this time is now the opposite end of the spectrum where the monthNum is too beyond the scope. If the monthNum is too high output a meaningful error message.

 //number is larger than 11
else
	System.out.println("Invalid month number entered, choose between 1 - 12 (Jan - Dec)"); 
 Please enter the month [Jan(1) to Dec(12)]: 13
Please enter the Year: 2009
Invalid month number entered, choose between 1 - 12 (Jan - Dec) 


This concludes the program, compile and run.

Code

Solution Code

Back to the Program-A-Day homepage