Javadocs and code cleanup

src/main/java/ch/zhaw/gartenverwaltung/backgroundtasks/BackgroundTasks.java

@@ -17,12 +17,25 @@ import java.util.TimerTask;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
+/**
+ * Class with tasks which must be executed periodic and not triggered by user. Method run must be called in a fix interval.
+ */
 public class BackgroundTasks extends TimerTask {
     private static final Logger LOG = Logger.getLogger(CropDetailController.class.getName());
     private final TaskList taskList;
     private final Notifier notifier;
     private final WeatherGradenTaskPlanner weatherGardenTaskPlaner;
 
+    public BackgroundTasks(TaskList taskList, CropList cropList, PlantList plantList) {
+        this.taskList = taskList;
+        notifier = new Notifier(taskList, plantList, cropList);
+        weatherGardenTaskPlaner = new WeatherGradenTaskPlanner(taskList, plantList, cropList);
+    }
+
+    /**
+     * Changes the field "nextExecution" of all tasks if it's in the past to the actual date as long as they are not done.
+     * @throws IOException if the taskList can't be read.
+     */
     private void movePastTasks() throws IOException {
         List<Task> taskList = this.taskList.getTaskList(LocalDate.MIN.plusDays(1), LocalDate.now().minusDays(1));
         for (Task task : taskList) {
@@ -33,12 +46,9 @@ public class BackgroundTasks extends TimerTask {
         }
     }
 
-    public BackgroundTasks(TaskList taskList, CropList cropList, PlantList plantList) {
+    /**
-        this.taskList = taskList;
+     * Method to call if Tasks should be executed. It calls all Background tasks after each other.
-        notifier = new Notifier(taskList, plantList, cropList);
+     */
-        weatherGardenTaskPlaner = new WeatherGradenTaskPlanner(taskList, plantList, cropList);
-    }
-
     @Override
     public void run() {
         try {

src/main/java/ch/zhaw/gartenverwaltung/backgroundtasks/Notifier.java

@@ -13,6 +13,9 @@ import javax.mail.MessagingException;
 import java.io.IOException;
 import java.time.LocalDate;
 
+/**
+ * Class to send Notifications to the user
+ */
 public class Notifier {
     private final TaskList taskList;
     private final CropList cropList;
@@ -25,6 +28,13 @@ public class Notifier {
         this.plantList = plantList;
     }
 
+    /**
+     * Method to send a Notification to the user for e specific Task
+     * @param task The task to use for notification
+     * @throws IOException if tasklist can not be read
+     * @throws MessagingException if E-Mail can not be sent for any reason
+     * @throws HardinessZoneNotSetException if hardiness zone is not set in plant list.
+     */
     private void sendNotification(Task task) throws IOException, MessagingException, HardinessZoneNotSetException {
         String plantName = "unkown plant";
         if(cropList.getCropById((task.getCropId())).isPresent()){
@@ -38,6 +48,12 @@ public class Notifier {
         eMailSender.sendMails(Settings.getInstance().getMailNotificationReceivers(), messageSubject, messageText);
     }
 
+    /**
+     * Sends a notification to the user for each task which is due and not done every day as long as it's not done.
+     * @throws IOException if tasklist can not be read
+     * @throws MessagingException if E-Mail can not be sent for any reason
+     * @throws HardinessZoneNotSetException if hardiness zone is not set in plant list.
+     */
     public void sendNotifications() throws IOException, MessagingException, HardinessZoneNotSetException {
         for (Task task : taskList.getTaskList(LocalDate.MIN, LocalDate.MAX)) {
             if (task.getNextNotification() != null && task.getNextNotification().isBefore(LocalDate.now().minusDays(1))) {

src/main/java/ch/zhaw/gartenverwaltung/backgroundtasks/email/EMailSender.java

@@ -10,16 +10,20 @@ import java.util.Arrays;
 import java.util.Date;
 import java.util.List;
 
+/**
+ * Class to send E-Mails
+ */
 public class EMailSender {
 
-
+    /**
-    public EMailSender(){
+     * Method to send E-Mail to one or multiple recipients
-
+     * @param recipients recipients E-Mail addresses separated by ";"
-    }
+     * @param subject Subject of the E-Mail
-
+     * @param text E-Mail message Text as rear text or html
+     * @throws MessagingException If sending the E-Mail fails for any reason
+     */
     public void sendMails(String recipients, String subject, String text) throws MessagingException {
-        // TODO replace printMail with implementation
+        printMail(recipients, subject, text);
-        printMail(recipients, subject, text); // TODO Remove Printing E-Mail to console to test it
         MimeMessage message = new MimeMessage(Settings.getInstance().getSmtpCredentials().getSession());
         message.addHeader("Content-type", "text/HTML; charset=UTF-8");
         message.addHeader("format", "flowed");

src/main/java/ch/zhaw/gartenverwaltung/backgroundtasks/email/SmtpCredentials.java

@@ -5,6 +5,10 @@ import javax.mail.Session;
 import java.net.Authenticator;
 import java.util.Properties;
 
+/**
+ * Class to store SMTP Credentials to send E-Mails and create
+ * corresponding Session Object
+ */
 public record SmtpCredentials(
         String host,
         String port,
@@ -14,6 +18,10 @@ public record SmtpCredentials(
         boolean startTLS
         ) {
 
+    /**
+     * Creates a Properties Object with SMTP Server Information
+     * @return the created Properties Object
+     */
     private Properties getProperties() {
         Properties properties = new Properties();
         properties.put("mail.smtp.host", host);
@@ -23,6 +31,10 @@ public record SmtpCredentials(
         return properties;
     }
 
+    /**
+     * Creates a javax.mail.Authenticator Object with username and password for SMTP Server
+     * @return the created javax.mail.Authenticator Object
+     */
     private javax.mail.Authenticator getAuthenticator() {
         return new javax.mail.Authenticator() {
             @Override
@@ -32,10 +44,11 @@ public record SmtpCredentials(
         };
     }
 
+    /**
+     * Method to get the Session Instance with the given SMTP Credentials
+     * @return the Session Instance
+     */
     public Session getSession() {
         return Session.getInstance(getProperties(), getAuthenticator());
     }
-
-
-
 }

src/main/java/ch/zhaw/gartenverwaltung/backgroundtasks/weather/SevereWeather.java

@@ -1,5 +1,8 @@
 package ch.zhaw.gartenverwaltung.backgroundtasks.weather;
 
+/**
+ * Enum of possible Weather events
+ */
 public enum SevereWeather {
     FROST,SNOW,HAIL,NO_SEVERE_WEATHER,RAIN
 }

src/main/java/ch/zhaw/gartenverwaltung/backgroundtasks/weather/WeatherGradenTaskPlanner.java

@@ -17,7 +17,6 @@ import static java.util.stream.Collectors.toList;
 
 /**
  * The WeatherGardenTaskPlanner creates Tasks based on weather events and the rain amount from the last days
- *
  */
 public class WeatherGradenTaskPlanner {
     private final TaskList taskList;

src/main/java/ch/zhaw/gartenverwaltung/backgroundtasks/weather/WeatherService.java

@@ -1,7 +1,6 @@
 package ch.zhaw.gartenverwaltung.backgroundtasks.weather;
 /**
  * The WeatherService is a class to cause weather events for the WeatherGardenTaskPlanner
- *
  */
 public class WeatherService {
     private static final int NO_RAIN = 0;
@@ -9,6 +8,11 @@ public class WeatherService {
     private static final int RAIN = 25;
     private static final int HEAVY_RAIN = 50;
 
+    /**
+     * Method to simmulate a Weather Service for testing
+     * @param randomWeather random int. Range: 1-3
+     * @return the selected SevereWeather
+     */
     public SevereWeather causeSevereWeather(int randomWeather) {
         return switch (randomWeather) {
             case 1 -> SevereWeather.HAIL;
@@ -19,6 +23,11 @@ public class WeatherService {
 
     }
 
+    /**
+     * Method to simulate a Weather Service for testing
+     * @param randomRainAmount random int. Range: 1-4
+     * @return the selected rain amount
+     */
     public int causeRainAmount(int randomRainAmount) {
         return switch (randomRainAmount) {
             case 1 -> NO_RAIN;

src/main/java/ch/zhaw/gartenverwaltung/bootstrap/AppLoader.java

@@ -152,6 +152,11 @@ public class AppLoader {
                 });
     }
 
+    /**
+     * Method to get any AppDependency
+     * @param type Class of Dependency
+     * @return the App dependency
+     */
     public Object getAppDependency(Class<?> type) {
         return dependencies.get(type.getSimpleName());
     }

src/main/java/ch/zhaw/gartenverwaltung/io/HardinessZoneNotSetException.java

@@ -1,5 +1,8 @@
 package ch.zhaw.gartenverwaltung.io;
 
+/**
+ * Exceptionm which is thrown if Hardiness zone is not set in plant list.
+ */
 public class HardinessZoneNotSetException extends Exception {
     public HardinessZoneNotSetException() {
         super("HardinessZone must be set to retrieve plants!");

src/main/java/ch/zhaw/gartenverwaltung/io/InvalidJsonException.java

@@ -2,6 +2,9 @@ package ch.zhaw.gartenverwaltung.io;
 
 import java.io.IOException;
 
+/**
+ * Excption which is thrown if a JSON file has a invalid File format.
+ */
 class InvalidJsonException extends IOException {
     public InvalidJsonException(String reason) {
         super(reason);

src/main/java/ch/zhaw/gartenverwaltung/models/PlantNotFoundException.java

@@ -1,5 +1,8 @@
 package ch.zhaw.gartenverwaltung.models;
 
+/**
+ * Exception which is thrown if there is no plant in plant Database with the given id.
+ */
 public class PlantNotFoundException extends Exception {
     public PlantNotFoundException() {
         super("The selected Plant was not found in Database!");

src/main/java/ch/zhaw/gartenverwaltung/types/Crop.java

@@ -40,7 +40,6 @@ public class Crop {
     public Optional<Long> getCropId() {
         return Optional.ofNullable(cropId);
     }
-
     public long getPlantId() { return plantId; }
     public LocalDate getStartDate() { return startDate; }
     public double getArea() { return area; }

src/main/java/ch/zhaw/gartenverwaltung/types/TaskTemplate.java

@@ -4,6 +4,9 @@ import com.fasterxml.jackson.annotation.JsonProperty;
 
 import java.time.LocalDate;
 
+/**
+ * Class which represents a Task if the start and enddate is not known yet.
+ */
 public class TaskTemplate {
     @JsonProperty
     private final String name;