Package dev.getelements.elements.service.notification

Class StandardNotificationBuilder

java.lang.Object

dev.getelements.elements.service.notification.StandardNotificationBuilder

All Implemented Interfaces:

NotificationBuilder, NotificationParameters

public class StandardNotificationBuilder
extends Object
implements NotificationBuilder, NotificationParameters

Constructor Summary

Constructors

Constructor	Description
StandardNotificationBuilder()

Method Summary

Modifier and Type	Method	Description
NotificationBuilder	add(String key, String value)	Adds a single key/value property.
NotificationBuilder	addAll(Map<String,String> allData)	Adds all properties in the passed in mapping to the notification being built.
NotificationBuilder	application(Application application)	Specifies the Application sourcing the Notification.
Notification	build()	Constructs the instance of Notification with all of the configured information.
Application	getApplication()	Gets the Application sending the notification.
Map<String,String>	getExtraProperties()	Gets a read-only mapping of extra key/value properties associated with this notification.
String	getMessage()	Gets the message of the notification.
Function<NotificationParameters,Notification>	getNotificationFactory()
Profile	getRecipient()	Gets the singular Profile who will recieve the notification.
String	getSound()	Gets the sound to play when delivering the message.
String	getTitle()	Ges the title of the notification.
NotificationBuilder	message(String message)	Specifies the text to send along with the Notification.
NotificationBuilder	recipient(Profile recipient)	Specifies the Profile which will receive the Notification.
void	setNotificationFactory(NotificationFactory notificationFactory)
NotificationBuilder	sound(String sound)	Specifies the sound to play when delivering the message.
NotificationBuilder	title(String title)	Specifies the title text of the Notification.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface dev.getelements.elements.sdk.service.notification.NotificationBuilder

sender, sound

Constructor Details

StandardNotificationBuilder

public StandardNotificationBuilder()

Method Details

application

public NotificationBuilder application(Application application)

Description copied from interface: NotificationBuilder

Specifies the Application sourcing the Notification. This will scan the associated ApplicationConfiguration instances and select a suitable configuration (or combination thereof) which will be used to configure the means by which the underlying Notification will be sent.

Specified by:

application in interface NotificationBuilder

Parameters:

application - the Application sending the Notification

Returns:

this instance

recipient

public NotificationBuilder recipient(Profile recipient)

Description copied from interface: NotificationBuilder

Specifies the Profile which will receive the Notification.

Specified by:

recipient in interface NotificationBuilder

Parameters:

recipient - the Profile which will recieve the Notification

Returns:

this instance

title

public NotificationBuilder title(String title)

Description copied from interface: NotificationBuilder

Specifies the title text of the Notification.

Specified by:

title in interface NotificationBuilder

Parameters:

title - the title text

Returns:

this instance

message

public NotificationBuilder message(String message)

Description copied from interface: NotificationBuilder

Specifies the text to send along with the Notification.

Specified by:

message in interface NotificationBuilder

Parameters:

message - the message to send

Returns:

this instance

sound

public NotificationBuilder sound(String sound)

Description copied from interface: NotificationBuilder

Specifies the sound to play when delivering the message.

Specified by:

sound in interface NotificationBuilder

Parameters:

sound - the sound to play when delivering the message

Returns:

this instance

add

public NotificationBuilder add(@Nonnull
 String key,
 @Nonnull
 String value)

Description copied from interface: NotificationBuilder

Adds a single key/value property. Individual keys should be non-empty and all values should be non-null

Specified by:

add in interface NotificationBuilder

Parameters:

key - - A non-empty string key for the property

value - - A non-null string value for the property

Returns:

this instance

addAll

public NotificationBuilder addAll(Map<String,String> allData)

Description copied from interface: NotificationBuilder

Adds all properties in the passed in mapping to the notification being built. Any keys which are null or empty Strings will be ignored. Any values which are null will be ignored. For all other entries, if any keys previously exist in the notification, they will be replaced by the value specified in the passed in Map. If a value is null, then that

Specified by:

addAll in interface NotificationBuilder

Parameters:

allData - - A Map of all properties to be added in bulk to this notification.

Returns:

this instance

getRecipient

public Profile getRecipient()

Description copied from interface: NotificationParameters

Gets the singular Profile who will recieve the notification.

Specified by:

getRecipient in interface NotificationParameters

Returns:

getApplication

public Application getApplication()

Description copied from interface: NotificationParameters

Gets the Application sending the notification.

Specified by:

getApplication in interface NotificationParameters

Returns:

the Application

getTitle

public String getTitle()

Description copied from interface: NotificationParameters

Ges the title of the notification.

Specified by:

getTitle in interface NotificationParameters

Returns:

the title

getMessage

public String getMessage()

Description copied from interface: NotificationParameters

Gets the message of the notification.

Specified by:

getMessage in interface NotificationParameters

Returns:

the message of the notification

getSound

public String getSound()

Description copied from interface: NotificationParameters

Gets the sound to play when delivering the message. Null indicates no sound will be played.

Specified by:

getSound in interface NotificationParameters

Returns:

the sound name or null

getExtraProperties

@Nonnull
public Map<String,String> getExtraProperties()

Description copied from interface: NotificationParameters

Gets a read-only mapping of extra key/value properties associated with this notification. If there are no extra properties, an empty map is returned

Specified by:

getExtraProperties in interface NotificationParameters

Returns:

A read-only Map of extra properties

build

public Notification build()

Description copied from interface: NotificationBuilder

Constructs the instance of Notification with all of the configured information. This returns a new instance of Notification for each call which can be treated independently.

Specified by:

build in interface NotificationBuilder

Returns:

the Notification

getNotificationFactory

public Function<NotificationParameters,Notification> getNotificationFactory()

setNotificationFactory

@Inject
public void setNotificationFactory(NotificationFactory notificationFactory)

toString

public String toString()

Overrides:

toString in class Object