#92 - introduce RelationshipObject, ToOneRelationshipObject and ToManyRelationshipObject classes; do all needed refactorings for the model classes

Author: MoonWorm

jsonapi4j-base/src/main/java/pro/api4/jsonapi4j/model/document/BaseDoc.java

@@ -1,43 +1,27 @@
 package pro.api4.jsonapi4j.model.document;
 
+import lombok.AllArgsConstructor;
 import lombok.EqualsAndHashCode;
+import lombok.Getter;
 import lombok.ToString;
 import pro.api4.jsonapi4j.model.document.data.JsonApiObject;
 
 /**
  * Carries common members ('links' and 'meta') that exist for all types of JSON:API data documents regardless of their
  * nature (all types of relationship & resource docs, error docs, meta doc).
  */
+@Getter
 @ToString
 @EqualsAndHashCode
+@AllArgsConstructor
 public abstract class BaseDoc {
 
     public static final String LINKS_FIELD = "links";
     public static final String META_FIELD = "meta";
     public static final String JSONAPI_FIELD = "jsonapi";
 
-    private LinksObject links;
-    private Object meta;
-    private JsonApiObject jsonapi;
-
-    public BaseDoc(LinksObject links,
-                   Object meta,
-                   JsonApiObject jsonapi) {
-        this.links = links;
-        this.meta = meta;
-        this.jsonapi = jsonapi;
-    }
-
-    public LinksObject getLinks() {
-        return links;
-    }
-
-    public Object getMeta() {
-        return meta;
-    }
-
-    public JsonApiObject getJsonapi() {
-        return jsonapi;
-    }
+    private final LinksObject links;
+    private final Object meta;
+    private final JsonApiObject jsonapi;
 
 }

jsonapi4j-base/src/main/java/pro/api4/jsonapi4j/model/document/LinksObject.java

@@ -1,9 +1,6 @@
 package pro.api4.jsonapi4j.model.document;
 
-import lombok.EqualsAndHashCode;
-import lombok.Getter;
-import lombok.Setter;
-import lombok.ToString;
+import lombok.*;
 import lombok.experimental.SuperBuilder;
 
 /**
@@ -15,6 +12,7 @@
 @EqualsAndHashCode
 @ToString
 @SuperBuilder
+@AllArgsConstructor
 public class LinksObject {
 
     public static final String SELF_FIELD = "self";
@@ -25,12 +23,4 @@ public class LinksObject {
     private Object related;
     private String next;
 
-    public LinksObject(String self,
-                       Object related,
-                       String next) {
-        this.self = self;
-        this.related = related;
-        this.next = next;
-    }
-
 }

jsonapi4j-base/src/main/java/pro/api4/jsonapi4j/model/document/data/AbstractMultipleDataItemsDoc.java

@@ -1,8 +1,15 @@
 package pro.api4.jsonapi4j.model.document.data;
 
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
 import java.net.URI;
 import java.util.List;
 
+@Getter
+@EqualsAndHashCode
+@ToString
 public class JsonApiObject {
 
     public static final String JSONAPI_VERSION_1_0 = "1.0";
@@ -13,10 +20,10 @@ public class JsonApiObject {
     public static final String PROFILE_FIELD = "profile";
     public static final String META_FIELD = "meta";
 
-    private String version;
-    private List<URI> ext;
-    private List<URI> profile;
-    private Object meta;
+    private final String version;
+    private final List<URI> ext;
+    private final List<URI> profile;
+    private final Object meta;
 
     public JsonApiObject(String version,
                          List<URI> ext,
@@ -37,9 +44,7 @@ public JsonApiObject(List<URI> ext,
     public JsonApiObject(String version,
                          List<URI> ext,
                          List<URI> profile) {
-        this.version = version;
-        this.ext = ext;
-        this.profile = profile;
+        this(version, ext, profile, null);
     }
 
     public JsonApiObject(List<URI> ext,

jsonapi4j-base/src/main/java/pro/api4/jsonapi4j/model/document/data/AbstractSingleDataItemDoc.java

@@ -1,5 +1,7 @@
 package pro.api4.jsonapi4j.model.document.data;
 
+import lombok.Getter;
+import pro.api4.jsonapi4j.model.document.BaseDoc;
 import pro.api4.jsonapi4j.model.document.LinksObject;
 import lombok.EqualsAndHashCode;
 import lombok.ToString;
@@ -62,17 +64,25 @@
  *     }
  * </pre>
  */
+@Getter
 @EqualsAndHashCode(callSuper = true)
 @ToString(callSuper = true)
-public class MultipleResourcesDoc<PRIMARY_RESOURCE extends ResourceObject<?, ?>>
-        extends AbstractMultipleDataItemsDoc<PRIMARY_RESOURCE> {
+public class MultipleResourcesDoc<PRIMARY_RESOURCE extends ResourceObject<?, ?>> extends BaseDoc {
+
+    public static final String DATA_FIELD = "data";
+    public static final String INCLUDED_FIELD = "included";
+
+    private final List<PRIMARY_RESOURCE> data;
+    private final List<? extends ResourceObject<?, ?>> included;
 
     public MultipleResourcesDoc(List<PRIMARY_RESOURCE> data,
                                 LinksObject links,
                                 Object meta,
                                 List<? extends ResourceObject<?, ?>> included,
                                 JsonApiObject jsonapi) {
-        super(data, links, meta, included, jsonapi);
+        super(links, meta, jsonapi);
+        this.data = data;
+        this.included = included;
     }
 
     public MultipleResourcesDoc(List<PRIMARY_RESOURCE> data,

jsonapi4j-base/src/main/java/pro/api4/jsonapi4j/model/document/data/JsonApiObject.java

@@ -0,0 +1,29 @@
+package pro.api4.jsonapi4j.model.document.data;
+
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+import pro.api4.jsonapi4j.model.document.LinksObject;
+
+@Getter
+@ToString
+@EqualsAndHashCode
+public class RelationshipObject {
+
+    public static final String LINKS_FIELD = "links";
+    public static final String META_FIELD = "meta";
+
+    private final LinksObject links;
+    private final Object meta;
+
+    public RelationshipObject(LinksObject links,
+                              Object meta) {
+        this.links = links;
+        this.meta = meta;
+    }
+
+    public RelationshipObject(LinksObject links) {
+        this(links, null);
+    }
+
+}

jsonapi4j-base/src/main/java/pro/api4/jsonapi4j/model/document/data/MultipleResourcesDoc.java

@@ -1,14 +1,16 @@
 package pro.api4.jsonapi4j.model.document.data;
 
 import lombok.EqualsAndHashCode;
+import lombok.Getter;
 import lombok.ToString;
 
 /**
  * JSON:API Specification reference:
  * <a href="https://jsonapi.org/format/#document-resource-identifier-objects">Resource Identifier Object</a>
  */
-@EqualsAndHashCode(of = {"id", "type"})
-@ToString(of = {"id", "type"})
+@Getter
+@EqualsAndHashCode
+@ToString
 public class ResourceIdentifierObject {
 
     public static final String ID_FIELD = "id";
@@ -18,8 +20,8 @@ public class ResourceIdentifierObject {
 
     private final String id;
     private final String type;
-    private Object meta;
-    private String lid;
+    private final Object meta;
+    private final String lid;
 
     public ResourceIdentifierObject(String id,
                                     String type,
@@ -34,29 +36,12 @@ public ResourceIdentifierObject(String id,
     public ResourceIdentifierObject(String id,
                                     String type,
                                     Object meta) {
-        this.id = id;
-        this.type = type;
-        this.meta = meta;
+        this(id, type, meta, null);
     }
 
     public ResourceIdentifierObject(String id,
                                     String type) {
         this(id, type, null);
     }
 
-    public String getId() {
-        return id;
-    }
-
-    public String getType() {
-        return type;
-    }
-
-    public Object getMeta() {
-        return meta;
-    }
-
-    public String getLid() {
-        return lid;
-    }
 }

jsonapi4j-base/src/main/java/pro/api4/jsonapi4j/model/document/data/RelationshipObject.java

@@ -1,23 +1,25 @@
 package pro.api4.jsonapi4j.model.document.data;
 
 import lombok.EqualsAndHashCode;
+import lombok.Getter;
 import lombok.ToString;
 import pro.api4.jsonapi4j.model.document.LinksObject;
 
 /**
  * Spec ref: <a href="https://jsonapi.org/format/#document-resource-objects">Resource Object</a>
  */
-@ToString(callSuper = true, exclude = {"attributes", "relationships", "links"})
-@EqualsAndHashCode(exclude = {"links"}, callSuper = true)
+@Getter
+@EqualsAndHashCode(callSuper = true)
+@ToString(callSuper = true)
 public class ResourceObject<A, R> extends ResourceIdentifierObject {
 
     public static final String ATTRIBUTES_FIELD = "attributes";
     public static final String RELATIONSHIPS_FIELD = "relationships";
     public static final String LINKS_FIELD = "links";
 
-    private A attributes;
-    private R relationships;
-    private LinksObject links;
+    private final A attributes;
+    private final R relationships;
+    private final LinksObject links;
 
     public ResourceObject(String id,
                           String type,
@@ -46,16 +48,4 @@ public ResourceObject(String id,
         this(id, type, attributes, relationships, null);
     }
 
-    public A getAttributes() {
-        return attributes;
-    }
-
-    public R getRelationships() {
-        return relationships;
-    }
-
-    public LinksObject getLinks() {
-        return links;
-    }
-
 }