Merge pull request #254 from kazuki-ma/UseBuilder

Use builder style in model/event class to make adding field more easyly and safely.

Author: kazuki-ma

line-bot-model/src/main/java/com/linecorp/bot/model/event/AccountLinkEvent.java

@@ -18,7 +18,6 @@
 
 import java.time.Instant;
 
-import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
@@ -35,12 +34,18 @@
  * Event object for when a user has linked his/her LINE account with a provider's service account.
  * You can reply to account link events.
  */
-@Value
-@Builder
-@AllArgsConstructor(access = AccessLevel.PRIVATE)
 @JsonTypeName("accountLink")
+@Value
+@Builder(toBuilder = true)
+@AllArgsConstructor(access = AccessLevel.PRIVATE, onConstructor = @__(@Deprecated))
+// TODO: Remove next release. Use builder() instead.
 @JsonDeserialize(builder = AccountLinkEvent.AccountLinkEventBuilder.class)
 public class AccountLinkEvent implements Event, ReplyEvent {
+    @JsonPOJOBuilder(withPrefix = "")
+    public static class AccountLinkEventBuilder {
+        // Providing builder instead of public constructor. Class body is filled by lombok.
+    }
+
     /**
      * Token for replying to this event.
      */
@@ -81,15 +86,10 @@ public class AccountLinkEvent implements Event, ReplyEvent {
      */
     @Deprecated
     public AccountLinkEvent(
-            @JsonProperty("replyToken") String replyToken,
-            @JsonProperty("source") Source source,
-            @JsonProperty("timestamp") Instant timestamp,
-            @JsonProperty("link") LinkContent link) {
+            String replyToken,
+            Source source,
+            Instant timestamp,
+            LinkContent link) {
         this(replyToken, source, timestamp, link, null);
     }
-
-    @JsonPOJOBuilder(withPrefix = "")
-    public static class AccountLinkEventBuilder {
-        // Filled by lombok
-    }
 }

line-bot-model/src/main/java/com/linecorp/bot/model/event/BeaconEvent.java

@@ -18,7 +18,6 @@
 
 import java.time.Instant;
 
-import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
@@ -34,12 +33,18 @@
 /**
  * Event object for when a user detects a LINE Beacon. You can reply to beacon events.
  */
-@Value
-@Builder
-@AllArgsConstructor(access = AccessLevel.PRIVATE)
 @JsonTypeName("beacon")
+@Value
+@Builder(toBuilder = true)
+@AllArgsConstructor(access = AccessLevel.PRIVATE, onConstructor = @__(@Deprecated))
+// TODO: Remove next release. Use builder() instead.
 @JsonDeserialize(builder = BeaconEvent.BeaconEventBuilder.class)
 public class BeaconEvent implements Event, ReplyEvent {
+    @JsonPOJOBuilder(withPrefix = "")
+    public static class BeaconEventBuilder {
+        // Providing builder instead of public constructor. Class body is filled by lombok.
+    }
+
     /**
      * Token for replying to this event.
      */
@@ -80,15 +85,10 @@ public class BeaconEvent implements Event, ReplyEvent {
      */
     @Deprecated
     public BeaconEvent(
-            @JsonProperty("replyToken") final String replyToken,
-            @JsonProperty("source") final Source source,
-            @JsonProperty("timestamp") final Instant timestamp,
-            @JsonProperty("beacon") final BeaconContent beacon) {
+            final String replyToken,
+            final Source source,
+            final Instant timestamp,
+            final BeaconContent beacon) {
         this(replyToken, source, beacon, timestamp, null);
     }
-
-    @JsonPOJOBuilder(withPrefix = "")
-    public static class BeaconEventBuilder {
-        // Filled by lombok
-    }
 }

line-bot-model/src/main/java/com/linecorp/bot/model/event/CallbackRequest.java

@@ -18,16 +18,26 @@
 
 import java.util.List;
 
-import com.fasterxml.jackson.annotation.JsonCreator;
-import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
 
+import lombok.AllArgsConstructor;
+import lombok.Builder;
 import lombok.Value;
 
 /**
  * Request object for webhook.
  */
 @Value
+@Builder(toBuilder = true)
+@AllArgsConstructor(onConstructor = @__(@Deprecated)) // TODO: Remove next release. Use builder() instead.
+@JsonDeserialize(builder = CallbackRequest.CallbackRequestBuilder.class)
 public class CallbackRequest {
+    @JsonPOJOBuilder(withPrefix = "")
+    public static class CallbackRequestBuilder {
+        // Providing builder instead of public constructor. Class body is filled by lombok.
+    }
+
     /**
      * A user ID of a bot that should receive webhook events. The user ID value is
      * a string that matches the regular expression, {@code U[0-9a-f]{32}}.
@@ -38,11 +48,4 @@ public class CallbackRequest {
      * List of events.
      */
     List<Event> events;
-
-    @JsonCreator
-    public CallbackRequest(@JsonProperty("events") final List<Event> events,
-                           @JsonProperty("destination") final String destination) {
-        this.events = events;
-        this.destination = destination;
-    }
 }

line-bot-model/src/main/java/com/linecorp/bot/model/event/FollowEvent.java

@@ -18,7 +18,6 @@
 
 import java.time.Instant;
 
-import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
@@ -33,12 +32,18 @@
 /**
  * Event object for when your account is added as a friend (or unblocked). You can reply to follow events.
  */
-@Value
-@Builder
-@AllArgsConstructor(access = AccessLevel.PRIVATE)
 @JsonTypeName("follow")
+@Value
+@Builder(toBuilder = true)
+@AllArgsConstructor(access = AccessLevel.PRIVATE, onConstructor = @__(@Deprecated))
+// TODO: Remove next release. Use builder() instead.
 @JsonDeserialize(builder = FollowEvent.FollowEventBuilder.class)
 public class FollowEvent implements Event, ReplyEvent {
+    @JsonPOJOBuilder(withPrefix = "")
+    public static class FollowEventBuilder {
+        // Providing builder instead of public constructor. Class body is filled by lombok.
+    }
+
     /**
      * Token for replying to this event.
      */
@@ -74,14 +79,9 @@ public class FollowEvent implements Event, ReplyEvent {
      */
     @Deprecated
     public FollowEvent(
-            @JsonProperty("replyToken") final String replyToken,
-            @JsonProperty("source") final Source source,
-            @JsonProperty("timestamp") final Instant timestamp) {
+            final String replyToken,
+            final Source source,
+            final Instant timestamp) {
         this(replyToken, source, timestamp, null);
     }
-
-    @JsonPOJOBuilder(withPrefix = "")
-    public static class FollowEventBuilder {
-        // Filled by lombok
-    }
 }

line-bot-model/src/main/java/com/linecorp/bot/model/event/JoinEvent.java

@@ -18,7 +18,6 @@
 
 import java.time.Instant;
 
-import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
@@ -33,12 +32,18 @@
 /**
  * Event object for when your account joins a group or talk room. You can reply to join events.
  */
-@Value
-@Builder
-@AllArgsConstructor(access = AccessLevel.PRIVATE)
 @JsonTypeName("join")
+@Value
+@Builder(toBuilder = true)
+@AllArgsConstructor(access = AccessLevel.PRIVATE, onConstructor = @__(@Deprecated))
+// TODO: Remove next release. Use builder() instead.
 @JsonDeserialize(builder = JoinEvent.JoinEventBuilder.class)
 public class JoinEvent implements Event, ReplyEvent {
+    @JsonPOJOBuilder(withPrefix = "")
+    public static class JoinEventBuilder {
+        // Providing builder instead of public constructor. Class body is filled by lombok.
+    }
+
     /**
      * Token for replying to this event.
      */
@@ -74,14 +79,9 @@ public class JoinEvent implements Event, ReplyEvent {
      */
     @Deprecated
     public JoinEvent(
-            @JsonProperty("replyToken") final String replyToken,
-            @JsonProperty("source") final Source source,
-            @JsonProperty("timestamp") final Instant timestamp) {
+            final String replyToken,
+            final Source source,
+            final Instant timestamp) {
         this(replyToken, source, timestamp, null);
     }
-
-    @JsonPOJOBuilder(withPrefix = "")
-    public static class JoinEventBuilder {
-        // Filled by lombok
-    }
 }

line-bot-model/src/main/java/com/linecorp/bot/model/event/LeaveEvent.java

@@ -18,7 +18,6 @@
 
 import java.time.Instant;
 
-import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
@@ -33,12 +32,18 @@
 /**
  * Event object for when your account leaves a group.
  */
-@Value
-@Builder
-@AllArgsConstructor(access = AccessLevel.PRIVATE)
 @JsonTypeName("leave")
+@Value
+@Builder(toBuilder = true)
+@AllArgsConstructor(access = AccessLevel.PRIVATE, onConstructor = @__(@Deprecated))
+// TODO: Remove next release. Use builder() instead.
 @JsonDeserialize(builder = LeaveEvent.LeaveEventBuilder.class)
 public class LeaveEvent implements Event {
+    @JsonPOJOBuilder(withPrefix = "")
+    public static class LeaveEventBuilder {
+        // Providing builder instead of public constructor. Class body is filled by lombok.
+    }
+
     /**
      * JSON object which contains the source of the event.
      */
@@ -69,13 +74,8 @@ public class LeaveEvent implements Event {
      */
     @Deprecated
     public LeaveEvent(
-            @JsonProperty("source") final Source source,
-            @JsonProperty("timestamp") final Instant timestamp) {
+            final Source source,
+            final Instant timestamp) {
         this(source, timestamp, null);
     }
-
-    @JsonPOJOBuilder(withPrefix = "")
-    public static class LeaveEventBuilder {
-        // Filled by lombok
-    }
 }

line-bot-model/src/main/java/com/linecorp/bot/model/event/MemberJoinedEvent.java

@@ -19,8 +19,6 @@
 import java.time.Instant;
 import java.util.List;
 
-import com.fasterxml.jackson.annotation.JsonCreator;
-import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
@@ -35,12 +33,18 @@
 /**
  * Event object for when a user joins a group or room that the bot is in.
  */
-@Value
-@Builder
-@AllArgsConstructor(access = AccessLevel.PRIVATE)
 @JsonTypeName("memberJoined")
+@Value
+@Builder(toBuilder = true)
+@AllArgsConstructor(access = AccessLevel.PRIVATE, onConstructor = @__(@Deprecated))
+// TODO: Remove next release. Use builder() instead.
 @JsonDeserialize(builder = MemberJoinedEvent.MemberJoinedEventBuilder.class)
 public class MemberJoinedEvent implements Event, ReplyEvent {
+    @JsonPOJOBuilder(withPrefix = "")
+    public static class MemberJoinedEventBuilder {
+        // Providing builder instead of public constructor. Class body is filled by lombok.
+    }
+
     /**
      * Token for replying to this event.
      */
@@ -81,26 +85,25 @@ public class MemberJoinedEvent implements Event, ReplyEvent {
      */
     @Deprecated
     public MemberJoinedEvent(
-            @JsonProperty("replyToken") final String replyToken,
-            @JsonProperty("source") final Source source,
-            @JsonProperty("joined") final JoinedMembers joined,
-            @JsonProperty("timestamp") final Instant timestamp) {
+            final String replyToken,
+            final Source source,
+            final JoinedMembers joined,
+            final Instant timestamp) {
         this(replyToken, source, timestamp, joined, null);
     }
 
-    @JsonPOJOBuilder(withPrefix = "")
-    public static class MemberJoinedEventBuilder {
-        // Filled by lombok
-    }
-
     @Value
+    @Builder(toBuilder = true)
+    @AllArgsConstructor(access = AccessLevel.PRIVATE, onConstructor = @__(@Deprecated))
+    // TODO: Remove next release. Use builder() instead.
+    @JsonDeserialize(builder = JoinedMembers.JoinedMembersBuilder.class)
     public static class JoinedMembers {
+        @JsonPOJOBuilder(withPrefix = "")
+        public static class JoinedMembersBuilder {
+            // Providing builder instead of public constructor. Class body is filled by lombok.
+        }
+
         // User ID of users who joined
         List<Source> members;
-
-        @JsonCreator
-        public JoinedMembers(@JsonProperty("members") List<Source> members) {
-            this.members = members;
-        }
     }
 }