Add chaining for all setters in subscription object

Author: Anders Breid

pom.xml

@@ -4,7 +4,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.github.ericsson</groupId>
     <artifactId>eiffel-commons-java</artifactId>
-    <version>0.0.12</version>
+    <version>0.0.13-SNAPSHOT</version>
 
     <name>eiffel commons java</name>
     <description>A shared library for eiffel components</description>

src/main/java/com/ericsson/eiffelcommons/subscriptionobject/MailSubscriptionObject.java

@@ -2,15 +2,15 @@
 
 import java.io.IOException;
 
-public class MailSubscriptionObject extends SubscriptionObject {
+public class MailSubscriptionObject extends SubscriptionObject<MailSubscriptionObject> {
 
     /**
      * Creates a subscriptionObject with MAIL capabilities.
      * @param subscriptionName
      * @throws IOException
      */
     public MailSubscriptionObject(String subscriptionName) throws IOException {
-        super(subscriptionName);
+        super(MailSubscriptionObject.class, subscriptionName);
 
         subscriptionJson.put("notificationType", "MAIL");
     }

src/main/java/com/ericsson/eiffelcommons/subscriptionobject/RestPostSubscriptionObject.java

@@ -2,7 +2,7 @@
 
 import java.io.IOException;
 
-public class RestPostSubscriptionObject extends SubscriptionObject {
+public class RestPostSubscriptionObject extends SubscriptionObject<RestPostSubscriptionObject> {
 
     private final String NOTIFICATION_TYPE_KEY = "notificationType";
     private final String NOTIFICATION_TYPE = "REST_POST";
@@ -19,8 +19,7 @@ public class RestPostSubscriptionObject extends SubscriptionObject {
      * @throws IOException
      */
     public RestPostSubscriptionObject(String subscriptionName) throws IOException {
-        super(subscriptionName);
-
+        super(RestPostSubscriptionObject.class, subscriptionName);
         subscriptionJson.put(NOTIFICATION_TYPE_KEY, NOTIFICATION_TYPE);
     }
 

src/main/java/com/ericsson/eiffelcommons/subscriptionobject/SubscriptionObject.java

@@ -9,66 +9,88 @@
 
 import lombok.Getter;
 
-public abstract class SubscriptionObject {
+public abstract class SubscriptionObject<T extends SubscriptionObject<?>> {
     private static final String SUBSCRIPTION_TEMPLATE_PATH = "subscriptionsTemplate.json";
 
+    // reference to self as the subclass type
+    protected final T self;
+
     @Getter
     protected JSONObject subscriptionJson;
 
     /**
      * Creates a subscription with a specific name.
+     *
      * @param subscriptionName
      * @throws IOException
      */
-    public SubscriptionObject(String subscriptionName) throws IOException {
+    public SubscriptionObject(final Class<T> selfClass, String subscriptionName) throws IOException {
         subscriptionJson = Utils.getResourceFileAsJsonObject(SUBSCRIPTION_TEMPLATE_PATH);
         subscriptionJson.put("subscriptionName", subscriptionName);
+        this.self = selfClass.cast(this);
     }
 
     /**
      * Adds a notification message to the subscriptionObject as key value.
+     *
      * @param notificationKey
      * @param notificationValue
+     * @return
      */
-    public void addNotificationMessageKeyValue(String notificationKey, String notificationValue) {
+    public T addNotificationMessageKeyValue(String notificationKey, String notificationValue) {
         JSONObject keyValue = new JSONObject();
         keyValue.put("formkey", notificationKey);
         keyValue.put("formvalue", notificationValue);
 
-        JSONArray notificationMessageKeyValue = subscriptionJson.getJSONArray("notificationMessageKeyValues");
+        JSONArray notificationMessageKeyValue = subscriptionJson.getJSONArray(
+                "notificationMessageKeyValues");
         notificationMessageKeyValue.put(keyValue);
+        return this.self;
     }
 
     /**
-     * Adds a condition to a requirement, the condition is objectNode containing key value for the jmesPath expression
+     * Adds a condition to a requirement, the condition is objectNode containing key value for the
+     * jmesPath expression
+     *
      * @param requirementIndex
      * @param condition
+     * @return
      */
-    public void addConditionToRequirement(int requirementIndex, JSONObject condition) {
-        JSONArray requirements =  subscriptionJson.getJSONArray("requirements");
+    public T addConditionToRequirement(int requirementIndex, JSONObject condition) {
+        JSONArray requirements = subscriptionJson.getJSONArray("requirements");
         JSONObject requirement = requirements.getJSONObject(requirementIndex);
         JSONArray conditions = requirement.getJSONArray("conditions");
         conditions.put(condition);
+        return this.self;
     }
 
     /**
      * Sets the field notificationMeta to the wanted value
+     *
      * @param notificationMeta
+     * @return
      */
-    public void setNotificationMeta(String notificationMeta) {
+    public T setNotificationMeta(String notificationMeta) {
         subscriptionJson.put("notificationMeta", notificationMeta);
+        return this.self;
     }
 
     /**
-     * Set the restPostBodyMediaType field in the subscriptions to wanted value for example "application/x-www-form-urlencoded"
+     * Set the restPostBodyMediaType field in the subscriptions to wanted value for example
+     * "application/x-www-form-urlencoded"
+     *
      * @param value
+     * @return
      */
-    public void setRestPostBodyMediaType(String restPostBodyMediaType) {
+    public T setRestPostBodyMediaType(String restPostBodyMediaType) {
         subscriptionJson.put("restPostBodyMediaType", restPostBodyMediaType);
+        return this.self;
     }
 
     /**
-     * Returns the subscription as an array with the subscription. (This is the way Eiffel-intelligence stores it.)
+     * Returns the subscription as an array with the subscription. (This is the way
+     * Eiffel-intelligence stores it.)
+     *
      * @return ArrayNode
      */
     public JSONArray getAsSubscriptions() {

src/test/java/com/ericsson/eiffelcommons/subscriptionobjecttest/SubscriptionObjectTest.java

@@ -28,7 +28,7 @@ public void addConditionToRequirement() {
         restPostSubscription.addConditionToRequirement(0, condition);
 
         JSONArray actualRequirement = restPostSubscription.getSubscriptionJson()
-                .getJSONArray("requirements");
+                                                          .getJSONArray("requirements");
         JSONObject actualCondition = actualRequirement.getJSONObject(0);
 
         assertEquals("{\"conditions\":[{\"test\":\"'test'\"}]}", actualCondition.toString());
@@ -39,17 +39,19 @@ public void testAddNotificationMessageKeyValue() {
         restPostSubscription.addNotificationMessageKeyValue("jmespath", "'test'");
 
         JSONArray actualNotificationMessageKeyValue = restPostSubscription.getSubscriptionJson()
-                .getJSONArray("notificationMessageKeyValues");
-        assertEquals("[{\"formkey\":\"jmespath\",\"formvalue\":\"'test'\"}]", actualNotificationMessageKeyValue.toString());
+                                                                          .getJSONArray(
+                                                                                  "notificationMessageKeyValues");
+        assertEquals("[{\"formkey\":\"jmespath\",\"formvalue\":\"'test'\"}]",
+                actualNotificationMessageKeyValue.toString());
     }
 
     @Test
     public void testSetNotificationMeta() {
         restPostSubscription.setNotificationMeta("http://localhost:8080");
 
         String actualNotificationMeta = restPostSubscription.getSubscriptionJson()
-                .get("notificationMeta")
-                .toString();
+                                                            .get("notificationMeta")
+                                                            .toString();
         assertEquals("http://localhost:8080", actualNotificationMeta);
     }
 
@@ -58,14 +60,14 @@ public void testSetBasicAuth() {
         restPostSubscription.setBasicAuth("admin", "admin");
 
         String actualUsername = restPostSubscription.getSubscriptionJson()
-                .get("userName")
-                .toString();
+                                                    .get("userName")
+                                                    .toString();
         String actualPassword = restPostSubscription.getSubscriptionJson()
-                .get("password")
-                .toString();
+                                                    .get("password")
+                                                    .toString();
         String actualAuthenticationType = restPostSubscription.getSubscriptionJson()
-                .get("authenticationType")
-                .toString();
+                                                              .get("authenticationType")
+                                                              .toString();
 
         assertEquals("admin", actualUsername);
         assertEquals("admin", actualPassword);
@@ -77,8 +79,21 @@ public void testSetRestPostBodyMediaType() {
         restPostSubscription.setRestPostBodyMediaType(MediaType.APPLICATION_FORM_URLENCODED);
 
         String actualRestPostBodyMediaType = restPostSubscription.getSubscriptionJson()
-                .get("restPostBodyMediaType")
-                .toString();
+                                                                 .get("restPostBodyMediaType")
+                                                                 .toString();
         assertEquals("application/x-www-form-urlencoded", actualRestPostBodyMediaType);
     }
+
+    @Test
+    public void testChaining() {
+        restPostSubscription.addNotificationMessageKeyValue("Key", "value")
+                            .setAuthenticationType("test_type")
+                            .setPassword("my_password")
+                            .setUsername("username")
+                            .addNotificationMessageKeyValue("key2", "value2")
+                            .setNotificationMeta("SomeURL");
+        JSONObject subscription = restPostSubscription.getSubscriptionJson();
+
+        assertEquals("my_password", subscription.getString("password"));
+    }
 }