BrightSide Workbench Full Report + Source Code
org.turro.push.sender.AbstractPushSender Class Referenceabstract
Inheritance diagram for org.turro.push.sender.AbstractPushSender:
Collaboration diagram for org.turro.push.sender.AbstractPushSender:

Public Member Functions

AbstractPushSender addAdministrators ()
 
AbstractPushSender addBySyndication (String syndication)
 
AbstractPushSender addByRole (String role)
 
AbstractPushSender addByEntity (Object entity, Object data)
 
AbstractPushSender addByEntity (Object entity, boolean deep, Object data)
 
AbstractPushSender addByEntity (String path, Object data)
 
AbstractPushSender addByEntity (String path, boolean deep, Object data)
 
AbstractPushSender addContact (IContact contact)
 
AbstractPushSender addContacts (Collection< IContact > contacts)
 
AbstractPushSender addAssistant (Assistant assistant)
 
AbstractPushSender addAssistants (AssistantSet assistants)
 
AbstractPushSender addUser (String name, String email)
 
AbstractPushSender onStart (Consumer command)
 
AbstractPushSender onCancel (Consumer command)
 
AbstractPushSender onBuild (Consumer command)
 
AbstractPushSender onFinish (Consumer command)
 
AssistantSet getAssistants ()
 
void send (String title, String message)
 
void send (String title, String message, String link)
 
- Public Member Functions inherited from org.turro.action.IContactSender< IPushSender >
addAdministrators ()
 
addByEntity (Object entity, Object data)
 
addByEntity (Object entity, boolean deep, Object data)
 
addByEntity (String path, Object data)
 
addByEntity (String path, boolean deep, Object data)
 
addByRole (String role)
 
addBySyndication (String syndication)
 
addContact (IContact contact)
 
addContacts (Collection< IContact > contacts)
 
addAssistant (Assistant assistant)
 
addAssistants (AssistantSet assistants)
 
addUser (String name, String email)
 
AssistantSet getAssistants ()
 
default void copyFrom (IContactSender sender)
 

Public Attributes

final AssistantSet assistants = new AssistantSet()
 

Protected Member Functions

abstract void doSend (String title, String message, String link, Consumer onFinish)
 

Protected Attributes

Consumer onStart
 

Detailed Description

Author
Lluis TurrĂ³ Cutiller lluis.nosp@m.@tur.nosp@m.ro.or.nosp@m.g

Definition at line 36 of file AbstractPushSender.java.

Member Function Documentation

◆ addAdministrators()

AbstractPushSender org.turro.push.sender.AbstractPushSender.addAdministrators ( )

Definition at line 43 of file AbstractPushSender.java.

43  {
44  addBySyndication(SecurityGroup.BRIGHTSIDE_ADMIN);
45  return this;
46  }
AbstractPushSender addBySyndication(String syndication)
Here is the call graph for this function:

◆ addAssistant()

AbstractPushSender org.turro.push.sender.AbstractPushSender.addAssistant ( Assistant  assistant)

Definition at line 97 of file AbstractPushSender.java.

97  {
98  this.assistants.add(assistant);
99  return this;
100  }

◆ addAssistants()

AbstractPushSender org.turro.push.sender.AbstractPushSender.addAssistants ( AssistantSet  assistants)

Definition at line 103 of file AbstractPushSender.java.

103  {
104  for(Assistant assistant : assistants) {
105  this.assistants.add(assistant);
106  }
107  return this;
108  }

◆ addByEntity() [1/4]

AbstractPushSender org.turro.push.sender.AbstractPushSender.addByEntity ( Object  entity,
boolean  deep,
Object  data 
)

Definition at line 67 of file AbstractPushSender.java.

67  {
68  addByEntity(Entities.getController(entity).getPath(), deep, data);
69  return this;
70  }
AbstractPushSender addByEntity(Object entity, Object data)
Here is the call graph for this function:

◆ addByEntity() [2/4]

AbstractPushSender org.turro.push.sender.AbstractPushSender.addByEntity ( Object  entity,
Object  data 
)

Definition at line 61 of file AbstractPushSender.java.

61  {
62  addByEntity(entity, true, data);
63  return this;
64  }
Here is the caller graph for this function:

◆ addByEntity() [3/4]

AbstractPushSender org.turro.push.sender.AbstractPushSender.addByEntity ( String  path,
boolean  deep,
Object  data 
)

Definition at line 79 of file AbstractPushSender.java.

79  {
80  Assistants.addAssistants(path, true, assistants, data);
81  return this;
82  }
Here is the call graph for this function:

◆ addByEntity() [4/4]

AbstractPushSender org.turro.push.sender.AbstractPushSender.addByEntity ( String  path,
Object  data 
)

Definition at line 73 of file AbstractPushSender.java.

73  {
74  addByEntity(path, true, data);
75  return this;
76  }
Here is the call graph for this function:

◆ addByRole()

AbstractPushSender org.turro.push.sender.AbstractPushSender.addByRole ( String  role)

Definition at line 55 of file AbstractPushSender.java.

55  {
56  assistants.addContacts(Contacts.getByRole(role));
57  return this;
58  }
void addContacts(Collection< IContact > contacts)
Here is the call graph for this function:

◆ addBySyndication()

AbstractPushSender org.turro.push.sender.AbstractPushSender.addBySyndication ( String  syndication)

Definition at line 49 of file AbstractPushSender.java.

49  {
50  assistants.addContacts(Contacts.getBySyndication(syndication));
51  return this;
52  }
Here is the call graph for this function:
Here is the caller graph for this function:

◆ addContact()

AbstractPushSender org.turro.push.sender.AbstractPushSender.addContact ( IContact  contact)

Definition at line 85 of file AbstractPushSender.java.

85  {
86  assistants.addContact(contact, null);
87  return this;
88  }
void addContact(IContact contact, Object relationEntity)
Here is the call graph for this function:

◆ addContacts()

AbstractPushSender org.turro.push.sender.AbstractPushSender.addContacts ( Collection< IContact contacts)

Definition at line 91 of file AbstractPushSender.java.

91  {
92  assistants.addContacts(contacts);
93  return this;
94  }
Here is the call graph for this function:

◆ addUser()

AbstractPushSender org.turro.push.sender.AbstractPushSender.addUser ( String  name,
String  email 
)

Definition at line 111 of file AbstractPushSender.java.

111  {
112  assistants.addUser(name, email, null);
113  return this;
114  }
void addUser(String name, String email, Object relationEntity)
Here is the call graph for this function:

◆ doSend()

abstract void org.turro.push.sender.AbstractPushSender.doSend ( String  title,
String  message,
String  link,
Consumer  onFinish 
)
abstractprotected

Reimplemented in org.turro.push.sender.PushPool.

Here is the caller graph for this function:

◆ getAssistants()

AssistantSet org.turro.push.sender.AbstractPushSender.getAssistants ( )

Definition at line 141 of file AbstractPushSender.java.

141  {
142  return assistants;
143  }

◆ onBuild()

AbstractPushSender org.turro.push.sender.AbstractPushSender.onBuild ( Consumer  command)

Implements org.turro.action.IPushSender.

Definition at line 129 of file AbstractPushSender.java.

129  {
130  onBuild = command;
131  return this;
132  }

◆ onCancel()

AbstractPushSender org.turro.push.sender.AbstractPushSender.onCancel ( Consumer  command)

Implements org.turro.action.IPushSender.

Definition at line 123 of file AbstractPushSender.java.

123  {
124  onCancel = command;
125  return this;
126  }

◆ onFinish()

AbstractPushSender org.turro.push.sender.AbstractPushSender.onFinish ( Consumer  command)

Implements org.turro.action.IPushSender.

Definition at line 135 of file AbstractPushSender.java.

135  {
136  onFinish = command;
137  return this;
138  }

◆ onStart()

AbstractPushSender org.turro.push.sender.AbstractPushSender.onStart ( Consumer  command)

Implements org.turro.action.IPushSender.

Definition at line 117 of file AbstractPushSender.java.

117  {
118  onStart = command;
119  return this;
120  }

◆ send() [1/2]

void org.turro.push.sender.AbstractPushSender.send ( String  title,
String  message 
)

Implements org.turro.action.IPushSender.

Definition at line 148 of file AbstractPushSender.java.

148  {
149  doSend(title, message, null, onFinish);
150  }
abstract void doSend(String title, String message, String link, Consumer onFinish)
Here is the call graph for this function:

◆ send() [2/2]

void org.turro.push.sender.AbstractPushSender.send ( String  title,
String  message,
String  link 
)

Implements org.turro.action.IPushSender.

Definition at line 153 of file AbstractPushSender.java.

153  {
154  doSend(title, message, link, onFinish);
155  }
Here is the call graph for this function:

Member Data Documentation

◆ assistants

final AssistantSet org.turro.push.sender.AbstractPushSender.assistants = new AssistantSet()

Definition at line 38 of file AbstractPushSender.java.

◆ onStart

Consumer org.turro.push.sender.AbstractPushSender.onStart
protected

Definition at line 40 of file AbstractPushSender.java.


The documentation for this class was generated from the following file: