Package net.sf.eBus.feed.historic

Class EHistoricSubscribeFeed.Builder

java.lang.Object

net.sf.eBus.feed.historic.EAbstractHistoricFeed.Builder<IEHistoricSubscriber,EHistoricSubscribeFeed,EHistoricSubscribeFeed.Builder>

net.sf.eBus.feed.historic.EHistoricSubscribeFeed.Builder

Enclosing class:

EHistoricSubscribeFeed

public static final class EHistoricSubscribeFeed.Builder
extends EAbstractHistoricFeed.Builder<IEHistoricSubscriber,EHistoricSubscribeFeed,EHistoricSubscribeFeed.Builder>

Builder is used to instantiate EHistoricSubscribeFeed instances. A builder instance is acquired via EHistoricSubscribeFeed.builder(EMessageKey, IEHistoricSubscriber) which requires that a non-null notification message key and historic subscriber be provided. This message key defines the notification message class and subject subscribed to and retrieved by the historic subscriber. The historic subscriber owns the historic subscribe feed. The historic subscribe feed is an eBus hybrid object and runs in the owner's dispatcher.

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

• begin timestamp, location, and clusivity and
• end timestamp, location, and clusivity.

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 EHistoricSubscribeFeed	buildImpl()	Returns new historic subscribe feed instance created from builder settings.
EHistoricSubscribeFeed.Builder	condition(ECondition condition)	Sets subscription condition to the given value.
EHistoricSubscribeFeed.Builder	doneCallback(HistoricFeedDoneCallback cb)	Puts historic subscribe feed completion callback in place.
EHistoricSubscribeFeed.Builder	from(Instant beginTime, EInterval.Clusivity beginClusivity)	Sets historic subscription feed to begin in the past.
EHistoricSubscribeFeed.Builder	fromNow()	Sets historic subscription feed to begin at the current time.
protected String	generateName()	Returns default historic subscribe feed name.
EHistoricSubscribeFeed.Builder	notifyCallback(HistoricNotifyCallback cb)	Puts the notification message callback in place.
protected EHistoricSubscribeFeed.Builder	self()	Returns this Builder self reference.
EHistoricSubscribeFeed.Builder	statusCallback(HistoricFeedStatusCallback cb)	Puts historic subscribe feed status callback in place.
EHistoricSubscribeFeed.Builder	to(Instant endTime, EInterval.Clusivity endClusivity)	Sets historic subscription feed to end either in the past or in the future depending on whether endTime is in the past or future.
EHistoricSubscribeFeed.Builder	toForever()	Sets historic live subscription feed to continue until unsubscribed.
EHistoricSubscribeFeed.Builder	toNow(EInterval.Clusivity endClusivity)	Sets historic subscription feed to end at the current time.
protected net.sf.eBus.util.Validator	validate(net.sf.eBus.util.Validator problems)	Validates historic subscribe 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 EHistoricSubscribeFeed.Builder self()

Returns this Builder self reference.

Specified by:

self in class EAbstractHistoricFeed.Builder<IEHistoricSubscriber,EHistoricSubscribeFeed,EHistoricSubscribeFeed.Builder>

Returns:

this Builder self reference.

validate

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

Validates historic subscribe feed builder settings. Returns problems parameter to allow for validate method chaining.

Overrides:

validate in class EAbstractHistoricFeed.Builder<IEHistoricSubscriber,EHistoricSubscribeFeed,EHistoricSubscribeFeed.Builder>

Parameters:

problems - place validation failures into this list.

Returns:

problems to allow validate method chaining.

generateName

protected String generateName()

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

Specified by:

generateName in class EAbstractHistoricFeed.Builder<IEHistoricSubscriber,EHistoricSubscribeFeed,EHistoricSubscribeFeed.Builder>

Returns:

default historic subscribe feed name.

buildImpl

protected EHistoricSubscribeFeed buildImpl()

Returns new historic subscribe feed instance created from builder settings.

Specified by:

buildImpl in class EAbstractHistoricFeed.Builder<IEHistoricSubscriber,EHistoricSubscribeFeed,EHistoricSubscribeFeed.Builder>

Returns:

new historic subscribe feed instance.

condition

public EHistoricSubscribeFeed.Builder condition(ECondition condition)

Sets subscription condition to the given value. May be null which results in a EFeed.NO_CONDITION condition.

An example using this method is:

builder.condition(m -> ((CatalogUpdate) m).category == Category.APPLIANCES)

Parameters:

condition - subscription condition.

Returns:

this Builder instance.

doneCallback

public EHistoricSubscribeFeed.Builder doneCallback(@Nullable
                                                   HistoricFeedDoneCallback cb)

Puts historic subscribe feed completion callback in place. If cb is not null, feed completion will be passed to cb rather than IEHistoricSubscriber.feedDone(EHistoricSubscribeFeed.HistoricFeedState, EHistoricSubscribeFeed). The reverse is true, if cb is null, then updates are posted to the IEHistoricSubscriber.feedDone override.

An example using this method is:

doneCallback(
    (fs, f) →
    {
        if (fs == HistoricFeedState.DONE_ERROR) {
            // Handle historic feed error.
        }
    }

Parameters:

cb - historic feed completion callback. May be null.

Returns:

this Builder instance.

statusCallback

public EHistoricSubscribeFeed.Builder statusCallback(@Nullable
                                                     HistoricFeedStatusCallback cb)

Puts historic subscribe feed status callback in place. If cb is not null, subscribe status updates will be passed to cb rather than IEHistoricSubscriber.feedStatus(PublishStatusEvent, EHistoricSubscribeFeed). The reverse is true: if cb is null, then updates are posted to the IEHistoricSubscriber.feedStatus override.

An example using this method is:

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

    }}

Parameters:

cb - historic subscriber status update callback. May be null.

Returns:

this Builder instance.

notifyCallback

public EHistoricSubscribeFeed.Builder notifyCallback(@Nullable
                                                     HistoricNotifyCallback cb)

Puts the notification message callback in place. If cb is not null, then notification messages will be passed to cb rather than ESubscriber.notify(ENotificationMessage, IESubscribeFeed). A null cb means that notification messages will be passed to the IEHistoricSubscriber.notify(ENotificationMessage, EHistoricSubscribeFeed) override.

An example showing how to use this method is: notifyCallback(this::locationUpdate)

Parameters:

cb - pass notification messages back to target via this callback.

Returns:

this Builder instance.

from

public EHistoricSubscribeFeed.Builder from(Instant beginTime,
                                           EInterval.Clusivity beginClusivity)

Sets historic subscription feed to begin in the past.

Parameters:

beginTime - historic feed begin time in the past.

beginClusivity - historic feed begin time clusivity.

Returns:

this Builder instance.

Throws:

NullPointerException - if beginTime or beginClusivity is null.

IllegalArgumentException - if beginTime is ≥ current time.

IllegalStateException - if begin time is already set.

fromNow

public EHistoricSubscribeFeed.Builder fromNow()

Sets historic subscription feed to begin at the current time. The begin clusivity is set to EInterval.Clusivity.INCLUSIVE.

Returns:

this Builder instance.

Throws:

IllegalStateException - if begin time is already set.

to

public EHistoricSubscribeFeed.Builder to(Instant endTime,
                                         EInterval.Clusivity endClusivity)

Sets historic subscription feed to end either in the past or in the future depending on whether endTime is in the past or future. If end time is at the current time, then begin time must be in the past and not at the current time.

Parameters:

endTime - historic feed end time in past or future.

endClusivity - historic feed end time clusivity.

Returns:

this Builder instance.

Throws:

NullPointerException - if endTime or endClusivity is null.

IllegalStateException - if end time is already set.

toNow

public EHistoricSubscribeFeed.Builder toNow(EInterval.Clusivity endClusivity)

Sets historic subscription feed to end at the current time. This means that historic begin time must be in the past and not set to the current time.

Parameters:

endClusivity - historic subscribe feed ends at or after current time.

Returns:

this Builder instance.

Throws:

NullPointerException - if endClusivity is null.

IllegalStateException - if end time is already set.

toForever

public EHistoricSubscribeFeed.Builder toForever()

Sets historic live subscription feed to continue until unsubscribed.

Returns:

this Builder instance.