Add ActionParameter for messages

Author: rubengees

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

@@ -7,6 +7,7 @@
 import com.afollestad.bridge.annotations.Body;
 import com.proxerme.library.interfaces.IdItem;
 import com.proxerme.library.interfaces.TimeItem;
+import com.proxerme.library.parameters.ActionParameter.Action;
 
 /**
  * Class that represents a single message.
@@ -62,8 +63,8 @@ public Message[] newArray(int size) {
      * @param device       The device this message was sent from. In most cases "default".
      */
     public Message(@NonNull String id, @NonNull String conferenceId, @NonNull String userId,
-                   @NonNull String username, @NonNull String message, @NonNull String action,
-                   long time, @NonNull String device) {
+                   @NonNull String username, @NonNull String message,
+                   @NonNull @Action String action, long time, @NonNull String device) {
         this.id = id;
         this.conferenceId = conferenceId;
         this.userId = userId;
@@ -87,6 +88,7 @@ protected Message(Parcel in) {
 
     /**
      * Returns the id of this message.
+     *
      * @return The id.
      */
     @NonNull
@@ -97,6 +99,7 @@ public String getId() {
 
     /**
      * Returns the id of the conferenceInfo this message belongs to.
+     *
      * @return The id.
      */
     @NonNull
@@ -106,6 +109,7 @@ public String getConferenceId() {
 
     /**
      * Returns the id of the user.
+     *
      * @return The id.
      */
     @NonNull
@@ -115,6 +119,7 @@ public String getUserId() {
 
     /**
      * Returns the username of the user.
+     *
      * @return The username.
      */
     @NonNull
@@ -124,6 +129,7 @@ public String getUsername() {
 
     /**
      * Returns the actual contents of this message.
+     *
      * @return The contents of this message.
      */
     @NonNull
@@ -133,15 +139,18 @@ public String getMessage() {
 
     /**
      * Returns the action of this message. Might be empty.
+     *
      * @return The action.
      */
     @NonNull
+    @Action
     public String getAction() {
         return action;
     }
 
     /**
      * Returns the time of this message.
+     *
      * @return The time.
      */
     @Override
@@ -151,6 +160,7 @@ public long getTime() {
 
     /**
      * Returns the device this message was sent from.
+     *
      * @return The device.
      */
     @NonNull

library/src/main/java/com/proxerme/library/parameters/ActionParameter.java

@@ -1,14 +1,35 @@
 package com.proxerme.library.parameters;
 
+import android.support.annotation.StringDef;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
 /**
- * TODO: Describe class
+ * Class containing the available actions of a
+ * {@link com.proxerme.library.connection.messenger.entity.Message}.
  *
  * @author Ruben Gees
  */
 
 public class ActionParameter {
 
+    public static final String NONE = "";
     public static final String ADD_USER = "addUser";
     public static final String REMOVE_USER = "removeUser";
+    public static final String SET_LEADER = "setLeader";
+    public static final String SET_TOPIC = "setTopic";
+
+    /**
+     * An annotation representing the available actions of a
+     * {@link com.proxerme.library.connection.messenger.entity.Message}.
+     */
+    @StringDef({NONE, ADD_USER, REMOVE_USER, SET_LEADER, SET_TOPIC})
+    @Retention(value = RetentionPolicy.SOURCE)
+    @Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER})
+    public @interface Action {
+    }
 
 }