Apply JsonIgnore annotation to prevent Jackson for serializing extra …

…methods
yetanalytics · Dec 10, 2024 · 46b9f84 · 46b9f84
1 parent 90704aa
commit 46b9f84
Show file tree

Hide file tree

Showing 19 changed files with 62 additions and 3 deletions.
diff --git a/src/main/java/com/yetanalytics/xapi/model/AbstractActor.java b/src/main/java/com/yetanalytics/xapi/model/AbstractActor.java
@@ -1,5 +1,6 @@
 package com.yetanalytics.xapi.model;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.yetanalytics.xapi.model.deserializers.AbstractActorDeserializer;
 
@@ -81,6 +82,7 @@ protected int countIFIs() {
     public abstract boolean isValidAuthority();
 
     @Override
+    @JsonIgnore
     public boolean isEmpty() {
         return (
             mbox == null && mbox_sha1sum == null &&

diff --git a/src/main/java/com/yetanalytics/xapi/model/AbstractObject.java b/src/main/java/com/yetanalytics/xapi/model/AbstractObject.java
@@ -1,5 +1,6 @@
 package com.yetanalytics.xapi.model;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.yetanalytics.xapi.model.deserializers.AbstractObjectDeserializer;
 
@@ -19,5 +20,6 @@ public void setObjectType(ObjectType objectType) {
     }
 
     @Override
+    @JsonIgnore
     public abstract boolean isEmpty();
 }
diff --git a/src/main/java/com/yetanalytics/xapi/model/Account.java b/src/main/java/com/yetanalytics/xapi/model/Account.java
@@ -1,5 +1,6 @@
 package com.yetanalytics.xapi.model;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
 
@@ -33,6 +34,7 @@ public void setName(String name) {
     }
 
     @Override
+    @JsonIgnore
     @AssertFalse
     public boolean isEmpty() {
         return homePage == null && name == null;

diff --git a/src/main/java/com/yetanalytics/xapi/model/Activity.java b/src/main/java/com/yetanalytics/xapi/model/Activity.java
@@ -1,5 +1,6 @@
 package com.yetanalytics.xapi.model;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
@@ -36,6 +37,7 @@ public void setDefinition(ActivityDefinition definition) {
     }
 
     @Override
+    @JsonIgnore
     @AssertFalse
     public boolean isEmpty() {
         return id == null && definition == null;

diff --git a/src/main/java/com/yetanalytics/xapi/model/ActivityDefinition.java b/src/main/java/com/yetanalytics/xapi/model/ActivityDefinition.java
@@ -2,6 +2,7 @@
 
 import java.util.List;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
 
@@ -164,6 +165,7 @@ private boolean isNoInteraction() {
     }
 
     @Override
+    @JsonIgnore
     @AssertFalse
     public boolean isEmpty() {
         return (
@@ -173,6 +175,7 @@ public boolean isEmpty() {
         );
     }
 
+    @JsonIgnore
     @AssertTrue
     public boolean isValidInteractionActivity() {
         if (interactionType == null) {

diff --git a/src/main/java/com/yetanalytics/xapi/model/Agent.java b/src/main/java/com/yetanalytics/xapi/model/Agent.java
@@ -1,5 +1,6 @@
 package com.yetanalytics.xapi.model;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
@@ -19,6 +20,7 @@ public class Agent extends AbstractActor {
     // Validation
 
     @Override
+    @JsonIgnore
     @AssertFalse
     public boolean isEmpty() {
         return super.isEmpty();
@@ -28,12 +30,14 @@ public boolean isEmpty() {
      * Assertion that the Agent has only 1 Inverse Functional Identifier (IFI).
      * @return true if the Agent has exactly 1 IFI, false otherwise
      */
+    @JsonIgnore
     @AssertTrue
     public boolean isIdentifiedAgent() {
         return countIFIs() == 1;
     }
 
     @Override
+    @JsonIgnore
     public boolean isValidAuthority() {
         return true;
     }

diff --git a/src/main/java/com/yetanalytics/xapi/model/Attachment.java b/src/main/java/com/yetanalytics/xapi/model/Attachment.java
@@ -1,5 +1,6 @@
 package com.yetanalytics.xapi.model;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
 
@@ -69,7 +70,10 @@ public void setFileUrl(String fileUrl) {
         this.fileUrl = fileUrl;
     }
 
+    // Validation
+
     @Override
+    @JsonIgnore
     @AssertFalse
     public boolean isEmpty() {
         return (

diff --git a/src/main/java/com/yetanalytics/xapi/model/Context.java b/src/main/java/com/yetanalytics/xapi/model/Context.java
@@ -2,6 +2,7 @@
 
 import java.util.UUID;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
 
@@ -80,6 +81,7 @@ public void setExtensions(Extensions extensions) {
     }
 
     @Override
+    @JsonIgnore
     @AssertFalse
     public boolean isEmpty() {
         return (

diff --git a/src/main/java/com/yetanalytics/xapi/model/ContextActivities.java b/src/main/java/com/yetanalytics/xapi/model/ContextActivities.java
@@ -2,14 +2,14 @@
 
 import java.util.List;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonInclude.Include;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.yetanalytics.xapi.model.deserializers.ContextActivityListDeserializer;
 
 import jakarta.validation.constraints.AssertFalse;
 
-import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.annotation.JsonInclude.Include;
-
 /**
 * Class representation of the Context Activities Component of the 
 * <a href="https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Data.md#2462-contextactivities-property">9274.1.1 xAPI Specification</a>.
@@ -52,6 +52,7 @@ public void setOther(List<Activity> other) {
     }
 
     @Override
+    @JsonIgnore
     @AssertFalse
     public boolean isEmpty() {
         return (

diff --git a/src/main/java/com/yetanalytics/xapi/model/Extensions.java b/src/main/java/com/yetanalytics/xapi/model/Extensions.java
@@ -4,6 +4,7 @@
 import java.util.Map;
 import java.util.Set;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
@@ -100,6 +101,7 @@ public Map<String, Object> getMap() {
     }
 
     @Override
+    @JsonIgnore
     @AssertFalse
     public boolean isEmpty() {
         return extMap.isEmpty();

diff --git a/src/main/java/com/yetanalytics/xapi/model/Group.java b/src/main/java/com/yetanalytics/xapi/model/Group.java
@@ -2,6 +2,7 @@
 
 import java.util.List;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
@@ -27,6 +28,7 @@ public void setMember(List<Agent> member) {
         this.member = member;
     }
 
+    @JsonIgnore
     @AssertTrue
     public boolean isAnonymousOrIdentifiedGroup() {
         return (
@@ -40,6 +42,7 @@ private boolean isValidConsumer(Agent consumer) {
     }
 
     @Override
+    @JsonIgnore
     public boolean isValidAuthority() {
         return (
             member.size() == 2 &&
@@ -51,6 +54,7 @@ public boolean isValidAuthority() {
     }
 
     @Override
+    @JsonIgnore
     @AssertFalse
     public boolean isEmpty() {
         // zero-length member arrays still count as non-empty

diff --git a/src/main/java/com/yetanalytics/xapi/model/InteractionComponent.java b/src/main/java/com/yetanalytics/xapi/model/InteractionComponent.java
@@ -1,4 +1,5 @@
 package com.yetanalytics.xapi.model;
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
 
@@ -33,7 +34,10 @@ public void setDescription(LangMap description) {
         this.description = description;
     }
 
+    // Validation
+
     @Override
+    @JsonIgnore
     @AssertFalse
     public boolean isEmpty() {
         return id == null && description == null;

diff --git a/src/main/java/com/yetanalytics/xapi/model/LangMap.java b/src/main/java/com/yetanalytics/xapi/model/LangMap.java
@@ -4,6 +4,7 @@
 import java.util.Map;
 import java.util.Set;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.yetanalytics.xapi.model.deserializers.LangMapDeserializer;
@@ -75,6 +76,7 @@ public Map<String, String> getMap() {
     }
 
     @Override
+    @JsonIgnore
     @AssertFalse
     public boolean isEmpty() {
         return languageHashMap.isEmpty();

diff --git a/src/main/java/com/yetanalytics/xapi/model/Result.java b/src/main/java/com/yetanalytics/xapi/model/Result.java
@@ -1,5 +1,6 @@
 package com.yetanalytics.xapi.model;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
 
@@ -58,7 +59,10 @@ public void setExtensions(Extensions extensions) {
         this.extensions = extensions;
     }
 
+    // Validation
+
     @Override
+    @JsonIgnore
     @AssertFalse
     public boolean isEmpty() {
         return (

diff --git a/src/main/java/com/yetanalytics/xapi/model/Score.java b/src/main/java/com/yetanalytics/xapi/model/Score.java
@@ -2,6 +2,7 @@
 
 import java.math.BigDecimal;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
 
@@ -52,6 +53,7 @@ public void setScaled(BigDecimal scaled) {
 
     // Validation
 
+    @JsonIgnore
     @AssertTrue
     public boolean isMinLessThanRaw() {
         if (raw != null && min != null) {
@@ -61,6 +63,7 @@ public boolean isMinLessThanRaw() {
         }
     }
 
+    @JsonIgnore
     @AssertTrue
     public boolean isRawLessThanMax() {
         if (raw != null && max != null) {
@@ -70,6 +73,7 @@ public boolean isRawLessThanMax() {
         }
     }
 
+    @JsonIgnore
     @AssertTrue
     public boolean isMinLessThanMax() {
         if (min != null && max != null) {
@@ -80,6 +84,7 @@ public boolean isMinLessThanMax() {
     }
 
     @Override
+    @JsonIgnore
     @AssertFalse
     public boolean isEmpty() {
         return raw == null && min == null && max == null && scaled == null;

diff --git a/src/main/java/com/yetanalytics/xapi/model/Statement.java b/src/main/java/com/yetanalytics/xapi/model/Statement.java
@@ -4,6 +4,7 @@
 import java.util.List;
 import java.util.UUID;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
@@ -145,6 +146,7 @@ public void setAttachments(List<Attachment> attachments) {
 
     // Validation
 
+    @JsonIgnore
     @AssertTrue
     public boolean isValidVoidingStatement() {
         if (verb != null && verb.isVoiding()) {
@@ -162,6 +164,7 @@ private boolean isObjectActivity() {
         }
     }
 
+    @JsonIgnore
     @AssertTrue
     public boolean isValidContextRevision() {
         return (
@@ -171,6 +174,7 @@ public boolean isValidContextRevision() {
         );
     }
 
+    @JsonIgnore
     @AssertTrue
     public boolean isValidContextPlatform() {
         return (
@@ -181,6 +185,7 @@ public boolean isValidContextPlatform() {
     }
 
     // TODO: Somehow validate this on the Authority object itself
+    @JsonIgnore
     @AssertTrue
     public boolean isValidAuthority() {
         return authority == null || authority.isValidAuthority();
@@ -198,6 +203,7 @@ private boolean isValidSubStmt() {
 
     // TODO: Validate this on the SubStatement itself
     // (e.g. setting the objectType field)
+    @JsonIgnore
     @AssertTrue
     public boolean isValidSubStatement() {
         // System.out.println("Object is Statement: " + (object instanceof Statement));
@@ -211,6 +217,7 @@ public boolean isValidSubStatement() {
     }
 
     @Override
+    @JsonIgnore
     @AssertFalse
     public boolean isEmpty() {
         return (

diff --git a/src/main/java/com/yetanalytics/xapi/model/StatementRef.java b/src/main/java/com/yetanalytics/xapi/model/StatementRef.java
@@ -2,6 +2,7 @@
 
 import java.util.UUID;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
@@ -28,6 +29,7 @@ public void setId(UUID id) {
     }
 
     @Override
+    @JsonIgnore
     @AssertFalse
     public boolean isEmpty() {
         return id == null;

diff --git a/src/main/java/com/yetanalytics/xapi/model/StatementResult.java b/src/main/java/com/yetanalytics/xapi/model/StatementResult.java
@@ -2,6 +2,7 @@
 
 import java.util.List;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
 
@@ -36,6 +37,7 @@ public void setMore(String more) {
     }
 
     @Override
+    @JsonIgnore
     @AssertFalse
     public boolean isEmpty() {
         return statements == null && more == null;