Package net.sf.eBus.feed.pattern

Class EPatternFeed.PatternBuilder<F extends EPatternFeed,B extends EPatternFeed.PatternBuilder<F,?>>

java.lang.Object

net.sf.eBus.client.EFeed.Builder<F,ESubscriber,B>

net.sf.eBus.feed.pattern.EPatternFeed.PatternBuilder<F,B>

Type Parameters:

F - leaf pattern feed class.

B - leaf pattern feed builder class.

Enclosing class:

EPatternFeed

public abstract static class EPatternFeed.PatternBuilder<F extends EPatternFeed,B extends EPatternFeed.PatternBuilder<F,?>>
extends EFeed.Builder<F,ESubscriber,B>

Based class for pattern feed builders. Provides methods for setting the event pattern, status and notify callbacks. If status and/or notify callback methods are not provided, then interface methods ESubscriber.feedStatus(EFeedState, IESubscribeFeed) and ESubscriber.notify(ENotificationMessage, IESubscribeFeed) are used.

Field Summary

Fields

Modifier and Type	Field	Description
protected NotifyCallback	mNotifyCallback	Notification message callback.
protected EventPattern	mPattern	Event pattern.
protected FeedStatusCallback<IESubscribeFeed>	mStatusCallback	Feed status callback.

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

mEClient, mLocation, mScope, mTarget, mTargetClass

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PatternBuilder(Class<F> tc)

Method Summary

Modifier and Type	Method	Description
B	eventPattern(EventPattern pattern)	Sets event pattern used to match against notification stream.
B	notifyCallback(NotifyCallback cb)	Puts the notification message callback in place.
B	scope(EFeed.FeedScope scope)	Throws OperationNotSupportedException because pattern feed is local only and may be be changed.
B	statusCallback(FeedStatusCallback<IESubscribeFeed> cb)	Puts the subscribe feed status callback in place.
net.sf.eBus.util.Validator	validate(net.sf.eBus.util.Validator problems)	Validates builder settings.

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

build, buildImpl, isOverridden, self, target

Methods inherited from class java.lang.Object

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

Field Detail

mPattern

protected EventPattern mPattern

Event pattern.

mStatusCallback

protected FeedStatusCallback<IESubscribeFeed> mStatusCallback

Feed status callback. If not explicitly set by client, then defaults to ESubscriber.feedStatus(EFeedState, IESubscribeFeed).

mNotifyCallback

protected NotifyCallback mNotifyCallback

Notification message callback. If not explicity set by client, then defaults to ESubscriber.notify(ENotificationMessage, IESubscribeFeed).

Constructor Detail

PatternBuilder

protected PatternBuilder(Class<F> tc)

Method Detail

eventPattern

public final B eventPattern(EventPattern pattern)

Sets event pattern used to match against notification stream.

Parameters:

pattern - event pattern.

Returns:

this builder instance.

Throws:

NullPointerException - if pattern is null.

statusCallback

public final B statusCallback(FeedStatusCallback<IESubscribeFeed> cb)

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

An example using this method is:

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

Parameters:

cb - subscribe status update callback. May be null.

Returns:

this Builder instance.

notifyCallback

public final B notifyCallback(NotifyCallback 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 ESubscriber.notify(ENotificationMessage, IESubscribeFeed) 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.

scope

public final B scope(EFeed.FeedScope scope)

Throws OperationNotSupportedException because pattern feed is local only and may be be changed.

Overrides:

scope in class EFeed.Builder<F extends EPatternFeed,ESubscriber,B extends EPatternFeed.PatternBuilder<F,?>>

Parameters:

scope - ignored.

Returns:

does not return.

Throws:

UnsupportedOperationException - because pattern feed scope may not be changed.

validate

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

Validates builder settings. Missing or invalid settings are placed into problems which results in a ValidationException thrown when pattern feed build is attempted.

Overrides:

validate in class EFeed.Builder<F extends EPatternFeed,ESubscriber,B extends EPatternFeed.PatternBuilder<F,?>>

Parameters:

problems - report invalid settings in this validator.

Returns:

problems.