com.lightstreamer.client.mpn.util

Class MpnBuilder

java.lang.Object

com.lightstreamer.client.mpn.util.MpnBuilder

public class MpnBuilder
extends java.lang.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 Google's Firebase Cloud Messaging (FCM). This format is compatible with MpnSubscription.setNotificationFormat(String).

See Also:

MpnSubscription.setNotificationFormat(String)

Constructor Summary

Constructors

Constructor and Description
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(java.lang.String notificationFormat) Creates an object based on the specified push notification format. Use getter methods to obtain the value of push notification fields.

Method Summary

Modifier and Type	Method and Description
java.lang.String	body() Gets the value of notification.body field.
MpnBuilder	body(java.lang.String body) Sets the notification.body field.
java.util.List<java.lang.String>	bodyLocArguments() Gets the value of notification.body_loc_args field.
MpnBuilder	bodyLocArguments(java.util.List<java.lang.String> bodyLocArguments) Sets the notification.body_loc_args field.
java.lang.String	bodyLocKey() Gets the value of notification.body_loc_key field.
MpnBuilder	bodyLocKey(java.lang.String bodyLocKey) Sets the notification.body_loc_key field.
java.lang.String	build() Produces the JSON structure for the push notification format specified by this object.
java.lang.String	clickAction() Gets the value of notification.click_action field.
MpnBuilder	clickAction(java.lang.String clickAction) Sets the notification.click_action field.
java.lang.String	collapseKey() Gets the value of collapse_key field.
MpnBuilder	collapseKey(java.lang.String collapseKey) Sets the collapse_key field.
java.lang.String	color() Gets the value of notification.color field.
MpnBuilder	color(java.lang.String color) Sets the notification.color field.
MpnBuilder	contentAvailable(java.lang.Boolean contentAvailable) Sets the content_available field with a boolean value.
MpnBuilder	contentAvailable(java.lang.String contentAvailable) Sets the content_available field with a string value.
java.lang.Boolean	contentAvailableAsBoolean() Gets the value of content_available field as a boolean.
java.lang.String	contentAvailableAsString() Gets the value of content_available field as a string.
java.util.Map<java.lang.String,java.lang.String>	data() Gets sub-fields of the data field.
MpnBuilder	data(java.util.Map<java.lang.String,java.lang.String> data) Sets sub-fields of the data field.
java.lang.String	icon() Gets the value of notification.icon field.
MpnBuilder	icon(java.lang.String icon) Sets the notification.icon field.
java.lang.String	priority() Gets the value of priority field.
MpnBuilder	priority(java.lang.String priority) Sets the priority field.
java.lang.String	sound() Gets the value of notification.sound field.
MpnBuilder	sound(java.lang.String sound) Sets the notification.sound field.
java.lang.String	tag() Gets the value of notification.tag field.
MpnBuilder	tag(java.lang.String tag) Sets the notification.tag field.
MpnBuilder	timeToLive(java.lang.Integer timeToLive) Sets the time_to_live field with an integer value.
MpnBuilder	timeToLive(java.lang.String timeToLive) Sets the time_to_live field with a string value.
java.lang.Integer	timeToLiveAsInteger() Gets the value of time_to_live field as an integer.
java.lang.String	timeToLiveAsString() Gets the value of time_to_live field as a string.
java.lang.String	title() Gets the value of notification.title field.
MpnBuilder	title(java.lang.String title) Sets the notification.title field.
java.util.List<java.lang.String>	titleLocArguments() Gets the value of notification.title_loc_args field.
MpnBuilder	titleLocArguments(java.util.List<java.lang.String> titleLocArguments) Sets the notification.title_loc_args field.
java.lang.String	titleLocKey() Gets the value of notification.title_loc_key field.
MpnBuilder	titleLocKey(java.lang.String titleLocKey) Sets the notification.title_loc_key field.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

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
                  java.lang.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:

java.lang.IllegalArgumentException - if the notification is not a valid JSON structure.

Method Detail

build

@Nonnull
public java.lang.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(java.lang.String collapseKey)

Sets the collapse_key field.

Parameters:

collapseKey - A string to be used for the collapse_key field value, or null to clear it.

Returns:

this MpnBuilder object, for fluent use.

collapseKey

public java.lang.String collapseKey()

Gets the value of collapse_key field.

Returns:

the value of collapse_key field, or null if absent.

priority

public MpnBuilder priority(java.lang.String priority)

Sets the priority field.

Parameters:

priority - A string to be used for the priority field value, or null to clear it.

Returns:

this MpnBuilder object, for fluent use.

priority

public java.lang.String priority()

Gets the value of priority field.

Returns:

the value of priority field, or null if absent.

contentAvailable

public MpnBuilder contentAvailable(java.lang.String contentAvailable)

Sets the content_available field with a string value.

Parameters:

contentAvailable - A string to be used for the content_available field value, or null to clear it.

Returns:

this MpnBuilder object, for fluent use.

contentAvailableAsString

public java.lang.String contentAvailableAsString()

Gets the value of content_available field as a string.

Returns:

a string with the value of content_available field, or null if absent.

contentAvailable

public MpnBuilder contentAvailable(java.lang.Boolean contentAvailable)

Sets the content_available field with a boolean value.

Parameters:

contentAvailable - A boolean to be used for the content_available field value, or null to clear it.

Returns:

this MpnBuilder object, for fluent use.

contentAvailableAsBoolean

public java.lang.Boolean contentAvailableAsBoolean()

Gets the value of content_available field as a boolean.

Returns:

a boolean with the value of content_available field, or null if absent.

timeToLive

public MpnBuilder timeToLive(java.lang.String timeToLive)

Sets the time_to_live field with a string value.

Parameters:

timeToLive - A string to be used for the time_to_live field value, or null to clear it.

Returns:

this MpnBuilder object, for fluent use.

timeToLiveAsString

public java.lang.String timeToLiveAsString()

Gets the value of time_to_live field as a string.

Returns:

a string with the value of time_to_live field, or null if absent.

timeToLive

public MpnBuilder timeToLive(java.lang.Integer timeToLive)

Sets the time_to_live field with an integer value.

Parameters:

timeToLive - An integer to be used for the time_to_live field value, or null to clear it.

Returns:

this MpnBuilder object, for fluent use.

timeToLiveAsInteger

public java.lang.Integer timeToLiveAsInteger()

Gets the value of time_to_live field as an integer.

Returns:

an integer with the value of time_to_live field, or null if absent.

title

public MpnBuilder title(java.lang.String title)

Sets the notification.title field.

Parameters:

title - A string to be used for the notification.title field value, or null to clear it.

Returns:

this MpnBuilder object, for fluent use.

title

public java.lang.String title()

Gets the value of notification.title field.

Returns:

the value of notification.title field, or null if absent.

titleLocKey

public MpnBuilder titleLocKey(java.lang.String titleLocKey)

Sets the notification.title_loc_key field.

Parameters:

titleLocKey - A string to be used for the notification.title_loc_key field value, or null to clear it.

Returns:

this MpnBuilder object, for fluent use.

titleLocKey

public java.lang.String titleLocKey()

Gets the value of notification.title_loc_key field.

Returns:

the value of notification.title_loc_key field, or null if absent.

titleLocArguments

public MpnBuilder titleLocArguments(java.util.List<java.lang.String> titleLocArguments)

Sets the notification.title_loc_args field.

Parameters:

titleLocArguments - A list of strings to be used for the notification.title_loc_args field value, or null to clear it.

Returns:

this MpnBuilder object, for fluent use.

titleLocArguments

public java.util.List<java.lang.String> titleLocArguments()

Gets the value of notification.title_loc_args field.

Returns:

a list of strings with the value of notification.title_loc_args field, or null if absent.

body

public MpnBuilder body(java.lang.String body)

Sets the notification.body field.

Parameters:

body - A string to be used for the notification.body field value, or null to clear it.

Returns:

this MpnBuilder object, for fluent use.

body

public java.lang.String body()

Gets the value of notification.body field.

Returns:

the value of notification.body field, or null if absent.

bodyLocKey

public MpnBuilder bodyLocKey(java.lang.String bodyLocKey)

Sets the notification.body_loc_key field.

Parameters:

bodyLocKey - A string to be used for the notification.body_loc_key field value, or null to clear it.

Returns:

this MpnBuilder object, for fluent use.

bodyLocKey

public java.lang.String bodyLocKey()

Gets the value of notification.body_loc_key field.

Returns:

the value of notification.body_loc_key field, or null if absent.

bodyLocArguments

public MpnBuilder bodyLocArguments(java.util.List<java.lang.String> bodyLocArguments)

Sets the notification.body_loc_args field.

Parameters:

bodyLocArguments - A list of strings to be used for the notification.body_loc_args field value, or null to clear it.

Returns:

this MpnBuilder object, for fluent use.

bodyLocArguments

public java.util.List<java.lang.String> bodyLocArguments()

Gets the value of notification.body_loc_args field.

Returns:

a list of strings with the value of notification.body_loc_args field, or null if absent.

icon

public MpnBuilder icon(java.lang.String icon)

Sets the notification.icon field.

Parameters:

icon - A string to be used for the notification.icon field value, or null to clear it.

Returns:

this MpnBuilder object, for fluent use.

icon

public java.lang.String icon()

Gets the value of notification.icon field.

Returns:

the value of notification.icon field, or null if absent.

sound

public MpnBuilder sound(java.lang.String sound)

Sets the notification.sound field.

Parameters:

sound - A string to be used for the notification.sound field value, or null to clear it.

Returns:

this MpnBuilder object, for fluent use.

sound

public java.lang.String sound()

Gets the value of notification.sound field.

Returns:

the value of notification.sound field, or null if absent.

tag

public MpnBuilder tag(java.lang.String tag)

Sets the notification.tag field.

Parameters:

tag - A string to be used for the notification.tag field value, or null to clear it.

Returns:

this MpnBuilder object, for fluent use.

tag

public java.lang.String tag()

Gets the value of notification.tag field.

Returns:

the value of notification.tag field, or null if absent.

color

public MpnBuilder color(java.lang.String color)

Sets the notification.color field.

Parameters:

color - A string to be used for the notification.color field value, or null to clear it.

Returns:

this MpnBuilder object, for fluent use.

color

public java.lang.String color()

Gets the value of notification.color field.

Returns:

the value of notification.color field, or null if absent.

clickAction

public MpnBuilder clickAction(java.lang.String clickAction)

Sets the notification.click_action field.

Parameters:

clickAction - A string to be used for the notification.click_action field value, or null to clear it.

Returns:

this MpnBuilder object, for fluent use.

clickAction

public java.lang.String clickAction()

Gets the value of notification.click_action field.

Returns:

the value of notification.click_action field, or null if absent.

data

public MpnBuilder data(java.util.Map<java.lang.String,java.lang.String> data)

Sets sub-fields of the data field.

Parameters:

data - A map to be used for sub-fields of the data field, or null to clear it.

Returns:

this MpnBuilder object, for fluent use.

data

public java.util.Map<java.lang.String,java.lang.String> data()

Gets sub-fields of the data field.

Returns:

A map with sub-fields of the data field, or null if absent.