Changeset 8 for party

Timestamp:

09/30/19 15:37:05 (5 years ago)

Author:

bart

Message:

Added parameter support

Location:

party/src

Files:

• main/java/geniusweb/party/inform/Settings.java (modified) (7 diffs)
• test/java/geniusweb/party/inform/SettingsTest.java (added)

party/src/main/java/geniusweb/party/inform/Settings.java

@@ -1 +1 @@
 package geniusweb.party.inform;
+
+import java.util.HashMap;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
@@ -5 +7 @@
 
 import geniusweb.actions.PartyId;
+import geniusweb.party.Party;
 import geniusweb.progress.Progress;
+import geniusweb.references.Parameters;
 import geniusweb.references.ProfileRef;
 import geniusweb.references.ProtocolRef;
 
 /**
- * Informs a party about all settings for the upcoming negotiation session. This
- * should be sent to a party one time, so that the party knows the situation.
+ * Informs a {@link Party} about all settings for the upcoming negotiation
+ * session. This should be sent to a party one time, so that the party knows the
+ * situation.
  *
  */
@@ -19 +24 @@
         private Progress progress;
         private PartyId id;
+        private Parameters parameters;
 
+        /**
+         * 
+         * @param id         the {@link PartyId} for this party
+         * @param profile    the profile used for this party in this session
+         * @param protocol   the protocol used in this session
+         * @param progress   the {@link Progress} object used for this session
+         * @param parameters a Map<String, Object> containing initialization
+         *                   parameters for this party. The Object can be a HashMap,
+         *                   ArrayList, String, or number (Integer, Double, etc).
+         *                   The Object should not be just any Object because
+         *                   deserialization will work only with the mentioned
+         *                   types.
+         */
         @JsonCreator
         public Settings(@JsonProperty("id") PartyId id,
                         @JsonProperty("profile") ProfileRef profile,
                         @JsonProperty("protocol") ProtocolRef protocol,
-                        @JsonProperty("progress") Progress progress) {
-                if (profile == null || protocol == null || progress == null) {
+                        @JsonProperty("progress") Progress progress,
+                        @JsonProperty("parameters") Parameters parameters) {
+                if (profile == null || protocol == null || progress == null
+                                || parameters == null) {
                         throw new IllegalArgumentException(
-                                        "party, profile, protocol and progress must be not null.");
+                                        "party, profile, protocol, parameters and progress must be not null.");
                 }
                 this.profile = profile;
                 this.protocol = protocol;
                 this.progress = progress;
+                this.parameters = parameters;
                 this.id = id;
         }
 
+        /**
+         * 
+         * @return the profile used for this party in this session
+         */
         public ProfileRef getProfile() {
                 return profile;
@@ -43 +69 @@
         }
 
+        /**
+         * 
+         * @return the {@link Progress} object used for this session
+         */
         public Progress getProgress() {
                 return progress;
         }
 
+        /**
+         * @return the party ID of this party
+         */
         public PartyId getID() {
                 return id;
+        }
+
+        /**
+         * 
+         * @return a HashMap<String,Object> containing initialization parameters
+         *         that can be used by the party.
+         */
+        public HashMap<String, Object> getParemeters() {
+                return parameters;
         }
 
@@ -54 +96 @@
         public String toString() {
                 return "Settings[" + id + "," + profile + "," + protocol + ","
-                                + progress + "]";
+                                + progress + "," + parameters + "]";
         }
 
@@ -62 +104 @@
                 int result = 1;
                 result = prime * result + ((id == null) ? 0 : id.hashCode());
+                result = prime * result
+                                + ((parameters == null) ? 0 : parameters.hashCode());
                 result = prime * result + ((profile == null) ? 0 : profile.hashCode());
                 result = prime * result
@@ -84 +128 @@
                 } else if (!id.equals(other.id))
                         return false;
+                if (parameters == null) {
+                        if (other.parameters != null)
+                                return false;
+                } else if (!parameters.equals(other.parameters))
+                        return false;
                 if (profile == null) {
                         if (other.profile != null)