Add Javadoc comments for improved code clarity and maintainability.

Author: annikaholmqvist94

src/main/java/com/example/HelloController.java

@@ -1,35 +1,60 @@
 package com.example;
 
 import javafx.beans.binding.Bindings;
-import javafx.collections.FXCollections;
-import javafx.event.ActionEvent;
+
 import javafx.fxml.FXML;
-import javafx.geometry.Pos;
+
 import javafx.scene.control.*;
-import javafx.scene.layout.HBox;
-import javafx.scene.layout.Priority;
-import javafx.scene.text.TextFlow;
+
 import javafx.stage.FileChooser;
 import javafx.stage.Stage;
 
 import java.io.File;
-import java.io.FileNotFoundException;
-import java.util.Arrays;
 
+
+
+/**
+ * Controller layer: Manages the user interface and mediates communication between the View (FXML) and the Model (HelloModel).
+ * Handles user interactions such as sending messages, attaching files, and displaying chat content.
+ */
 public class HelloController {
 
-    // Uppdaterad för att använda den externa Ntfy-servern: https://ntfy.fungover.org
-    // Topicen "mytopic" läggs till automatiskt av modellen.
-    private final HelloModel model = new HelloModel(new NtfyConnectionImpl("https://ntfy.fungover.org"));
 
+    private static final String HOST_NAME = System.getenv("HOST_NAME");
+
+
+
+
+
+    /**
+     * The model instance that holds application data and business logic.
+     * Initializes connection to the specified Ntfy server.
+     */
+    private final HelloModel model = new HelloModel(new NtfyConnectionImpl(HOST_NAME));
+
+
+    /**
+     * The ListView component displaying the list of chat messages.
+     */
     @FXML
     public ListView<NtfyMessageDto> chatListView;
+
+    /**
+     * The label displaying the current fixed topic being used.
+     */
     @FXML
     public Label topicLabel;
 
+    /**
+     * The label indicating the name of the file currently attached for sending.
+     */
     @FXML
     public Label attachedFileLabel;
 
+
+    /**
+     * The button used to send the message or the attached file.
+     */
     @FXML
     private Button sendButton;
 
@@ -39,6 +64,11 @@ public class HelloController {
     @FXML
     private Button attachFile;
 
+
+    /**
+     * Initializes the controller. This method is called automatically by the FXML loader.
+     * It sets up bindings between the view components and the model and configures the chat list view.
+     */
     @FXML
     private void initialize() {
         if (sendButton != null) {
@@ -95,8 +125,8 @@ private void initialize() {
     }
 
     /**
-     * En mycket enkel ListCell som enbart visar texten utan anpassad layout (bubblor/färger)
-     * men hanterar att visa "[File Uploaded]" när meddelandetexten är tom.
+     * A simple custom ListCell implementation for the chatListView.
+     * It displays the message text or a placeholder for file uploads, and indicates if the message was sent locally.
      */
     private static class SimpleMessageCell extends ListCell<NtfyMessageDto> {
 
@@ -126,6 +156,11 @@ protected void updateItem(NtfyMessageDto item, boolean empty) {
         }
     }
 
+
+    /**
+     * Handles the action of the send button.
+     * If a file is attached, it calls the model to send the file; otherwise, it calls the model to send the text message.
+     */
     @FXML
     protected void sendMessage() {
         if (model.fileToSendProperty().get() != null) {
@@ -141,6 +176,10 @@ protected void sendMessage() {
         }
     }
 
+    /**
+     * Handles the action of the attach file button.
+     * Opens a FileChooser dialog and sets the selected file in the model.
+     */
     @FXML
     protected void attachFile() {
         // Hämta scenen från en av kontrollerna

src/main/java/com/example/HelloModel.java

@@ -1,33 +1,24 @@
 package com.example;
 
-import com.fasterxml.jackson.databind.ObjectMapper;
-import io.github.cdimascio.dotenv.Dotenv;
+
 import javafx.application.Platform;
-import javafx.beans.InvalidationListener;
+
 import javafx.beans.property.ObjectProperty;
 import javafx.beans.property.SimpleObjectProperty;
 import javafx.beans.property.SimpleStringProperty;
 import javafx.beans.property.StringProperty;
 import javafx.collections.FXCollections;
-import javafx.collections.ListChangeListener;
+
 import javafx.collections.ObservableList;
 
 import java.io.File;
-import java.io.FileNotFoundException;
-import java.io.IOException;
-import java.net.URI;
-import java.net.http.HttpClient;
-import java.net.http.HttpRequest;
-import java.net.http.HttpResponse;
-import java.time.LocalDate;
-import java.time.format.DateTimeFormatter;
+
 import java.util.*;
-import java.util.concurrent.Executors;
-import java.util.concurrent.ScheduledExecutorService;
-import java.util.concurrent.TimeUnit;
+
 
 /**
  * Model layer: encapsulates application data and business logic.
+ * Manages the current message, topic, list of received messages, and connection to Ntfy.
  */
 public class HelloModel {
     private final NtfyConnection connection;
@@ -36,11 +27,18 @@ public class HelloModel {
     private final ObservableList<NtfyMessageDto> messages = FXCollections.observableArrayList();
     private final ObjectProperty<File> fileToSend = new SimpleObjectProperty<>(null); // Ny egenskap för filbilaga
 
+    /**
+     * Initializes the model and establishes connection to the specified Ntfy server.
+     * @param connection The Ntfy connection implementation to use (e.g., NtfyConnectionImpl or a Spy).
+     */
     public HelloModel(NtfyConnection connection) {
         this.connection = connection;
         connection.connect(currentTopic.get(), this::receiveMessage);
     }
-
+    /**
+     * Returns a standard greeting string.
+     * @return The greeting string.
+     */
     public String getGreeting() {
         return "Skicka meddelande";
     }
@@ -51,12 +49,14 @@ private static void runOnFx(Runnable task) {
             if (Platform.isFxApplicationThread()) task.run();
             else Platform.runLater(task);
         } catch (IllegalStateException notInitialized) {
-            // JavaFX toolkit not initialized (e.g., unit tests or CI without graphics): run inline
             task.run();
         }
     }
 
-
+    /**
+     * Sends the current text message to the Ntfy server via the connection.
+     * The message is added to the local list before sending.
+     */
     public void sendMessage() {
         String message = messageToSend.get();
         if (message != null && !message.trim().isEmpty()) {
@@ -82,7 +82,11 @@ public void sendMessage() {
         }
     }
 
-    // Argumentlös metod, som controlleren använder för att skicka den bifogade filen
+    /**
+     * Sends the currently attached file to the Ntfy server.
+     * The file's name and a temporary message are added to the local list before sending.
+     * The file attachment is cleared after sending.
+     */
     public void sendFile() {
         File file = fileToSend.get();
         if (file != null) {
@@ -108,46 +112,61 @@ public void sendFile() {
         }
     }
 
-    // Används av HelloController för att hämta filbilagan
+    /**
+     * Property for the file currently attached to be sent.
+     * @return The ObjectProperty containing the File object, or null if no file is attached.
+     */
     public ObjectProperty<File> fileToSendProperty() {
         return fileToSend;
     }
 
-    // Används av HelloController för att ställa in filbilagan
+    /**
+     * Sets the file to be sent with the next message.
+     * @param file The file to attach. Set to null to clear the attachment.
+     */
     public void setFileToSend(File file) {
         this.fileToSend.set(file);
     }
 
+
+    /**
+     * Handles an incoming message from the Ntfy connection and adds it to the message list on the FX thread.
+     * @param message The received NtfyMessageDto.
+     */
     private void receiveMessage(NtfyMessageDto message) {
-        // ANVÄNDER runOnFx FÖR ATT SÄKRA ATT UPPDATERINGEN SKER PÅ RÄTT TRÅD (eller direkt i testmiljö)
+
         runOnFx(() -> messages.add(message));
     }
 
+    /**
+     * Returns the observable list of messages received and sent.
+     * @return The ObservableList of NtfyMessageDto objects.
+     */
     public ObservableList<NtfyMessageDto> getMessages() {
         return messages;
     }
 
+    /**
+     * Property for the message currently being composed to send.
+     * @return The StringProperty holding the message content.
+     */
     public StringProperty messageToSendProperty() {
         return messageToSend;
     }
 
+    /**
+     * Property for the current Ntfy topic being subscribed to.
+     * @return The StringProperty holding the current topic name.
+     */
     public StringProperty currentTopicProperty() {
         return currentTopic;
     }
 
-    public void reconnectToTopic(String newTopic) {
-        if (!currentTopic.get().equals(newTopic)) {
-            // connection.disconnect(currentTopic.get()); // Förutsätter att disconnect implementeras i NtfyConnection
-            currentTopic.set(newTopic);
-
-            // Säkerställ att rensningen sker på FX-tråden om vi kör i en FX-miljö
-            runOnFx(messages::clear);
-
-            connection.connect(newTopic, this::receiveMessage);
-        }
-    }
 
-    // KORRIGERAD: Denna metod måste ta en String för att matcha testet!
+    /**
+     * Sets the message content to send. Used by the controller for bidirectional binding.
+     * @param message The new message content.
+     */
     public void setMessageToSend(String message) {
         this.messageToSend.set(message);
     }

src/main/java/com/example/NtfyConnectionImpl.java

@@ -15,6 +15,11 @@
 import java.util.concurrent.CompletableFuture;
 import java.util.function.Consumer;
 
+
+/**
+ * Implementation of NtfyConnection using Java's built-in HttpClient for both sending messages and subscribing to a topic.
+ * Manages the HTTP connection logic for text messages, file uploads.
+ */
 public class NtfyConnectionImpl implements NtfyConnection {
 
     private final HttpClient http = HttpClient.newHttpClient();
@@ -34,7 +39,10 @@ public NtfyConnectionImpl() {
         this.hostName = Objects.requireNonNull(dotenv.get("HOST_NAME"));
     }
 
-
+    /**
+     * Creates a new connection implementation.
+     * hostName The base URL of the Ntfy server.
+     */
     public NtfyConnectionImpl(String hostName) {
         this.hostName = hostName;
     }
@@ -44,6 +52,11 @@ public String getTopic() {
         return currentTopic;
     }
 
+
+    /**
+     * Establishes a connection to the Ntfy topic to receive messages in real-time.
+     * This method runs asynchronously in a dedicated thread.
+     */
     @Override
     public void connect(String newTopic, Consumer<NtfyMessageDto> messageHandler) {
 
@@ -82,7 +95,9 @@ public void connect(String newTopic, Consumer<NtfyMessageDto> messageHandler) {
 
 
     /**
-     * Skickar ett textmeddelande SYNKRONT (nödvändigt för integrationstester).
+     * Sends a text message to the specified Ntfy topic.
+     * @param message The text content of the message.
+     * @param topic The Ntfy topic to send the message to.
      */
     @Override
     public boolean send(String message, String topic) {

src/test/java/com/example/NtfyConnectionSpy.java

@@ -41,12 +41,12 @@ public void connect(String topic, Consumer<NtfyMessageDto> messageHandler) {
 
     @Override
     public void receive(Consumer<NtfyMessageDto> messageHandler) {
-        // Denna metod används inte längre i HelloModel men behålls för kompatibilitet.
+
     }
 
 
     @Override
-    public boolean send(String message, String topic) { // RETURTYPEN ÄNDRAD TILL BOOLEAN
+    public boolean send(String message, String topic) {
         // SPIONLOGIK: Spara det skickade meddelandet och ämnet
         this.lastSentMessage = message;
         this.lastSentTopic = topic;
@@ -74,7 +74,7 @@ public void simulateMessageReceived(NtfyMessageDto messageDto) {
         }
     }
 
-    // --- Getters för testverifieringar ---
+    // --- Getters för testverifieringar Topic behålls för flexibilitet att skapa fler chattrum---
 
     public String getLastSentMessage() {
         return lastSentMessage;