Package com.lightstreamer.client.mpn

Class MpnBuilder

java.lang.Object
com.lightstreamer.client.mpn.MpnBuilder
public class MpnBuilder extends Object
Utility class that provides methods to build or parse the JSON structure used to represent the format of a push notification.
It provides getters and setters for the fields of a push notification, following the format specified by FCM REST API. This format is compatible with MpnSubscription.setNotificationFormat(String).
See Also:

  • Constructor Details

    • MpnBuilder

      public MpnBuilder()
      Creates an empty object to be used to create a push notification format from scratch.
      Use setters methods to set the value of push notification fields.

    • MpnBuilder

      public MpnBuilder(@Nonnull String notificationFormat)
      Creates an object based on the specified push notification format.
      Use getter methods to obtain the value of push notification fields.
      Parameters:
      notificationFormat - A JSON structure representing a push notification format.
      Throws:
      IllegalArgumentException - if the notification is not a valid JSON structure.

  • Method Details

    • build

      @Nonnull public String build()
      Produces the JSON structure for the push notification format specified by this object.
      Returns:
      the JSON structure for the push notification format.

    • collapseKey

      public MpnBuilder collapseKey(String collapseKey)
      Sets the android.collapse_key field.
      Parameters:
      collapseKey - A string to be used for the android.collapse_key field value, or null to clear it.
      Returns:
      this MpnBuilder object, for fluent use.

    • collapseKey

      public String collapseKey()
      Gets the value of android.collapse_key field.
      Returns:
      the value of android.collapse_key field, or null if absent.

    • priority

      public MpnBuilder priority(String priority)
      Sets the android.priority field.
      Parameters:
      priority - A string to be used for the android.priority field value, or null to clear it.
      Returns:
      this MpnBuilder object, for fluent use.

    • priority

      public String priority()
      Gets the value of android.priority field.
      Returns:
      the value of android.priority field, or null if absent.

    • timeToLive

      public MpnBuilder timeToLive(String timeToLive)
      Sets the android.ttl field with a string value.
      Parameters:
      timeToLive - A string to be used for the android.ttl field value, or null to clear it.
      Returns:
      this MpnBuilder object, for fluent use.

    • timeToLiveAsString

      public String timeToLiveAsString()
      Gets the value of android.ttl field as a string.
      Returns:
      a string with the value of android.ttl field, or null if absent.

    • timeToLive

      public MpnBuilder timeToLive(Integer timeToLive)
      Sets the android.ttl field with an integer value.
      Parameters:
      timeToLive - An integer to be used for the android.ttl field value, or null to clear it.
      Returns:
      this MpnBuilder object, for fluent use.

    • timeToLiveAsInteger

      public Integer timeToLiveAsInteger()
      Gets the value of android.ttl field as an integer.
      Returns:
      an integer with the value of android.ttl field, or null if absent.

    • title

      public MpnBuilder title(String title)
      Sets the android.notification.title field.
      Parameters:
      title - A string to be used for the android.notification.title field value, or null to clear it.
      Returns:
      this MpnBuilder object, for fluent use.

    • title

      public String title()
      Gets the value of android.notification.title field.
      Returns:
      the value of android.notification.title field, or null if absent.

    • titleLocKey

      public MpnBuilder titleLocKey(String titleLocKey)
      Sets the android.notification.title_loc_key field.
      Parameters:
      titleLocKey - A string to be used for the android.notification.title_loc_key field value, or null to clear it.
      Returns:
      this MpnBuilder object, for fluent use.

    • titleLocKey

      public String titleLocKey()
      Gets the value of android.notification.title_loc_key field.
      Returns:
      the value of android.notification.title_loc_key field, or null if absent.

    • titleLocArguments

      public MpnBuilder titleLocArguments(List<String> titleLocArguments)
      Sets the android.notification.title_loc_args field.
      Parameters:
      titleLocArguments - A list of strings to be used for the android.notification.title_loc_args field value, or null to clear it.
      Returns:
      this MpnBuilder object, for fluent use.

    • titleLocArguments

      public List<String> titleLocArguments()
      Gets the value of android.notification.title_loc_args field.
      Returns:
      a list of strings with the value of android.notification.title_loc_args field, or null if absent.

    • body

      public MpnBuilder body(String body)
      Sets the android.notification.body field.
      Parameters:
      body - A string to be used for the android.notification.body field value, or null to clear it.
      Returns:
      this MpnBuilder object, for fluent use.

    • body

      public String body()
      Gets the value of android.notification.body field.
      Returns:
      the value of android.notification.body field, or null if absent.

    • bodyLocKey

      public MpnBuilder bodyLocKey(String bodyLocKey)
      Sets the android.notification.body_loc_key field.
      Parameters:
      bodyLocKey - A string to be used for the android.notification.body_loc_key field value, or null to clear it.
      Returns:
      this MpnBuilder object, for fluent use.

    • bodyLocKey

      public String bodyLocKey()
      Gets the value of android.notification.body_loc_key field.
      Returns:
      the value of android.notification.body_loc_key field, or null if absent.

    • bodyLocArguments

      public MpnBuilder bodyLocArguments(List<String> bodyLocArguments)
      Sets the android.notification.body_loc_args field.
      Parameters:
      bodyLocArguments - A list of strings to be used for the android.notification.body_loc_args field value, or null to clear it.
      Returns:
      this MpnBuilder object, for fluent use.

    • bodyLocArguments

      public List<String> bodyLocArguments()
      Gets the value of android.notification.body_loc_args field.
      Returns:
      a list of strings with the value of android.notification.body_loc_args field, or null if absent.

    • icon

      public MpnBuilder icon(String icon)
      Sets the android.notification.icon field.
      Parameters:
      icon - A string to be used for the android.notification.icon field value, or null to clear it.
      Returns:
      this MpnBuilder object, for fluent use.

    • icon

      public String icon()
      Gets the value of android.notification.icon field.
      Returns:
      the value of android.notification.icon field, or null if absent.

    • sound

      public MpnBuilder sound(String sound)
      Sets the android.notification.sound field.
      Parameters:
      sound - A string to be used for the android.notification.sound field value, or null to clear it.
      Returns:
      this MpnBuilder object, for fluent use.

    • sound

      public String sound()
      Gets the value of android.notification.sound field.
      Returns:
      the value of android.notification.sound field, or null if absent.

    • tag

      public MpnBuilder tag(String tag)
      Sets the android.notification.tag field.
      Parameters:
      tag - A string to be used for the android.notification.tag field value, or null to clear it.
      Returns:
      this MpnBuilder object, for fluent use.

    • tag

      public String tag()
      Gets the value of android.notification.tag field.
      Returns:
      the value of android.notification.tag field, or null if absent.

    • color

      public MpnBuilder color(String color)
      Sets the android.notification.color field.
      Parameters:
      color - A string to be used for the android.notification.color field value, or null to clear it.
      Returns:
      this MpnBuilder object, for fluent use.

    • color

      public String color()
      Gets the value of android.notification.color field.
      Returns:
      the value of android.notification.color field, or null if absent.

    • clickAction

      public MpnBuilder clickAction(String clickAction)
      Sets the android.notification.click_action field.
      Parameters:
      clickAction - A string to be used for the android.notification.click_action field value, or null to clear it.
      Returns:
      this MpnBuilder object, for fluent use.

    • clickAction

      public String clickAction()
      Gets the value of android.notification.click_action field.
      Returns:
      the value of android.notification.click_action field, or null if absent.

    • data

      public MpnBuilder data(Map<String,String> data)
      Sets sub-fields of the android.data field.
      Parameters:
      data - A map to be used for sub-fields of the android.data field, or null to clear it.
      Returns:
      this MpnBuilder object, for fluent use.

    • data

      public Map<String,String> data()
      Gets sub-fields of the android.data field.
      Returns:
      A map with sub-fields of the android.data field, or null if absent.