|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.xwiki.eventstream.EventGroup
public class EventGroup
A group of related events, all happening as a consequence of the same action.
Constructor Summary | |
---|---|
EventGroup()
Default constructor that creates an empty event group. |
|
EventGroup(Event... events)
Constructor that creates a group containing the passed events. |
|
EventGroup(List<Event> events)
Constructor that creates a group containing the passed events. |
|
EventGroup(Set<Event> events)
Constructor that creates a group containing the passed events. |
Method Summary | |
---|---|
void |
addEvents(Event... events)
Add more events to this group. |
void |
clearEvents()
Remove all the events from this group. |
Set<Event> |
getEvents()
List the events that are part of this group. |
Event |
getMainEvent()
Get the most important event in this group. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public EventGroup()
public EventGroup(List<Event> events)
events
- the list of initial events to put in the grouppublic EventGroup(Set<Event> events)
events
- the list of initial events to put in the grouppublic EventGroup(Event... events)
events
- the list of initial events to put in the groupMethod Detail |
---|
public Set<Event> getEvents()
public void addEvents(Event... events)
Set
.
events
- the new events to addpublic void clearEvents()
public Event getMainEvent()
importance
property of events. If more events have the same maximal importance, the first one found in the group
is returned. Usually this corresponds to the order the events were created, but this is not a guaranteed
property.
null
if the group is empty.public String toString()
toString
in class Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |