Package net.sf.eBus.client

Class ERequestMonitorFeed.Builder

java.lang.Object

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

net.sf.eBus.client.ERequestMonitorFeed.Builder

Enclosing class:

ERequestMonitorFeed

public static final class ERequestMonitorFeed.Builder
extends EFeed.Builder<F,T,B>

ERequestMonitorFeed.Builder is used to create an ERequestMonitorFeed instance. A Builder instance is acquired from ERequestMonitorFeed.builder(). The following example shows how to create a ERequestMonitorFeed instance using a Builder. The example also shows how ERequestMonitor interface methods may be replaced with lambda expressions.

@Override public void startup() {
    final EMessageKey = new EMessageKey(com.acme.CatalogOrder.class, subject);
    final ERequestMonitorFeed feed (ERequestMonitorFeed.builder()).target(this)
                                                                  .messageKey(key)
                                                                  .requestCallback(this::onRequest)
                                                                  .replyCallback(this::onReply)
                                                                  .cancelCallback(this::onCancel)
                                                                  .build();
    ...
}

private void onRequest(final ERequestMessage request, final String replier) {
    ...
}

private void onReply(final EReplyMessage reply, final String replier) {
    ...
}

private void onCancel(final ERequestMessage request, final String replier) {
    ...
}

See Also:

ERequestMonitorFeed.builder()

Field Summary

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

mEClient, mLocation, mScope, mTarget, mTargetClass

Method Summary

Modifier and Type	Method	Description
protected ERequestMonitorFeed	buildImpl()	Returns a new ERequestMonitorFeed instance based on this Builder's configuration.
ERequestMonitorFeed.Builder	cancelCallback(MessageCallback<ERequestMessage> cb)	Puts inbound request cancellation callback in place.
protected net.sf.eBus.client.ESubject	getSubject()	Returns eBus subject for the configured message key.
ERequestMonitorFeed.Builder	replyCallback(MessageCallback<EReplyMessage> cb)	Puts outbound reply callback in place.
ERequestMonitorFeed.Builder	requestCallback(MessageCallback<ERequestMessage> cb)	Puts inbound request callback in place.
ERequestMonitorFeed.Builder	scope(EFeed.FeedScope scope)	Throws UnsupportedOperationException because request monitor feeds have local-only scope which may not be overridden.
protected ERequestMonitorFeed.Builder	self()	Returns this Builder reference.
protected Validator	validate(Validator problems)	Verifies that message key is for a request subject and that both request and reply callbacks are set.

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

build, isOverridden, target

Methods inherited from class java.lang.Object

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

Method Detail

getSubject

protected net.sf.eBus.client.ESubject getSubject()

Returns eBus subject for the configured message key.

Returns:

eBus feed subject.

validate

protected Validator validate(Validator problems)

Verifies that message key is for a request subject and that both request and reply callbacks are set.

Parameters:

problems - place invalid configuration settings in this problems list.

Returns:

problems to allow for method chaining.

buildImpl

protected ERequestMonitorFeed buildImpl()

Returns a new ERequestMonitorFeed instance based on this Builder's configuration.

Specified by:

buildImpl in class EFeed.Builder<ERequestMonitorFeed,ERequestMonitor,ERequestMonitorFeed.Builder>

Returns:

new request monitor feed.

self

protected ERequestMonitorFeed.Builder self()

Returns this Builder reference.

Specified by:

self in class EFeed.Builder<ERequestMonitorFeed,ERequestMonitor,ERequestMonitorFeed.Builder>

Returns:

this Builder reference.

scope

public ERequestMonitorFeed.Builder scope(EFeed.FeedScope scope)

Throws UnsupportedOperationException because request monitor feeds have local-only scope which may not be overridden.

Overrides:

scope in class EFeed.Builder<ERequestMonitorFeed,ERequestMonitor,ERequestMonitorFeed.Builder>

Parameters:

scope - feed scope.

Returns:

this Builder instance.

Throws:

java.lang.UnsupportedOperationException - default local-only feed scope may not be overridden.

requestCallback

public ERequestMonitorFeed.Builder requestCallback(@Nullable
                                                   MessageCallback<ERequestMessage> cb)

Puts inbound request callback in place. If cb is not null, requests will be passed to cb rather than ERequestMonitor.request(ERequestMessage, String). If cb is null, then request messages are passed to the ERequestMonitor.request(ERequestMessage, String) override.

Parameters:

cb - request callback. May be null.

Returns:

this Builder instance.

replyCallback

public ERequestMonitorFeed.Builder replyCallback(@Nullable
                                                 MessageCallback<EReplyMessage> cb)

Puts outbound reply callback in place. If cb is not null, replies will be passed to cb rather than ERequestMonitor.reply(EReplyMessage, String). If cb is null, then reply messages are passed to the ERequestMonitor.reply(EReplyMessage, String) override.

Parameters:

cb - reply callback. May be null.

Returns:

this Builder instance.

cancelCallback

public ERequestMonitorFeed.Builder cancelCallback(@Nullable
                                                  MessageCallback<ERequestMessage> cb)

Puts inbound request cancellation callback in place. if cb is not null, cancellations will be passed to cb rather than ERequestMonitor.cancel(ERequestMessage, String). If cb is null, then request messages are passed to the ERequestMonitor.cancel(ERequestMessage, String) override.

Parameters:

cb - cancellation callback. May be null.

Returns:

this Builder instance.