Minor renamings and JavaDoc fixes; Moved entities out of their package

Author: rubengees

library/src/main/java/com/proxerme/library/connection/messenger/entity/Conference.java

@@ -12,7 +12,7 @@
 import com.proxerme.library.interfaces.TimeItem;
 
 /**
- * Class representing a single conference. This might be a group chat or a conversation with a
+ * Class representing a single conferenceInfo. This might be a group chat or a conversation with a
  * single user (indicated by {@link #isGroup()}.
  *
  * @author Ruben Gees
@@ -59,15 +59,15 @@ public Conference[] newArray(int size) {
     /**
      * The constructor.
      *
-     * @param id                  The id of this conference.
+     * @param id                  The id of this conferenceInfo.
      * @param topic               The topic.
      * @param customTopic         A custom topic set by a user.
-     * @param participantAmount   The amount of participants in this conference.
+     * @param participantAmount   The amount of participants in this conferenceInfo.
      * @param imageType           The type of the image. This is "avatar" in most cases.
      * @param imageId             The id of the image.
      * @param isGroup             Indicator if this is a group chat.
-     * @param isRead              Indicator if this conference has been read by the current user.
-     * @param time                The time of the last message in this conference.
+     * @param isRead              Indicator if this conferenceInfo has been read by the current user.
+     * @param time                The time of the last message in this conferenceInfo.
      * @param unreadMessageAmount The amount of unread messages for the current user.
      * @param lastReadMessageId   The id of the last read message of the current user.
      */
@@ -159,7 +159,7 @@ public boolean isRead() {
     }
 
     /**
-     * Returns the custom topic for this conference. Might be empty.
+     * Returns the custom topic for this conferenceInfo. Might be empty.
      *
      * @return The custom topic.
      */
@@ -169,7 +169,7 @@ public String getCustomTopic() {
     }
 
     /**
-     * Returns the amount of participants in this conference.
+     * Returns the amount of participants in this conferenceInfo.
      *
      * @return The amount.
      */
@@ -179,7 +179,7 @@ public int getParticipantAmount() {
     }
 
     /**
-     * Returns the topic of this conference.
+     * Returns the topic of this conferenceInfo.
      *
      * @return The topic.
      */
@@ -189,7 +189,7 @@ public String getTopic() {
     }
 
     /**
-     * Returns the id of this conference.
+     * Returns the id of this conferenceInfo.
      *
      * @return The id.
      */
@@ -200,7 +200,7 @@ public String getId() {
     }
 
     /**
-     * Returns the time of the last message in this conference.
+     * Returns the time of the last message in this conferenceInfo.
      *
      * @return The time.
      */
@@ -210,7 +210,7 @@ public long getTime() {
     }
 
     /**
-     * Returns if this conference is a group chat.
+     * Returns if this conferenceInfo is a group chat.
      *
      * @return True, if it is a group chat.
      */

…ntity/conferenceInfo/ConferenceInfo.java …ion/messenger/entity/ConferenceInfo.javalibrary/src/main/java/com/proxerme/library/connection/messenger/entity/conferenceInfo/ConferenceInfo.java renamed to library/src/main/java/com/proxerme/library/connection/messenger/entity/ConferenceInfo.java library/src/main/java/com/proxerme/library/connection/messenger/entity/conferenceInfo/ConferenceInfo.java renamed to library/src/main/java/com/proxerme/library/connection/messenger/entity/ConferenceInfo.java

@@ -1,4 +1,4 @@
-package com.proxerme.library.connection.messenger.entity.conferenceInfo;
+package com.proxerme.library.connection.messenger.entity;
 
 import android.os.Parcel;
 import android.os.Parcelable;
@@ -32,9 +32,9 @@ public ConferenceInfo[] newArray(int size) {
     @Body(name = "count")
     int participants;
     @Body(name = "timestampStart")
-    long timestampStart;
+    long firstMessageTime;
     @Body(name = "timestampEnd")
-    long timestampEnd;
+    long lastMessageTime;
     @Body(name = "leader")
     String leaderId;
 
@@ -47,19 +47,19 @@ public ConferenceInfo[] newArray(int size) {
     /**
      * The Constructor.
      *
-     * @param topic          The topic.
-     * @param participants   The participants of this conference.
-     * @param timestampStart The timestamp when the conference started.
-     * @param timestampEnd   The timestamp when the last message of the conference was sent.
-     * @param leaderId       The user id of the conference leader.
+     * @param topic            The topic.
+     * @param participants     The amount of participants in this conferenceInfo.
+     * @param firstMessageTime The time when the conferenceInfo started.
+     * @param lastMessageTime  The time when the last message of the conferenceInfo was sent.
+     * @param leaderId         The user id of the conferenceInfo leader.
      */
     public ConferenceInfo(@NonNull String topic, @IntRange(from = 2) int participants,
-                          @IntRange(from = 0) long timestampStart, @IntRange(from = 0) long timestampEnd,
-                          @NonNull String leaderId) {
+                          @IntRange(from = 0) long firstMessageTime,
+                          @IntRange(from = 0) long lastMessageTime, @NonNull String leaderId) {
         this.topic = topic;
         this.participants = participants;
-        this.timestampStart = timestampStart;
-        this.timestampEnd = timestampEnd;
+        this.firstMessageTime = firstMessageTime;
+        this.lastMessageTime = lastMessageTime;
         this.leaderId = leaderId;
     }
 
@@ -71,27 +71,11 @@ public ConferenceInfo(@NonNull String topic, @IntRange(from = 2) int participant
     protected ConferenceInfo(Parcel in) {
         topic = in.readString();
         participants = in.readInt();
-        timestampStart = in.readLong();
-        timestampEnd = in.readLong();
+        firstMessageTime = in.readLong();
+        lastMessageTime = in.readLong();
         leaderId = in.readString();
     }
 
-
-    @Override
-    public int describeContents() {
-        return 0;
-    }
-
-    @Override
-    public void writeToParcel(Parcel parcel, int i) {
-        parcel.writeString(topic);
-        parcel.writeInt(participants);
-        parcel.writeLong(timestampStart);
-        parcel.writeLong(timestampEnd);
-        parcel.writeString(leaderId);
-    }
-
-
     /**
      * Returns the Topic.
      *
@@ -113,29 +97,29 @@ public int getParticipants() {
     }
 
     /**
-     * Returns the TimestampStart.
+     * Returns the time of the first message.
      *
-     * @return The TimestampStart.
+     * @return The time.
      **/
     @IntRange(from = 0)
-    public long getTimestampStart() {
-        return timestampStart;
+    public long getFirstMessageTime() {
+        return firstMessageTime;
     }
 
     /**
-     * Returns the TimestampEnd.
+     * Returns the time of the last message.
      *
-     * @return The TimestampEnd.
+     * @return The time.
      **/
     @IntRange(from = 0)
-    public long getTimestampEnd() {
-        return timestampEnd;
+    public long getLastMessageTime() {
+        return lastMessageTime;
     }
 
     /**
-     * Returns the Leader.
+     * Returns the id of the conferenceInfo leader.
      *
-     * @return The Leader.
+     * @return The id.
      **/
     @NonNull
     public String getLeaderId() {
@@ -151,8 +135,8 @@ public boolean equals(Object o) {
         ConferenceInfo that = (ConferenceInfo) o;
 
         if (participants != that.participants) return false;
-        if (timestampStart != that.timestampStart) return false;
-        if (timestampEnd != that.timestampEnd) return false;
+        if (firstMessageTime != that.firstMessageTime) return false;
+        if (lastMessageTime != that.lastMessageTime) return false;
         if (!topic.equals(that.topic)) return false;
         return leaderId.equals(that.leaderId);
 
@@ -162,9 +146,23 @@ public boolean equals(Object o) {
     public int hashCode() {
         int result = topic.hashCode();
         result = 31 * result + participants;
-        result = 31 * result + (int) (timestampStart ^ (timestampStart >>> 32));
-        result = 31 * result + (int) (timestampEnd ^ (timestampEnd >>> 32));
+        result = 31 * result + (int) (firstMessageTime ^ (firstMessageTime >>> 32));
+        result = 31 * result + (int) (lastMessageTime ^ (lastMessageTime >>> 32));
         result = 31 * result + leaderId.hashCode();
         return result;
     }
+
+    @Override
+    public int describeContents() {
+        return 0;
+    }
+
+    @Override
+    public void writeToParcel(Parcel parcel, int i) {
+        parcel.writeString(topic);
+        parcel.writeInt(participants);
+        parcel.writeLong(firstMessageTime);
+        parcel.writeLong(lastMessageTime);
+        parcel.writeString(leaderId);
+    }
 }

library/src/main/java/com/proxerme/library/connection/messenger/entity/ConferenceInfoContainer.java

@@ -5,12 +5,11 @@
 import android.support.annotation.NonNull;
 
 import com.afollestad.bridge.annotations.Body;
-import com.proxerme.library.connection.messenger.entity.conferenceInfo.ConferenceInfoUser;
 
 import java.util.Arrays;
 
 /**
- * Class that represents the infos of a conference such as the participating users.
+ * Class that represents the info of a conference such as the participating users.
  *
  * @author Desnoo
  */
@@ -28,10 +27,10 @@ public ConferenceInfoContainer[] newArray(int size) {
         }
     };
 
-    @Body(name = "conference")
-    Conference conference;
+    @Body(name = "conferenceInfo")
+    ConferenceInfo conferenceInfo;
     @Body(name = "users")
-    ConferenceInfoUser[] conferenceInfoUser;
+    ConferenceInfoUser[] participants;
 
     /**
      * Private Constructor.
@@ -42,12 +41,13 @@ public ConferenceInfoContainer[] newArray(int size) {
     /**
      * The Constructor.
      *
-     * @param conference The conference object.
-     * @param conferenceInfoUser       The user object.
+     * @param conferenceInfo The conferenceInfo object.
+     * @param participants   The participants of the conference.
      */
-    public ConferenceInfoContainer(@NonNull Conference conference, @NonNull ConferenceInfoUser[] conferenceInfoUser) {
-        this.conference = conference;
-        this.conferenceInfoUser = conferenceInfoUser;
+    public ConferenceInfoContainer(@NonNull ConferenceInfo conferenceInfo,
+                                   @NonNull ConferenceInfoUser[] participants) {
+        this.conferenceInfo = conferenceInfo;
+        this.participants = participants;
     }
 
     /**
@@ -56,8 +56,8 @@ public ConferenceInfoContainer(@NonNull Conference conference, @NonNull Conferen
      * @param in The parcel to parse.
      */
     protected ConferenceInfoContainer(Parcel in) {
-        conference = in.readParcelable(Conference.class.getClassLoader());
-        conferenceInfoUser = in.createTypedArray(ConferenceInfoUser.CREATOR);
+        conferenceInfo = in.readParcelable(Conference.class.getClassLoader());
+        participants = in.createTypedArray(ConferenceInfoUser.CREATOR);
     }
 
     @Override
@@ -67,28 +67,28 @@ public int describeContents() {
 
     @Override
     public void writeToParcel(Parcel parcel, int i) {
-        parcel.writeParcelable(conference, i);
-        parcel.writeTypedArray(conferenceInfoUser, i);
+        parcel.writeParcelable(conferenceInfo, i);
+        parcel.writeTypedArray(participants, i);
     }
 
     /**
      * Returns the ConferenceInfo.
      *
-     * @return The ConferenceInfo.‚
+     * @return The ConferenceInfo.
      **/
     @NonNull
-    public Conference getConference() {
-        return conference;
+    public ConferenceInfo getConferenceInfo() {
+        return conferenceInfo;
     }
 
     /**
-     * Returns the User.
+     * Returns the participants.
      *
-     * @return The User.
+     * @return The participants.
      **/
     @NonNull
-    public ConferenceInfoUser[] getConferenceInfoUser() {
-        return conferenceInfoUser;
+    public ConferenceInfoUser[] getParticipants() {
+        return participants;
     }
 
     @Override
@@ -98,16 +98,15 @@ public boolean equals(Object o) {
 
         ConferenceInfoContainer that = (ConferenceInfoContainer) o;
 
-        if (!conference.equals(that.conference)) return false;
-        // Probably incorrect - comparing Object[] arrays with Arrays.equals
-        return Arrays.equals(conferenceInfoUser, that.conferenceInfoUser);
+        if (!conferenceInfo.equals(that.conferenceInfo)) return false;
+        return Arrays.equals(participants, that.participants);
 
     }
 
     @Override
     public int hashCode() {
-        int result = conference.hashCode();
-        result = 31 * result + Arrays.hashCode(conferenceInfoUser);
+        int result = conferenceInfo.hashCode();
+        result = 31 * result + Arrays.hashCode(participants);
         return result;
     }
 }