Package net.sf.eBus.feed.historic

Class EHistoricPublishFeed.Builder

java.lang.Object

net.sf.eBus.feed.historic.EAbstractHistoricFeed.Builder<IEHistoricPublisher,EHistoricPublishFeed,EHistoricPublishFeed.Builder>

net.sf.eBus.feed.historic.EHistoricPublishFeed.Builder

Enclosing class:

EHistoricPublishFeed

public static final class EHistoricPublishFeed.Builder
extends EAbstractHistoricFeed.Builder<IEHistoricPublisher,EHistoricPublishFeed,EHistoricPublishFeed.Builder>

Builder is used to instantiate EHistoricPublishFeed instances. A builder instance is acquired via EHistoricPublishFeed.builder(EMessageKey, IEHistoricPublisher) which requires that a non-null notification message key and historic publisher instance be provided. This message key defines the notification message class and subject published and persisted by the historic publish feed. The publisher is the historic publish feed owner. The historic publish feed is an eBus hybrid object and runs in the owner's dispatcher. This historic publisher provides a unique publisher identifier (note that eBus cannot determine identifier is unique),

This builder requires the following properties be defined (beside those properties required by EAbstractHistoricFeed.Builder):

• non-null message store, and
• maximum number of historic notification messages placed into each HistoricReply message.

It is recommended that each builder instance be used to create only one historic publish feed.

Field Summary

Fields inherited from class net.sf.eBus.feed.historic.EAbstractHistoricFeed.Builder

mFeedClass, mKey, mName, mOwner, mRequestKey, mScope, mStatusKey, sFeedIndex

Method Summary

Modifier and Type	Method	Description
protected EHistoricPublishFeed	buildImpl()	Returns new historic publish feed instance created from builder settings.
protected String	generateName()	Returns default historic public feed name.
EHistoricPublishFeed.Builder	messageStore(IEMessageStore store)	Sets the message store used to persist and retrieve notification messages.
EHistoricPublishFeed.Builder	notificationsPerReply(int n)	Sets maximum number of notifications per HistoricReply instance.
protected EHistoricPublishFeed.Builder	self()	Returns this Builder self reference.
EHistoricPublishFeed.Builder	statusCallback(HistoricPublishStatusCallback cb)	Puts historic publish status callback in place.
protected net.sf.eBus.util.Validator	validate(net.sf.eBus.util.Validator problems)	Validates historic publish feed builder settings.

Methods inherited from class net.sf.eBus.feed.historic.EAbstractHistoricFeed.Builder

build, name, scope

Methods inherited from class java.lang.Object

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

Method Detail

self

protected EHistoricPublishFeed.Builder self()

Returns this Builder self reference.

Specified by:

self in class EAbstractHistoricFeed.Builder<IEHistoricPublisher,EHistoricPublishFeed,EHistoricPublishFeed.Builder>

Returns:

this Builder self reference.

validate

protected net.sf.eBus.util.Validator validate(net.sf.eBus.util.Validator problems)

Validates historic publish feed builder settings. Extends EAbstractHistoricFeed validation with a check that message store is set. Returns problems parameter to allow for validate method chaining.

Overrides:

validate in class EAbstractHistoricFeed.Builder<IEHistoricPublisher,EHistoricPublishFeed,EHistoricPublishFeed.Builder>

Parameters:

problems -

Returns:

generateName

protected String generateName()

Returns default historic public feed name. Used when feed name is not explicitly set.

Specified by:

generateName in class EAbstractHistoricFeed.Builder<IEHistoricPublisher,EHistoricPublishFeed,EHistoricPublishFeed.Builder>

Returns:

default historic public feed name.

buildImpl

protected EHistoricPublishFeed buildImpl()

Returns new historic publish feed instance created from builder settings.

Specified by:

buildImpl in class EAbstractHistoricFeed.Builder<IEHistoricPublisher,EHistoricPublishFeed,EHistoricPublishFeed.Builder>

Returns:

new historic publish feed instance.

statusCallback

public EHistoricPublishFeed.Builder statusCallback(@Nullable
                                                   HistoricPublishStatusCallback cb)

Puts historic publish status callback in place. If cb is not null, publish status updates will be passed to cb rather than IEHistoricPublisher.publishStatus(EFeedState, EHistoricPublishFeed). The reverse is true: if cb is null, then updates are post to IEHistoricPublisher#publishStatus override.

An example using this method is:

statusCallback(
    (fs, f) → {
        if (fs == EFeedState.DOWN) {
            // Respond to down live notification feed.
        }
    })

Parameters:

cb - historic publisher publish status update callback.

Returns:

this Builder instance.

messageStore

public EHistoricPublishFeed.Builder messageStore(IEMessageStore store)

Sets the message store used to persist and retrieve notification messages.

Parameters:

store - notification message store.

Returns:

this Builder instance.

Throws:

NullPointerException - if store is null.

IllegalArgumentException - if store is not open.

notificationsPerReply

public EHistoricPublishFeed.Builder notificationsPerReply(int n)

Sets maximum number of notifications per HistoricReply instance. Values must be > zero.

Parameters:

n - maximum number of notifications per historic reply.

Returns:

this Builder instance.