Index (eBus Feed 6.1.0 API)

A B C D E F G I K M N O P S T U V
All Classes All Packages

A

AbstractMatchFrame(String, boolean) - Constructor for class net.sf.eBus.feed.pattern.EPatternFeed.AbstractMatchFrame: Creates a new match frame for the given pattern and exclusivity flag.
AbstractMatchFrame(EPatternFeed.AbstractMatchFrame) - Constructor for class net.sf.eBus.feed.pattern.EPatternFeed.AbstractMatchFrame: Copies the given frame data into this frame.
addMapping(ENotificationMessage, EPatternFeed.AbstractMatchFrame) - Method in class net.sf.eBus.feed.pattern.EPatternFeed: Adds a mapping from the given event to the match frame which now contains the event.
addSubordinate(String) - Method in class net.sf.eBus.feed.pattern.EventPattern.Builder: Adds a subordinate, unconditional single component to the current multi-component.
addSubordinate(String, MatchCondition) - Method in class net.sf.eBus.feed.pattern.EventPattern.Builder: Adds a subordinate, conditional single component to the current multi-component.
ALL_EVENTS - Static variable in class net.sf.eBus.feed.pattern.EventPattern: The group "__ALL_EVENTS__" contains all matched events in received order.
allEvents() - Method in class net.sf.eBus.feed.pattern.EPatternFeed.AbstractMatchFrame: Returns the "all events" collection as an unmodifiable list.

B

beginGroup(String) - Method in class net.sf.eBus.feed.pattern.EventPattern.Builder: Creates a new named capture group.
beginMultiComponent() - Method in class net.sf.eBus.feed.pattern.EventPattern.Builder
beginParameter(String) - Method in class net.sf.eBus.feed.pattern.EventPattern.Builder: Begin a parameter definition for the given parameter name.
beginParameterMap() - Method in class net.sf.eBus.feed.pattern.EventPattern.Builder: Begins the parameter map definition.
beginSingleComponent(String) - Method in class net.sf.eBus.feed.pattern.EventPattern.Builder: Begins the collection of event pattern single parameter component.
build() - Method in class net.sf.eBus.feed.pattern.EventPattern.Builder: Returns a new event pattern constructed from the parameter map, components, and until duration entered into this builder.
builder() - Static method in class net.sf.eBus.feed.pattern.MatchEvent: Returns a new MatchEvent builder instance.
builder(String, EventPattern.PatternType) - Static method in class net.sf.eBus.feed.pattern.EventPattern: Returns a named, ordered or unordered event pattern builder which has no pre-defined parameters.
builder(String, EventPattern.PatternType, Map<String, EventPattern.FeedInfo>) - Static method in class net.sf.eBus.feed.pattern.EventPattern: Returns a named, ordered or unordered event pattern builder using the given parameters.
buildImpl() - Method in class net.sf.eBus.feed.pattern.MatchEvent.Builder: Returns a new MatchEvent instance based on this builder's configuration.

C

componentTest(ENotificationMessage, EPatternFeed.AbstractMatchFrame, MatchCondition) - Static method in class net.sf.eBus.feed.pattern.EPatternFeed
condition() - Method in class net.sf.eBus.feed.pattern.EventPattern.FeedInfo: Returns the optional subscription feed condition.
condition(ECondition) - Method in class net.sf.eBus.feed.pattern.EventPattern.Builder: Sets the optional subscription feed condition.

D

DEFAULT_CONDITION - Static variable in class net.sf.eBus.feed.pattern.EventPattern: Default match event which always returns true.
DEFAULT_MATCH_COUNT - Static variable in class net.sf.eBus.feed.pattern.EventPattern: The default minimum and maximum match count is 1.
DEFAULT_PREDICATE - Static variable in class net.sf.eBus.feed.pattern.EventPattern: Default event match predicate returns true.
DEFAULT_UNTIL - Static variable in class net.sf.eBus.feed.pattern.EventPattern: The default until predicate always returns true.

E

endGroup(String) - Method in class net.sf.eBus.feed.pattern.EventPattern.Builder: Closes the named capture group.
endMultiComponent() - Method in class net.sf.eBus.feed.pattern.EventPattern.Builder
endParameter() - Method in class net.sf.eBus.feed.pattern.EventPattern.Builder: Ends the event pattern parameter definition using the previously specified name, event message key, and event feed scope.
endParameterMap() - Method in class net.sf.eBus.feed.pattern.EventPattern.Builder: Ends the parameter map definition which begins the event pattern definition.
endSingleComponent() - Method in class net.sf.eBus.feed.pattern.EventPattern.Builder: Adds the defined single event pattern component to the component list.
EPatternFeed - Class in net.sf.eBus.feed.pattern: eBus pattern feeds sit between eBus notification events and an eBus client, searching for a client-specified event pattern in the notification event stream.
EPatternFeed(EClient, EventPattern) - Constructor for class net.sf.eBus.feed.pattern.EPatternFeed: Creates a new eBus pattern feed for the given subscriber client and event pattern.
EPatternFeed.AbstractMatchFrame - Class in net.sf.eBus.feed.pattern: A match frame tracks an in-progress match.
EventPattern - Class in net.sf.eBus.feed.pattern: EventPattern provides the two pieces of information needed to do pattern matching: 1) the notification feeds providing the events used in the match and 2) the pattern itself.
EventPattern.Builder - Class in net.sf.eBus.feed.pattern: Builder is the only way to create an EventFeed instance.
EventPattern.FeedInfo - Class in net.sf.eBus.feed.pattern: This class provides the information needed by EPatternFeed to open and subscribe to a notification message feed.
EventPattern.PatternType - Enum in net.sf.eBus.feed.pattern: eBus patterns come in two varieties: ordered and unordered.

F

feedInfo(String) - Method in class net.sf.eBus.feed.pattern.EventPattern: Returns EventPattern.FeedInfo for the given feed name.
FeedInfo(EMessageKey, EFeed.FeedScope) - Constructor for class net.sf.eBus.feed.pattern.EventPattern.FeedInfo: Creates subscription feed information for the given notification message key and feed scope.
FeedInfo(EMessageKey, EFeed.FeedScope, ECondition) - Constructor for class net.sf.eBus.feed.pattern.EventPattern.FeedInfo: Creates subscription feed information for the given notification message key, feed scope, and optional feed condition.
frameId() - Method in class net.sf.eBus.feed.pattern.EPatternFeed.AbstractMatchFrame: Returns the unique match frame identifier.

G

group(String) - Method in class net.sf.eBus.feed.pattern.MatchEvent: Returns the notification list associated with the given group name.
groupMap() - Method in class net.sf.eBus.feed.pattern.EPatternFeed.AbstractMatchFrame: Returns a read-only copy of the group map.
groups - Variable in class net.sf.eBus.feed.pattern.MatchEvent: The collected events for each pattern group.
groups(Map<String, List<ENotificationMessage>>) - Method in class net.sf.eBus.feed.pattern.MatchEvent.Builder: Sets the message collection map to the given value.

I

inactivate() - Method in class net.sf.eBus.feed.pattern.EPatternFeed: Retracts all in place, subordinate feed subscriptions.
isDefunct() - Method in class net.sf.eBus.feed.pattern.EPatternFeed.AbstractMatchFrame: Returns true if this match frame is defunct due to a prior exclusive matching and, therefore, may no longer be used.
isExclusive() - Method in class net.sf.eBus.feed.pattern.EPatternFeed.AbstractMatchFrame: Returns true if this is an exclusive feed; false otherwise.
isExclusive() - Method in class net.sf.eBus.feed.pattern.EPatternFeed: Returns true if this is an exclusive pattern feed.
isExclusive() - Method in class net.sf.eBus.feed.pattern.EventPattern: Returns true if the events matching this pattern are used in one match only.
isExclusive(boolean) - Method in class net.sf.eBus.feed.pattern.EventPattern.Builder

K

key() - Method in class net.sf.eBus.feed.pattern.EPatternFeed: Returns a message key with MatchEvent as the class and the event pattern name as the subject.

M

mAllEvents - Variable in class net.sf.eBus.feed.pattern.EPatternFeed.AbstractMatchFrame: Contains all events matching the pattern so far.
mAllSubFeedsMask - Variable in class net.sf.eBus.feed.pattern.EPatternFeed: Bit mask for all subordinate feeds.
markDefunct(List<ENotificationMessage>) - Method in class net.sf.eBus.feed.pattern.EPatternFeed: Marks all of the match frames associated with the given events as defunct.
matchCondition(MatchCondition) - Method in class net.sf.eBus.feed.pattern.EventPattern.Builder: Sets the component match condition to the given predicate.
MatchCondition - Interface in net.sf.eBus.feed.pattern: Implement this method to test if the latest event matches the pattern.
matchCount(int) - Method in class net.sf.eBus.feed.pattern.EventPattern.Builder: Sets the minimum and maximum match counts to the same value.
matchCount(int, int) - Method in class net.sf.eBus.feed.pattern.EventPattern.Builder: Sets the minimum and maximum match counts to the given values.
matchEvent(ENotificationMessage, int) - Method in class net.sf.eBus.feed.pattern.EPatternFeed: Applies event to the pattern.
MatchEvent - Class in net.sf.eBus.feed.pattern: A match event reports an event pattern match.
MatchEvent.Builder - Class in net.sf.eBus.feed.pattern
mCondition - Variable in class net.sf.eBus.feed.pattern.EPatternFeed: Match event is posted to subscriber if-and-only-if the match event satisfies this condition.
messageKey() - Method in class net.sf.eBus.feed.pattern.EventPattern.FeedInfo: Returns the subscription notification message key.
messageKey(String) - Method in class net.sf.eBus.feed.pattern.EventPattern: Returns the message key associated with the given feed name.
messageKey(EMessageKey) - Method in class net.sf.eBus.feed.pattern.EventPattern.Builder: Sets the parameter notification message key.
mEventFrames - Variable in class net.sf.eBus.feed.pattern.EPatternFeed: Maps an accepted notification event to the match frames in which it appears.
mIsDefunct - Variable in class net.sf.eBus.feed.pattern.EPatternFeed.AbstractMatchFrame: Set to true when a match frame is 1) used for an exclusive pattern, 2) the pattern is completely matched, and 3) this frame contains common events with the completely matched frame.
mIsExclusive - Variable in class net.sf.eBus.feed.pattern.EPatternFeed.AbstractMatchFrame: true if this match frame is for an exclusive pattern.
mIsExclusive - Variable in class net.sf.eBus.feed.pattern.EPatternFeed: Set to true if an event may be used for only one match.
mNotifyCallback - Variable in class net.sf.eBus.feed.pattern.EPatternFeed: Notification message callback.
mPatternName - Variable in class net.sf.eBus.feed.pattern.EPatternFeed.AbstractMatchFrame: Match frame created by this pattern.
mPatternName - Variable in class net.sf.eBus.feed.pattern.EPatternFeed: Pattern name used as the MatchEvent subject.
mPatternName - Variable in class net.sf.eBus.feed.pattern.EventPattern: Pattern name used as the MatchEvent subject.
mPubKey - Variable in class net.sf.eBus.feed.pattern.EPatternFeed: Publish match events on this message key.
mStatusCallback - Variable in class net.sf.eBus.feed.pattern.EPatternFeed: Feed status callback.
mSubFeedMask - Variable in class net.sf.eBus.feed.pattern.EPatternFeed: Bit mask used to determine if all subordinate feeds are up.
mSubFeeds - Variable in class net.sf.eBus.feed.pattern.EPatternFeed: Maps the feed identifier to the subordinate notify feed.
mUntil - Variable in class net.sf.eBus.feed.pattern.EPatternFeed: Collected matching events must satisfy this until predicate.
mUserCache - Variable in class net.sf.eBus.feed.pattern.EPatternFeed.AbstractMatchFrame: Cache for storing interim, user-defined data calculated while performing a MatchCondition.

N

net.sf.eBus.feed.pattern - package net.sf.eBus.feed.pattern: This package contains specialized feeds extending the basic feeds in net.sf.eBus.client.
notifyCallback(NotifyCallback) - Method in class net.sf.eBus.feed.pattern.EPatternFeed: Puts the MatchEvent notification message callback in place.

O

onEvent(ENotificationMessage, IESubscribeFeed) - Method in class net.sf.eBus.feed.pattern.EPatternFeed: Runs event through the state machine if-and-only-if all the subordinate feeds are up.
onFeedStateUpdate(EFeedState, IESubscribeFeed) - Method in class net.sf.eBus.feed.pattern.EPatternFeed: Updates the feed bit in the subordinate feed mask.
open(ESubscriber, EventPattern) - Static method in class net.sf.eBus.feed.pattern.EPatternFeed: Opens either an ordered pattern or unordered pattern based on pattern type.
ORDERED - net.sf.eBus.feed.pattern.EventPattern.PatternType: Ordered patterns specify event arrival order and event minimum and maximum quantities.

P

parameters() - Method in class net.sf.eBus.feed.pattern.EventPattern: Returns the read-only event pattern parameters map.
patternCondition(Predicate<MatchEvent>) - Method in class net.sf.eBus.feed.pattern.EventPattern.Builder
patternName() - Method in class net.sf.eBus.feed.pattern.EPatternFeed.AbstractMatchFrame: Returns the pattern name.
patternName() - Method in class net.sf.eBus.feed.pattern.EventPattern: Returns the user-assigned pattern name.
patternType() - Method in class net.sf.eBus.feed.pattern.EventPattern: Returns the pattern type.

S

scope() - Method in class net.sf.eBus.feed.pattern.EventPattern.FeedInfo: Returns the subscription feed scope.
scope(EFeed.FeedScope) - Method in class net.sf.eBus.feed.pattern.EventPattern.Builder: Sets the subscription feed scope.
setDefunct() - Method in class net.sf.eBus.feed.pattern.EPatternFeed.AbstractMatchFrame: Marks this match frame as defunct.
sLogger - Static variable in class net.sf.eBus.feed.pattern.EPatternFeed: Logging subsystem interface.
statusCallback(FeedStatusCallback<IESubscribeFeed>) - Method in class net.sf.eBus.feed.pattern.EPatternFeed: Puts the subscription feed status callback in place.
subscribe() - Method in class net.sf.eBus.feed.pattern.EPatternFeed: Activates this event pattern feed by putting the subordinate subscription feeds in place.

T

test(ENotificationMessage, Map<String, List<ENotificationMessage>>, Map<Object, Object>) - Method in interface net.sf.eBus.feed.pattern.MatchCondition: Returns true if event satisfies this condition, allowing the event pattern matching to continue or complete.
toString() - Method in class net.sf.eBus.feed.pattern.EPatternFeed.AbstractMatchFrame
toString() - Method in class net.sf.eBus.feed.pattern.MatchEvent: Returns a string containing each of the groups and the group event.

U

UNORDERED - net.sf.eBus.feed.pattern.EventPattern.PatternType: Unordered patterns specify event minimum and maximum quantities only, allowing events to arrive in any order.
unsubscribe() - Method in class net.sf.eBus.feed.pattern.EPatternFeed
until(BiPredicate<List<ENotificationMessage>, ENotificationMessage>) - Method in class net.sf.eBus.feed.pattern.EventPattern.Builder
userCache - Variable in class net.sf.eBus.feed.pattern.MatchEvent: This map contains the user-defined data stored when MatchConditions were executed.
userCache() - Method in class net.sf.eBus.feed.pattern.EPatternFeed.AbstractMatchFrame: Returns the user-defined match data cache.
userCache(Map<Object, Object>) - Method in class net.sf.eBus.feed.pattern.MatchEvent.Builder: Sets the user cache to the given value.

V

validate(Validator) - Method in class net.sf.eBus.feed.pattern.MatchEvent.Builder: Checks if this builder is correctly configured before attempting to build the target message instance.
valueOf(String) - Static method in enum net.sf.eBus.feed.pattern.EventPattern.PatternType: Returns the enum constant of this type with the specified name.
values() - Static method in enum net.sf.eBus.feed.pattern.EventPattern.PatternType: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G I K M N O P S T U V
All Classes All Packages