net.sf.eBus.client

Class ENotifyFeed

java.lang.Object

net.sf.eBus.client.EFeed

net.sf.eBus.client.ENotifyFeed

All Implemented Interfaces:

IEFeed

Direct Known Subclasses:

EPublishFeed, ESubscribeFeed

public abstract class ENotifyFeed
extends EFeed

Abstract base class for EPublishFeed and ESubscribeFeed classes. Tracks the current feed state.

Author:

Charles W. Rapp

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ESingleFeed.FeedType Enumerates the supported feed types.

Nested classes/interfaces inherited from class net.sf.eBus.client.EFeed

EFeed.AbstractClientTask, EFeed.FeedScope, EFeed.NotifyTask, EFeed.StatusTask<T extends IEFeed>

Field Summary

Fields

Modifier and Type	Field and Description
protected int	mActivationCount Tracks the number of contra-feeds matched to this feed.
protected static List<EFeed>	mAdvertisers Track the advertised feeds in order to generate advertise messages.
protected ESingleFeed.FeedType	mFeedType Specifies whether this is a publish, subscribe, request, or reply feed.
protected net.sf.eBus.client.ESubject	mSubject The feed interfaces with this eBus subject.

Fields inherited from class net.sf.eBus.client.EFeed

mEClient, mFeedId, mFeedState, mInPlace, mIsActive, mScope, NO_CONDITION, NOTIFY_METHOD

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ENotifyFeed(EClient client, EFeed.FeedScope scope, ESingleFeed.FeedType feedType, net.sf.eBus.client.ESubject subject) Creates a new notification feed instance.

Method Summary

Modifier and Type	Method and Description
int	activationCount() Returns the feed activation count.
EMessageKey	key() Returns the feed message key.
String	messageSubject() Returns the feed message key subect.
String	toString() Returns a containing the feed message key and data member values.

Methods inherited from class net.sf.eBus.client.EFeed

addAllKeys, addKey, checkScopes, clientId, close, defaultDispatcher, eClient, equals, feedId, feedState, findKeys, findKeys, findKeys, hashCode, inactivate, inPlace, isActive, isFeedUp, isOverridden, loadKeys, location, register, register, register, scope, shutdown, shutdown, shutdownAll, startup, startup, startupAll, storeKeys, storeKeys, storeKeys

Methods inherited from class java.lang.Object

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

Field Detail

mAdvertisers

protected static final List<EFeed> mAdvertisers

Track the advertised feeds in order to generate advertise messages.

mFeedType

protected final ESingleFeed.FeedType mFeedType

Specifies whether this is a publish, subscribe, request, or reply feed.

mSubject

protected final net.sf.eBus.client.ESubject mSubject

The feed interfaces with this eBus subject. The subject type is based on feed type.

mActivationCount

protected int mActivationCount

Tracks the number of contra-feeds matched to this feed. If this is a publisher feed, then counts subscriber feeds. If a subscriber feed, then counts publisher feeds.

Constructor Detail

ENotifyFeed

protected ENotifyFeed(EClient client,
                      EFeed.FeedScope scope,
                      ESingleFeed.FeedType feedType,
                      net.sf.eBus.client.ESubject subject)

Creates a new notification feed instance.

Parameters:

client - route eBus messages to this client.

scope - whether this feed supports local and/or remote eBus client feeds.

feedType - the actual feed type.

subject - interact with this subject.

Method Detail

toString

public String toString()

Returns a containing the feed message key and data member values.

Overrides:

toString in class EFeed

Returns:

textual representation of this feed.

key

public final EMessageKey key()

Returns the feed message key. The message key type matches the feed type. If this is a EPublishFeed, then a notification message key is returned.

Returns:

message key.

messageSubject

public final String messageSubject()

Returns the feed message key subect.

Returns:

message key subject.

activationCount

public final int activationCount()

Returns the feed activation count.

Returns:

value ≥ zero.