EventAggregator (hawtdispatch API Reference (1.11))

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.fusesource.hawtdispatch
Interface EventAggregator<Event,MergedEvent>

All Known Subinterfaces:: OrderedEventAggregator<Event,MergedEvent>

public interface EventAggregator<Event,MergedEvent>

The EventAggregator interface is used by the CustomDispatchSource objects to handle coalescing data before passing it to the application. Implementations of this class should be stateless to remain thread-safe. You can also use one of several built in implementations:

Author:: Hiram Chirino

Method Summary
`MergedEvent`	`mergeEvent(MergedEvent previous, Event event)` Merge the given event with the previous event values.
`MergedEvent`	`mergeEvents(MergedEvent previous, MergedEvent events)` Merge the given events with the previous event values.

Method Detail

mergeEvent

MergedEvent mergeEvent(MergedEvent previous,
                       Event event)

Merge the given event with the previous event values.

Parameters:: previous - may be null; event - the value that should be merged
Returns:: a newly merged result

mergeEvents

MergedEvent mergeEvents(MergedEvent previous,
                        MergedEvent events)

Merge the given events with the previous event values.

Parameters:: previous - the value of previous merges; events - the value of more merges
Returns:: a newly merged result