Updated.

Author: Senethys

clock/Alarm.java

@@ -3,12 +3,12 @@
 /*
 * Object oriented programming with Java
 * Spring 18
-* Assignment 1
+* Assignment 1  Second revision.
 * File:         Alarm.java (MWE)
 * Description:  Simple program that simulates a clock with alarm functionality.
-* Author:       Svitri Magnusson
+* @author:      Svitri Magnusson
 * CS username:  kv13smn
-* Date:         2018-04-03
+* Date:         2018-04-23
 * Input:        void
 * Output:       console prints
 * Run: javac -cp /usr/share/java/junit4.jar <filenames>
@@ -35,11 +35,15 @@ public static void main(String[] args) throws LimitException {
                 System.out.println(alarm.getTime());
 
         }
+
+        System.out.printf("*Rewinding the clock to %02d:%02d*\n", hour, minute-1);
         alarm.setTime(13,36);
         System.out.println(alarm.getTime());
-        System.out.println(alarm.isTriggered());
+        System.out.println("Is the alarm triggered?: " + alarm.isTriggered());
+        System.out.println("*TICK*");
         alarm.timeTick();
-        System.out.println(alarm.isTriggered());
+        alarm.getTime();
+        System.out.println("Is the alarm triggered?: " + alarm.isTriggered());
 
     }
 }

clock/AlarmClock.java

@@ -1,18 +1,44 @@
 package clock;
 
+/*
+* Object oriented programming with Java
+* Spring 18
+* Assignment 1
+* File:         AlarmClock.java
+* Description:  This class is inherited from Clock.java and adds functions to set a time
+*               when the users wants the alarm to go off.
+* Author:       Svitri Magnusson
+* CS username:  kv13smn
+* Date:         2018-04-23
+* Input:        void
+* Output:       console prints
+* Run: javac -cp /usr/share/java/junit4.jar <filenames>
+* java -cp -cp .:/usr/share/java/junit4.jar org.junit.runner.JUnitCore <main>
+*
+*/
+
 public class AlarmClock extends Clock {
 
     private String alarmTime;
     private boolean status = true;
 
     AlarmClock() throws LimitException { }
 
+    /* Creates an alarm clock object at specified time
+    * for the alarm to go off.
+    * @param hour, minute When the alarm will go off.
+    * @throws LimitException if the values are set outside interval.
+    */
     AlarmClock(int hour, int minute) throws LimitException {
         setAlarm(hour, minute);
     }
 
 
-    //Denna metod används för att ställa ett larm.
+    /* Sets a new time for the alarm to go off.
+    * Also activates the alarm if it was shut off.
+    * @param hour, minute When the alarm will go off.
+    * @throws LimitException if the values are set outside interval.
+    */
     public void setAlarm(int hour, int minute) throws LimitException {
         if (hour > 24 || hour < 0 || minute < 0 || minute > 59) {
             throw new LimitException("Min is bigger tha max limit!");
@@ -23,25 +49,26 @@ public void setAlarm(int hour, int minute) throws LimitException {
     }
 
 
-    //Denna metod används för att avläsa om alarmet ringer (returnerar en bool).
+    /*Asks if an alarm has gone off. Compares current time with set time.
+    * @return Triggered boolean.
+    */
     public boolean isTriggered() {
 
         if(this.getTime().equals(this.alarmTime) && this.status) {
             System.out.println("alarm");
-            this.status = false;
             return true;
         }
         return false;
     }
 
 
-    //Denna metod används för att slå på ett larm.
+    //Turns an alarm on.
     public void turnOn() {
         this.status = true;
 
     }
 
-    //Denna metod används för att stänga av ett larm.
+    //Turns alarm off. Alarm can still be set, but won't work if it's off. 
     public void turnOff() {
         this.status = false;
 

clock/AlarmClockTest.java

@@ -5,6 +5,23 @@
 
 import static org.junit.Assert.*;
 
+/*
+* Object oriented programming with Java
+* Spring 18
+* Assignment 1
+* File:         AlarmClockTest.java (MWE)
+* Description:  This class is inherited from Clock.java and adds functions to set a time
+*               when the users wants the alarm to go off.
+* Author:       Svitri Magnusson
+* CS username:  kv13smn
+* Date:         2018-04-23
+* Input:        void
+* Output:       console prints
+* Run: javac -cp /usr/share/java/junit4.jar <filenames>
+* java -cp -cp .:/usr/share/java/junit4.jar org.junit.runner.JUnitCore <main>
+*
+*/
+
 public class AlarmClockTest {
 
 
@@ -25,6 +42,11 @@ public void shouldThrowLimitExceptionMinutes() throws Exception {
         Clock n = new AlarmClock(2, -23);
     }
 
+    @Test(expected = LimitException.class)
+    public void shouldThrowIllegalArgumentException() throws Exception {
+        Clock n = new AlarmClock(-2, -23);
+    }
+
 
     @Test
     public void initialStateTest() throws Exception {
@@ -34,35 +56,58 @@ public void initialStateTest() throws Exception {
 
 
     @Test
-    public void setAlarmTimeTest() throws Exception {
+    public void setAlarmTimeTest0() throws Exception {
         AlarmClock n = new AlarmClock();
         n.setAlarm(13,37);
         n.setTime(13,36);
         assertFalse(n.isTriggered());
+    }
+
+    @Test
+    public void setAlarmTimeTest1() throws Exception {
+        AlarmClock n = new AlarmClock();
+        n.setAlarm(13,37);
+        n.setTime(13,36);
         n.timeTick();
         System.out.println(n.getTime());
         assertTrue(n.isTriggered());
         n.timeTick();
-        System.out.println(n.getTime());
-        assertFalse(n.isTriggered());
-
     }
 
 
     @Test
-    public void alarmSwitchTest() throws Exception {
+    public void alarmSwitchTest0() throws Exception {
         AlarmClock n = new AlarmClock();
         n.setAlarm(13,37);
         n.turnOff();
         n.setTime(13,36);
         assertFalse(n.isTriggered());
+    }
+
+    @Test
+    public void alarmSwitchTest1() throws Exception {
+        AlarmClock n = new AlarmClock();
+        n.setAlarm(13,37);
+        n.turnOff();
+        n.setTime(13,36);
         n.timeTick();
         System.out.println(n.getTime());
         assertFalse(n.isTriggered());
+    }
 
+    @Test
+    public void alarmSwitchTest2() throws Exception {
+        AlarmClock n = new AlarmClock();
+        n.setAlarm(13,37);
+        n.turnOff();
+        n.setTime(13,36);
+        n.timeTick();
+        System.out.println(n.getTime());
         n.setAlarm(13,37);
         n.setTime(13,36);
         n.timeTick();
         assertTrue(n.isTriggered());
     }
+
+
 }

clock/Clock.java

@@ -1,12 +1,44 @@
 package clock;
 
+/*
+* Object oriented programming with Java
+* Spring 18
+* Assignment 1
+* File:         Clock.java
+* Description:  Consists of two display classes. Basically a digital clock.
+* @author:      Svitri Magnusson
+* CS username:  kv13smn
+* Email:        [email protected]
+* Date:         2018-04-23
+* Input:        void
+* Output:       console prints
+*
+* Run: javac -cp /usr/share/java/junit4.jar <filenames>
+* java -cp -cp .:/usr/share/java/junit4.jar org.junit.runner.JUnitCore <main>
+*
+*/
+
 public class Clock {
 
     private NumberDisplay minutes = new NumberDisplay(0, 59);
     private NumberDisplay hours = new NumberDisplay(0, 23);
     private String displayString;
 
+    /* Creates a Clock object.
+    * @param hour, minute
+    *
+    * Default value will be set to 0, 0 if not arguments given.
+    * one display for hours and one for minutes.
+    *
+    * @throws LimitException if the display values are outside
+    * of the set limits.
+    * @see NumberDisplay
+    */
+
     Clock() throws LimitException {
+        if ( this.minutes == null || this.hours == null) {
+            throw new IllegalArgumentException("Cannot assign null!");
+        }
         this.minutes.setValue(0);
         this.hours.setValue(0);
     }
@@ -16,6 +48,7 @@ public class Clock {
         this.hours.setValue(hour);
     }
 
+    // Simulates the increase of one time unit.
     public void timeTick() {
         if(minutes.didWrapAround()) {
             this.hours.increment();
@@ -27,23 +60,26 @@ public void timeTick() {
 
     }
 
+    /* Sets the clock to provided time.
+    * @param hour, minute
+    * @throws LimitException if the values are set outside interval.
+    */
+
     public void setTime(int hour, int minute) throws LimitException {
         this.minutes.setValue(minute);
         this.hours.setValue(hour);
-
     }
 
+    //Gets the current time of the clock as a formatted string.
     public String getTime() {
         String min = minutes.getDisplayValue();
         String hour = hours.getDisplayValue();
         String result = String.format("%s:%s", hour, min);
         return result;
     }
 
-
+    //Updates the display attribute.
     private void updateDisplay() {
         this.displayString = this.getTime();
     }
-
-
 }