Taxonomy and Terms

Author: ishaileshmishra

pom.xml

@@ -7,7 +7,7 @@
     <artifactId>cms</artifactId>
     <packaging>jar</packaging>
     <name>contentstack-management-java</name>
-    <version>1.0.0</version>
+    <version>1.1.0</version>
     <description>Contentstack Java Management SDK for Content Management API, Contentstack is a headless CMS with an
         API-first approach
     </description>
@@ -165,6 +165,12 @@
             <version>${junit-vintage-engine.version}</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <version>2.8.9</version>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>com.googlecode.json-simple</groupId>
             <artifactId>json-simple</artifactId>
@@ -328,6 +334,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-pdf-plugin</artifactId>
+                <version>1.6.1</version>
                 <executions>
                     <execution>
                         <id>pdf</id>

src/main/java/com/contentstack/cms/BaseImplementation.java

@@ -7,12 +7,11 @@
 /**
  * The interface @{@link BaseImplementation}
  */
-public interface BaseImplementation {
+public interface BaseImplementation<T> {
 
     /**
      * The function adds a parameter to a collection using a key-value pair.
      *
-     * @param <T>   the type of the parameter
      * @param key   A string representing the key of the parameter. It cannot be
      *              null and must be
      *              provided as a non-null value.
@@ -21,12 +20,11 @@ public interface BaseImplementation {
      *              object as its value.
      * @return The method is returning an object of type T.
      */
-    <T> T addParam(@NotNull String key, @NotNull Object value);
+     T addParam(@NotNull String key, @NotNull Object value);
 
     /**
      * The function adds a header with a key-value pair to a request.
      *
-     * @param <T>   the type of the parameter
      * @param key   The key parameter is a string that represents the name or
      *              identifier of the header.
      *              It is used to specify the type of information being sent in the
@@ -35,30 +33,28 @@ public interface BaseImplementation {
      *              header.
      * @return The method is returning an object of type T.
      */
-    <T> T addHeader(@NotNull String key, @NotNull String value);
+    T addHeader(@NotNull String key, @NotNull String value);
 
     /**
      * The function "addParams" takes a HashMap of String keys and Object values as
      * input and returns a
      * generic type T.
      *
-     * @param <T>    the type of the parameter
      * @param params The "params" parameter is a HashMap that maps String keys to
      *               Object values. It is
      *               annotated with @NotNull, indicating that it cannot be null.
      * @return The method is returning an object of type T.
      */
-    <T> T addParams(@NotNull HashMap<String, Object> params);
+     T addParams(@NotNull HashMap<String, Object> params);
 
     /**
      * The function adds headers to a HashMap.
      *
-     * @param <T>     the type of the parameter
      * @param headers A HashMap containing key-value pairs of headers, where the key
      *                is a String
      *                representing the header name and the value is a String
      *                representing the header value.
      * @return The method is returning an object of type T.
      */
-    <T> T addHeaders(@NotNull HashMap<String, String> headers);
+     T addHeaders(@NotNull HashMap<String, String> headers);
 }

src/main/java/com/contentstack/cms/core/CMARuntimeException.java

@@ -8,9 +8,14 @@
  * @since 2022-10-20
  */
 public class CMARuntimeException extends Exception {
-    // The code `public CMARuntimeException(String message) { super(message); }` is
-    // defining a constructor
-    // for the `CMARuntimeException` class.
+
+    /**
+     * The code `public CMARuntimeException(String message) { super(message); }` is
+     * defining a constructor
+     * for the `CMARuntimeException` class.
+     *
+     * @param message the message for exception
+     */
     public CMARuntimeException(String message) {
         super(message);
     }

src/main/java/com/contentstack/cms/organization/Organization.java

@@ -1,5 +1,6 @@
 package com.contentstack.cms.organization;
 
+import com.contentstack.cms.BaseImplementation;
 import okhttp3.ResponseBody;
 import org.jetbrains.annotations.NotNull;
 import org.json.simple.JSONObject;
@@ -19,7 +20,7 @@
  * @version v0.1.0
  * @since 2022-10-20
  */
-public class Organization {
+public class Organization implements BaseImplementation<Organization> {
 
     private final OrganizationService service;
     protected HashMap<String, String> headers;
@@ -65,6 +66,18 @@ public Organization addHeader(@NotNull String key, @NotNull String value) {
         return this;
     }
 
+    @Override
+    public Organization addParams(@NotNull HashMap<String, Object> params) {
+        this.params.putAll(params);
+        return this;
+    }
+
+    @Override
+    public Organization addHeaders(@NotNull HashMap<String, String> headers) {
+        this.headers.putAll(headers);
+        return this;
+    }
+
     /**
      * Sets header for the request
      *
@@ -89,17 +102,6 @@ protected Organization clearParams() {
         return this;
     }
 
-    /**
-     * Sets header for the request
-     *
-     * @param key header key for the request
-     * @return instance of {@link Organization}
-     */
-    public Organization removeParam(@NotNull String key) {
-        this.params.remove(key);
-        return this;
-    }
-
     /**
      * <b>Gets all organizations.</b><br>
      * The <b>Get all organizations</b> call lists all organizations related to the

src/main/java/com/contentstack/cms/stack/Alias.java

@@ -1,5 +1,6 @@
 package com.contentstack.cms.stack;
 
+import com.contentstack.cms.BaseImplementation;
 import okhttp3.ResponseBody;
 import org.jetbrains.annotations.NotNull;
 import org.json.simple.JSONObject;
@@ -18,12 +19,12 @@
  * @author ***REMOVED***
  * @version v0.1.0
  * @see <a href=
- *      "https://www.contentstack.com/docs/developers/apis/content-management-api/#aliases">About
- *      Aliases
- *      </a>
+ * "https://www.contentstack.com/docs/developers/apis/content-management-api/#aliases">About
+ * Aliases
+ * </a>
  * @since 2022-10-20
  */
-public class Alias {
+public class Alias implements BaseImplementation<Alias> {
 
     protected final Map<String, Object> headers;
     protected Map<String, Object> params;
@@ -57,36 +58,70 @@ protected Alias(Retrofit instance, String aliasUid) {
 
     /**
      * The addHeader function adds a key-value pair to the headers map.
-     * 
+     *
      * @param key   A string representing the key of the header. This is used to
      *              identify the header when
      *              retrieving or modifying it.
      * @param value The value parameter is of type Object, which means it can accept
      *              any type of object as
      *              its value.
+     * @return instance of the `Alias` class
      */
-    public void addHeader(@NotNull String key, @NotNull Object value) {
+    @Override
+    public Alias addHeader(@NotNull String key, @NotNull String value) {
         this.headers.put(key, value);
+        return this;
     }
 
     /**
      * The addParam function adds a key-value pair to a map.
-     * 
+     *
      * @param key   A string representing the key for the parameter. It is annotated
      *              with @NotNull,
      *              indicating that it cannot be null.
      * @param value The value parameter is of type Object, which means it can accept
      *              any type of object as
      *              its value.
      */
-    public void addParam(@NotNull String key, @NotNull Object value) {
+    @Override
+    public Alias addParam(@NotNull String key, @NotNull Object value) {
         this.params.put(key, value);
+        return this;
+    }
+
+    /**
+     * The addParam function adds a key-value pair to Alias
+     *
+     * @param params The "params" parameter is a HashMap that maps String keys to
+     *               Object values. It is
+     *               annotated with @NotNull, indicating that it cannot be null.
+     * @return instance of {@link Alias}
+     */
+    @Override
+    public Alias addParams(@NotNull HashMap<String, Object> params) {
+        this.params.putAll(params);
+        return this;
+    }
+
+    /**
+     * The removeParam function removes a key-value pair from
+     *
+     * @param headers A HashMap containing key-value pairs of headers, where the key
+     *                is a String
+     *                representing the header name and the value is a String
+     *                representing the header value.
+     * @return instance of Alias
+     */
+    @Override
+    public Alias addHeaders(@NotNull HashMap<String, String> headers) {
+        this.headers.putAll(headers);
+        return this;
     }
 
     /**
      * The removeParam function removes a parameter from a map using the specified
      * key.
-     * 
+     *
      * @param key The parameter "key" is of type String and is used to specify the
      *            key of the parameter
      *            that needs to be removed from the "params" collection.
@@ -107,9 +142,9 @@ protected void clearParams() {
      * @return Call
      * @author ***REMOVED***
      * @see <a href=
-     *      "https://www.contentstack.com/docs/developers/apis/content-management-api/#get-all-aliases">Get
-     *      all
-     *      aliases</a>
+     * "https://www.contentstack.com/docs/developers/apis/content-management-api/#get-all-aliases">Get
+     * all
+     * aliases</a>
      * @since 2022-10-20
      */
     public Call<ResponseBody> find() {
@@ -122,12 +157,12 @@ public Call<ResponseBody> find() {
      * @return Call
      * @author ***REMOVED***
      * @see <a href=
-     *      "https://www.contentstack.com/docs/developers/apis/content-management-api/#get-a-single-branch">
-     *      Get a single branch</a>
+     * "https://www.contentstack.com/docs/developers/apis/content-management-api/#get-a-single-branch">
+     * Get a single branch</a>
      * @since 2022-10-20
      */
     public Call<ResponseBody> fetch() {
-        Objects.requireNonNull(this.uid,"Global Field Uid can not be null or empty");
+        Objects.requireNonNull(this.uid, "Global Field Uid can not be null or empty");
         return this.service.single(this.headers, this.uid);
     }
 
@@ -142,15 +177,14 @@ public Call<ResponseBody> fetch() {
      * “Body” section, you need to provide
      * the UID of the new target branch that will be associated with the alias.
      *
-     * @param body
-     *             the request body
+     * @param body the request body
      * @return Call
      * @author ***REMOVED***
      * @see <a href=
-     *      "https://www.contentstack.com/docs/developers/apis/content-management-api/#assign-or-update-an-alias">Update
-     *      a
-     *      branch</a>
-     * @see #addHeader(String, Object) to add headers
+     * "https://www.contentstack.com/docs/developers/apis/content-management-api/#assign-or-update-an-alias">Update
+     * a
+     * branch</a>
+     * @see #addHeader(String, String) to add headers
      * @since 2022-10-20
      */
     public Call<ResponseBody> update(@NotNull JSONObject body) {
@@ -169,14 +203,14 @@ public Call<ResponseBody> update(@NotNull JSONObject body) {
      * @return Call
      * @author ***REMOVED***
      * @see <a href=
-     *      "https://www.contentstack.com/docs/developers/apis/content-management-api/#delete-an-alias">Delete
-     *      a branch</a>
-     * @see #addHeader(String, Object) to add headers
+     * "https://www.contentstack.com/docs/developers/apis/content-management-api/#delete-an-alias">Delete
+     * a branch</a>
+     * @see #addHeader(String, String) to add headers
      * @see #addParam(String, Object) to add query params
      * @since 2022-10-20
      */
     public Call<ResponseBody> delete() {
-        Objects.requireNonNull(this.uid,"Global Field Uid can not be null or empty");
+        Objects.requireNonNull(this.uid, "Global Field Uid can not be null or empty");
         return this.service.delete(this.headers, this.uid, this.params);
     }