net.sf.eBus.feed.pattern

Class EventPattern.FeedInfo

java.lang.Object

net.sf.eBus.feed.pattern.EventPattern.FeedInfo

Enclosing class:

EventPattern

public static final class EventPattern.FeedInfo
extends Object

This class provides the information needed by EPatternFeed to open and subscribe to a notification message feed. FeedInfo instances may be created directly by the user or indirectly via EventPattern.Builder.beginParameter(String)/ EventPattern.Builder.endParameter() calls.

Constructor Summary

Constructors

Constructor and Description
FeedInfo(EMessageKey key, EFeed.FeedScope scope) Creates subscription feed information for the given notification message key and feed scope.
FeedInfo(EMessageKey key, EFeed.FeedScope scope, ECondition condition) Creates subscription feed information for the given notification message key, feed scope, and optional feed condition.

Method Summary

Modifier and Type	Method and Description
ECondition	condition() Returns the optional subscription feed condition.
EMessageKey	messageKey() Returns the subscription notification message key.
EFeed.FeedScope	scope() Returns the subscription feed scope.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FeedInfo

public FeedInfo(EMessageKey key,
                EFeed.FeedScope scope)

Creates subscription feed information for the given notification message key and feed scope. The feed condition is set to EFeed.NOTIFY_METHOD.

Parameters:

key - required notification message key.

scope - required feed scope.

FeedInfo

public FeedInfo(EMessageKey key,
                EFeed.FeedScope scope,
                ECondition condition)

Creates subscription feed information for the given notification message key, feed scope, and optional feed condition. If condition is null, then the condition is set to EFeed.NO_CONDITION.

Parameters:

key - required notification message key.

scope - required feed scope.

condition - optional subscription condition. May be null.

Throws:

NullPointerException - if either key or scope is null.

IllegalArgumentException - if key is not a notification message.

Method Detail

messageKey

public EMessageKey messageKey()

Returns the subscription notification message key.

Returns:

message key.

scope

public EFeed.FeedScope scope()

Returns the subscription feed scope.

Returns:

feed scope.

condition

public ECondition condition()

Returns the optional subscription feed condition. May return null.

Returns:

feed condition.