net.sf.eBus.feed.pattern

Class MatchEvent

java.lang.Object

net.sf.eBus.messages.EMessageObject

net.sf.eBus.messages.EMessage

net.sf.eBus.messages.ENotificationMessage

net.sf.eBus.feed.pattern.MatchEvent

All Implemented Interfaces:

Serializable

@ELocalOnly
public final class MatchEvent
extends ENotificationMessage

A match event reports an event pattern match. Contains the capturing group map and the user-defined data cache.

Author:

Charles W. Rapp

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MatchEvent.Builder

Nested classes/interfaces inherited from class net.sf.eBus.messages.EMessage

EMessage.MessageType

Nested classes/interfaces inherited from class net.sf.eBus.messages.EMessageObject

EMessageObject.Validator

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,List<ENotificationMessage>>	groups The collected events for each pattern group.
Map<Object,Object>	userCache This map contains the user-defined data stored when MatchConditions were executed.

Fields inherited from class net.sf.eBus.messages.ENotificationMessage

NO_PUB_ID, position, publisherId

Fields inherited from class net.sf.eBus.messages.EMessage

subject, timestamp

Method Summary

Modifier and Type	Method and Description
static MatchEvent.Builder	builder() Returns a new MatchEvent builder instance.
List<ENotificationMessage>	group(String name) Returns the notification list associated with the given group name.
String	toString() Returns a string containing each of the groups and the group event.

Methods inherited from class net.sf.eBus.messages.ENotificationMessage

equals, hashCode

Methods inherited from class net.sf.eBus.messages.EMessage

isApplicationMessage, isSystemMessage, key, messageType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

groups

public final Map<String,List<ENotificationMessage>> groups

The collected events for each pattern group. Pattern group EventPattern.ALL_EVENTS contains all matched events. The remaining map keys (if any) are from the user-defined EventPattern. The groups map and the notification list values are both read-only.

userCache

public final Map<Object,Object> userCache

This map contains the user-defined data stored when MatchConditions were executed. This map is not null but may be empty.

Method Detail

toString

public String toString()

Returns a string containing each of the groups and the group event.

Overrides:

toString in class ENotificationMessage

Returns:

textual representation of the match event.

group

public List<ENotificationMessage> group(String name)

Returns the notification list associated with the given group name. May return null if there is not group with the given name.

Parameters:

name - group name.

Returns:

group event list.

builder

public static MatchEvent.Builder builder()

Returns a new MatchEvent builder instance.

Returns:

MatchEvent builder instance.