Merge remote-tracking branch 'origin/chat-initiation' into chat-initiation

Author: Nasim Bondar Sahebi

src/main/java/entities/Chat.java

@@ -0,0 +1,54 @@
+package entities;
+import java.util.ArrayList;
+// Chat is an abstract class
+public class Chat {
+
+    protected String name;
+    protected String chatID;
+    protected String senderUsername;
+
+    // chat's conversation history
+    protected ArrayList<Message> convHist;
+
+
+    /**
+     * Get the chat's name
+     * @return name
+     */
+    public String getName(){
+        return this.name;
+    }
+
+    /**
+     * Get the chat's ID
+     * @return chatID
+     */
+    public String getChatID(){
+        return this.chatID;
+    }
+
+    /**
+     * Get the sender's username
+     * @return senderUsername
+     */
+    public String getSenderUsername(){
+        return this.senderUsername;
+    }
+
+    /**
+     * Return this conversation history of the chat
+     * @return convHist
+     */
+    public ArrayList<Message> getConvHist(){
+        return new ArrayList<Message>(this.convHist);
+    }
+
+    /**
+     * Add a message to the chat's conversation history when a message is sent or received
+     * @param message Message that is sent or received
+     */
+    public void sendRecieveMessage(Message message){
+        this.convHist.add(message);
+    }
+
+}

src/main/java/entities/GroupChat.java

@@ -0,0 +1,52 @@
+package entities;
+
+import java.util.ArrayList;
+
+public class GroupChat extends Chat{
+
+    /*
+    From Chat, GroupChat has:
+        String name;
+        String chatID;
+        String senderUsername;
+        Arraylist<Message> convHist;
+     */
+    public ArrayList<String> groupMembers;
+
+    /**
+     * Create a private chat
+     * @param name The name of the chat
+     * @param chatID The ID of the chat
+     * @param senderUsername The username of the user sending the messages
+     */
+    public GroupChat(String name, String chatID, String senderUsername){
+        this.name = name;
+        this.chatID = chatID;
+        this.senderUsername = senderUsername;
+        this.convHist = new ArrayList<Message>();
+        this.groupMembers = new ArrayList<>();
+    }
+
+    /**
+     * Return an arraylist of all the usernames of group members (not including the sender) in a group chat
+     *
+     * @return groupMembers
+     */
+    public ArrayList<String> getGroupMembers(){
+        return new ArrayList<String>(this.groupMembers);
+    }
+
+    /**
+     * Add a member to a group chat
+     * @param user The user to be added
+     */
+    public void addMember(String user){
+        try {
+            this.groupMembers.add(user);
+        } catch (Exception e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+
+}

src/main/java/entities/PrivateChat.java

@@ -0,0 +1,40 @@
+package entities;
+
+import java.util.ArrayList;
+
+public class PrivateChat extends Chat{
+
+    /*
+    From Chat, PrivateChat has:
+        String name;
+        String chatID;
+        String senderUsername;
+        Arraylist<Message> convHist;
+     */
+    protected String recipientUsername;
+
+    /**
+     * Create a private chat
+     *
+     * @param name  The name of the chat (also the username of the recipient)
+     * @param chatID The ID of the chat
+     * @param senderUsername    The user sending the messages
+     * @param recipientUsername The user receiving the messages
+     */
+    public PrivateChat(String name, String chatID, String senderUsername, String recipientUsername){
+        this.name = name;
+        this.chatID = chatID;
+        this.senderUsername = senderUsername;
+        this.recipientUsername = recipientUsername;
+        this.convHist = new ArrayList<Message>();
+    }
+
+    /**
+     * Get the recipient's username
+     * @return senderRecipient
+     */
+    public String getRecipientUsername(){
+        return this.recipientUsername;
+    }
+
+}