Package net.sf.eBus.client

Class EMultiPublishFeed.Builder

java.lang.Object

net.sf.eBus.client.EFeed.Builder<M,T,B>

net.sf.eBus.client.EMultiFeed.Builder<ENotificationMessage,EPublishFeed,EPublisher,EMultiPublishFeed,EMultiPublishFeed.Builder>

net.sf.eBus.client.EMultiPublishFeed.Builder

Enclosing class:

EMultiPublishFeed

public static final class EMultiPublishFeed.Builder
extends EMultiFeed.Builder<ENotificationMessage,EPublishFeed,EPublisher,EMultiPublishFeed,EMultiPublishFeed.Builder>

EMultiPublishFeed.Builder is the mechanism for creating an EMultiPublishFeed instance. A Builder instance is acquired from EMultiPublishFeed.builder(). The following example shows how to create an EMultiPublishFeed instance using a Builder. The code assumes that the target class implements EPublisher interface feedStatus method.

@Overricde public void startup() {
    final EMultiPublishFeed feed = (EMultiPublishFeed.builder()).target(this)
                                                     .messageClass(CatalogUpdate.class)
                                                     .scope(EFeed.FeedScope.LOCAL_AND_REMOTE)
                                                      // Call .statusCallback(lambda expression) to replace feedStatus method
                                                     .build();
    ...
}

Field Summary

Fields inherited from class net.sf.eBus.client.EMultiFeed.Builder

mFeeds, mMsgClass, mTargetMsgClass

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

mEClient, mLocation, mScope, mTarget, mTargetClass

Method Summary

Modifier and Type	Method	Description
protected EMultiPublishFeed	buildImpl()	Returns an eBus feed instance build from the configured properties.
protected EPublishFeed	createFeed(EMessageKey key)	Returns a subordinate feed for the given message key.
protected EMultiPublishFeed.Builder	self()	Returns this reference.
EMultiPublishFeed.Builder	statusCallback(FeedStatusCallback<IEPublishFeed> cb)	Puts the publish status callback in place.
protected Validator	validate(Validator problems)	Checks if message class and query (if this is a query-based multi-feed) are set.

Methods inherited from class net.sf.eBus.client.EMultiFeed.Builder

messageClass, query, subjects

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

build, isOverridden, scope, target

Methods inherited from class java.lang.Object

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

Method Detail

validate

protected Validator validate(Validator problems)

Description copied from class: EMultiFeed.Builder

Checks if message class and query (if this is a query-based multi-feed) are set.

Overrides:

validate in class EMultiFeed.Builder<ENotificationMessage,EPublishFeed,EPublisher,EMultiPublishFeed,EMultiPublishFeed.Builder>

Parameters:

problems - report configuration failures to this validator.

Returns:

problems.

createFeed

protected EPublishFeed createFeed(EMessageKey key)

Description copied from class: EMultiFeed.Builder

Returns a subordinate feed for the given message key.

Note: this method is called after the builder validation.

Specified by:

createFeed in class EMultiFeed.Builder<ENotificationMessage,EPublishFeed,EPublisher,EMultiPublishFeed,EMultiPublishFeed.Builder>

Parameters:

key - subordinate feed's message key.

Returns:

subordinate feed.

buildImpl

protected EMultiPublishFeed buildImpl()

Description copied from class: EFeed.Builder

Returns an eBus feed instance build from the configured properties. Note: the builder configuration was validated prior to calling this method. The message object may now be constructed.

Specified by:

buildImpl in class EFeed.Builder<EMultiPublishFeed,EPublisher,EMultiPublishFeed.Builder>

Returns:

target feed instance.

self

protected EMultiPublishFeed.Builder self()

Returns this reference.

Specified by:

self in class EFeed.Builder<EMultiPublishFeed,EPublisher,EMultiPublishFeed.Builder>

Returns:

this reference.

statusCallback

public EMultiPublishFeed.Builder statusCallback(FeedStatusCallback<IEPublishFeed> cb)

Puts the publish status callback in place. If cb is not null, publish status updates will be passed to cb rather than EPublisher.publishStatus(EFeedState, IEPublishFeed). The reverse is true, if cb is null, then updates are posted to the EPublisher.publishStatus(EFeedState, IEPublishFeed) override.

The following example shows how to use this method:

statusCallback(
    (fs, f) →
    {
        if (fs == EFeedState.DOWN) {
            // Clean up in-progress work.
        }
    }

Parameters:

cb - publish status update callback. May be null.

Returns:

this Builder instance.