com.axemble.vdoc.sdk.interfaces.notification

Interface INotificationEmitter<T extends INotificationData>

All Superinterfaces:

AutoCloseable, Closeable

public interface INotificationEmitter<T extends INotificationData>
extends Closeable

Represents a notification emitter for an INotificationData type.

Method Summary

Modifier and Type	Method and Description
void	addRecipient(INotificationRecipient recipient) Add a INotificationRecipient to the recipient list which will be used to emit the next INotificationData.
void	clear() Clear the previously added INotificationRecipient(s)
INotificationRecipientBuilder	createRecipientBuilder() Produce and return a new instance of INotificationRecipientBuilder
void	emit(T notificationData) Emit the INotificationData with the previously added INotificationRecipient (addRecipient(INotificationRecipient)) and clear the previously added INotificationRecipient(s)
void	emit(T notificationData, boolean clearRecipients) Emit the INotificationData with the previously added INotificationRecipient (addRecipient(INotificationRecipient))

Methods inherited from interface java.io.Closeable

close

Method Detail

createRecipientBuilder

INotificationRecipientBuilder createRecipientBuilder()

Produce and return a new instance of INotificationRecipientBuilder

Returns:

a new INotificationRecipientBuilder instance

addRecipient

void addRecipient(INotificationRecipient recipient)

Add a INotificationRecipient to the recipient list which will be used to emit the next INotificationData.

Parameters:

recipient - the INotificationRecipient to add

emit

void emit(T notificationData)

Emit the INotificationData with the previously added INotificationRecipient (addRecipient(INotificationRecipient)) and clear the previously added INotificationRecipient(s)

Parameters:

notificationData - the INotificationData to emit

emit

void emit(T notificationData,
          boolean clearRecipients)

Emit the INotificationData with the previously added INotificationRecipient (addRecipient(INotificationRecipient))

Parameters:

notificationData - the INotificationData to emit

clearRecipients - if true the previously added INotificationRecipient will be clear after emit the INotificationData data, otherwise the previously added recipients won't be changed.

clear

void clear()

Clear the previously added INotificationRecipient(s)