From ab3a18d4df66aaf21fc84b0c66e8c61ab033b94f Mon Sep 17 00:00:00 2001 From: delvh Date: Sun, 27 Oct 2019 20:23:36 +0100 Subject: [PATCH] Updated Javadoc for the whole Repository Aside from the files ChatWindow, Client and SettingsScreen, theirs is already in my commit in f/settings --- src/main/java/envoy/client/Chat.java | 21 ++++++++++ src/main/java/envoy/client/Config.java | 42 +++++++++++++++---- .../envoy/client/ui/MessageListRenderer.java | 6 ++- src/main/java/envoy/client/ui/Startup.java | 2 +- .../envoy/client/ui/UserListRenderer.java | 5 ++- 5 files changed, 66 insertions(+), 10 deletions(-) diff --git a/src/main/java/envoy/client/Chat.java b/src/main/java/envoy/client/Chat.java index 3f48c7c..19ad291 100644 --- a/src/main/java/envoy/client/Chat.java +++ b/src/main/java/envoy/client/Chat.java @@ -10,11 +10,32 @@ public class Chat { private User recipient; private DefaultListModel model = new DefaultListModel<>(); + /** + * Provides the list of messages that the recipient receives.
+ * Saves the Messages in the corresponding chat at that Point. + * + * @param recipient the user who receives the messages + * @since Envoy v0.1-alpha + */ public Chat(User recipient) { this.recipient = recipient; } + /** + * @return the recipient of a message + * @since Envoy v0.1-alpha + */ public User getRecipient() { return recipient; } + /** + * Adds the received message at the current Point in the current chat + * + * @param message the message to add in said chat + * @since Envoy v0.1-alpha + */ public void appendMessage(Message message) { model.addElement(message); } + /** + * @return all messages in the current chat + * @since Envoy v0.1-alpha + */ public DefaultListModel getModel() { return model; } } \ No newline at end of file diff --git a/src/main/java/envoy/client/Config.java b/src/main/java/envoy/client/Config.java index fda0f97..ee9cf31 100644 --- a/src/main/java/envoy/client/Config.java +++ b/src/main/java/envoy/client/Config.java @@ -8,7 +8,7 @@ import java.util.Properties; * Created: 12 Oct 2019
* * @author Kai S. K. Engelbart - * @since Envoy 0.1 + * @since Envoy v0.1-alpha */ public class Config { @@ -19,8 +19,9 @@ public class Config { * Defaults to the {@code server.properties} file for information. * * - * @param properties - The two options for internet connection server and port - * @since Envoy 0.1 + * @param properties - The two options for internet connection + * server and port + * @since Envoy v0.1-alpha */ public void load(Properties properties) { if (properties.containsKey("server")) server = properties.getProperty("server"); @@ -28,11 +29,12 @@ public class Config { } /** - * Sets the server and the port via command line properties --server/ -s and --port/ -p. + * Sets the server and the port via command line properties --server/ -s and + * --port/ -p. * * @param args {@code --server} or {@code -s} followed by the specified URL - * and {@code --port} or {@code -p} followed by a 4-digit Integer - * @since Envoy 0.1 + * and {@code --port} or {@code -p} followed by a 4-digit Integer + * @since Envoy v0.1-alpha */ public void load(String[] args) { for (int i = 0; i < args.length; i++) @@ -48,13 +50,39 @@ public class Config { } } + /** + * @return true if server and port are known. + * @since Envoy v0.1-alpha + */ public boolean isInitialized() { return server != null && !server.isEmpty() && port > 0; } + /** + * @return the URL of our website + * @since Envoy v0.1-alpha + */ public String getServer() { return server; } + /** + * Changes the default URL. + * Exclusively meant for developing reasons. (localhost) + * + * @param server the URL where wish to host Envoy + * @since Envoy v0.1-alpha + */ public void setServer(String server) { this.server = server; } + /** + * @return the port at which Envoy is located in the Server + * @since Envoy v0.1-alpha + */ public int getPort() { return port; } + /** + * Changes the default port. + * Exclusively meant for developing reasons. (localhost) + * + * @param port the port where we wish to connect to {@code Envoy}. + * @since Envoy v0.1-alpha + */ public void setPort(int port) { this.port = port; } -} +} \ No newline at end of file diff --git a/src/main/java/envoy/client/ui/MessageListRenderer.java b/src/main/java/envoy/client/ui/MessageListRenderer.java index a61ae5f..4490b69 100644 --- a/src/main/java/envoy/client/ui/MessageListRenderer.java +++ b/src/main/java/envoy/client/ui/MessageListRenderer.java @@ -10,11 +10,15 @@ import javax.swing.ListCellRenderer; import envoy.schema.Message; /** + * Defines how a message is displayed.
+ *
+ * * Project: envoy-client
* File: UserListRenderer.java
* Created: 19 Oct 2019
* * @author Kai S. K. Engelbart + * @since Envoy v0.1-alpha */ public class MessageListRenderer extends JLabel implements ListCellRenderer { @@ -44,4 +48,4 @@ public class MessageListRenderer extends JLabel implements ListCellRendererenvoy-client
* File: UserListRenderer.java
* Created: 12 Oct 2019
* * @author Kai S. K. Engelbart + * @since Envoy v0.1-alpha */ public class UserListRenderer extends JLabel implements ListCellRenderer { @@ -38,4 +41,4 @@ public class UserListRenderer extends JLabel implements ListCellRenderer { return this; } -} +} \ No newline at end of file