Add label field to ImageMap.

This closes #440. (thank you for reporting it)

Author: kazuki-ma

line-bot-model/src/main/java/com/linecorp/bot/model/message/imagemap/MessageImagemapAction.java

@@ -16,17 +16,30 @@
 
 package com.linecorp.bot.model.message.imagemap;
 
-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;
 
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
 import lombok.Value;
 
 /**
  * MessageImagemapAction - When a region is tapped, the message specified in message is sent.
  */
-@Value
 @JsonTypeName("message")
+@Value
+@Builder(toBuilder = true)
+@AllArgsConstructor(access = AccessLevel.PRIVATE, onConstructor = @__(@Deprecated))
+// TODO: Remove next release. Use builder() instead.
+@JsonDeserialize(builder = MessageImagemapAction.MessageImagemapActionBuilder.class)
 public class MessageImagemapAction implements ImagemapAction {
+    @JsonPOJOBuilder(withPrefix = "")
+    public static class MessageImagemapActionBuilder {
+        // Providing builder instead of public constructor. Class body is filled by lombok.
+    }
+
     /**
      * Message to send.
      */
@@ -37,9 +50,17 @@ public class MessageImagemapAction implements ImagemapAction {
      */
     ImagemapArea area;
 
-    public MessageImagemapAction(@JsonProperty("text") String text,
-                                 @JsonProperty("area") ImagemapArea area) {
+    String label;
+
+    /**
+     * MessageImagemapAction constructor.
+     *
+     * @deprecated Use builder method instead. This construct will remove in next major release.
+     */
+    @Deprecated
+    public MessageImagemapAction(String text, ImagemapArea area) {
         this.text = text;
         this.area = area;
+        this.label = null;
     }
 }

line-bot-model/src/main/java/com/linecorp/bot/model/message/imagemap/URIImagemapAction.java

@@ -16,17 +16,30 @@
 
 package com.linecorp.bot.model.message.imagemap;
 
-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;
 
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
 import lombok.Value;
 
 /**
  * URLImagemapAction - When a region is tapped, the user is redirected to the URI specified.
  */
-@Value
 @JsonTypeName("uri")
+@Value
+@Builder(toBuilder = true)
+@AllArgsConstructor(access = AccessLevel.PRIVATE, onConstructor = @__(@Deprecated))
+// TODO: Remove next release. Use builder() instead.
+@JsonDeserialize(builder = URIImagemapAction.URIImagemapActionBuilder.class)
 public class URIImagemapAction implements ImagemapAction {
+    @JsonPOJOBuilder(withPrefix = "")
+    public static class URIImagemapActionBuilder {
+        // Providing builder instead of public constructor. Class body is filled by lombok.
+    }
+
     /**
      * Webpage URL.
      */
@@ -37,9 +50,17 @@ public class URIImagemapAction implements ImagemapAction {
      */
     ImagemapArea area;
 
-    public URIImagemapAction(@JsonProperty("linkUri") String linkUri,
-                             @JsonProperty("area") ImagemapArea area) {
+    String label;
+
+    /**
+     * URIImagemapAction constructor.
+     *
+     * @deprecated Use builder method instead. This construct will remove in next major release.
+     */
+    @Deprecated
+    public URIImagemapAction(String linkUri, ImagemapArea area) {
         this.linkUri = linkUri;
         this.area = area;
+        this.label = null;
     }
 }

sample-spring-boot-kitchensink/src/main/java/com/example/bot/spring/KitchenSinkController.java

@@ -33,7 +33,6 @@
 import java.util.concurrent.ExecutionException;
 import java.util.function.Consumer;
 import java.util.stream.Collectors;
-import java.util.stream.Stream;
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.servlet.support.ServletUriComponentsBuilder;
@@ -492,18 +491,22 @@ private void handleTextContent(String replyToken, Event event, TextMessageConten
                         .altText("This is alt text")
                         .baseSize(new ImagemapBaseSize(1040, 1040))
                         .actions(Arrays.asList(
-                                new URIImagemapAction(
-                                        "https://store.line.me/family/manga/en",
-                                        new ImagemapArea(0, 0, 520, 520)),
-                                new URIImagemapAction(
-                                        "https://store.line.me/family/music/en",
-                                        new ImagemapArea(520, 0, 520, 520)),
-                                new URIImagemapAction(
-                                        "https://store.line.me/family/play/en",
-                                        new ImagemapArea(0, 520, 520, 520)),
-                                new MessageImagemapAction(
-                                        "URANAI!",
-                                        new ImagemapArea(520, 520, 520, 520))
+                                URIImagemapAction.builder()
+                                                 .linkUri("https://store.line.me/family/manga/en")
+                                                 .area(new ImagemapArea(0, 0, 520, 520))
+                                                 .build(),
+                                URIImagemapAction.builder()
+                                                 .linkUri("https://store.line.me/family/music/en")
+                                                 .area(new ImagemapArea(520, 0, 520, 520))
+                                                 .build(),
+                                URIImagemapAction.builder()
+                                                 .linkUri("https://store.line.me/family/play/en")
+                                                 .area(new ImagemapArea(0, 520, 520, 520))
+                                                 .build(),
+                                MessageImagemapAction.builder()
+                                                     .text("URANAI!")
+                                                     .area(new ImagemapArea(520, 520, 520, 520))
+                                                     .build()
                         ))
                         .build());
                 break;
@@ -527,11 +530,12 @@ private void handleTextContent(String replyToken, Event event, TextMessageConten
                                              )
                                              .build()
                         )
-                        .actions(Stream.of(
-                                new MessageImagemapAction(
-                                        "NIXIE CLOCK",
-                                        new ImagemapArea(260, 600, 450, 86)
-                                )).collect(Collectors.toList()))
+                        .actions(singletonList(
+                                MessageImagemapAction.builder()
+                                                     .text("NIXIE CLOCK")
+                                                     .area(new ImagemapArea(260, 600, 450, 86))
+                                                     .build()
+                        ))
                         .build());
                 break;
             case "flex":