net.sf.eBus.messages

Class EReplyMessage.Builder<M extends EReplyMessage,B extends EReplyMessage.Builder<M,?>>

java.lang.Object

net.sf.eBus.messages.EMessageObject.Builder<M,B>

net.sf.eBus.messages.EMessage.Builder<M,B>

net.sf.eBus.messages.EReplyMessage.Builder<M,B>

Type Parameters:

M - builds this target message class.

B - message builder subclass. Needed to return the correct builder type when setting fields. If this were not the case, field chaining would not work.

Direct Known Subclasses:

EReplyMessage.ConcreteBuilder

Enclosing class:

EReplyMessage

public abstract static class EReplyMessage.Builder<M extends EReplyMessage,B extends EReplyMessage.Builder<M,?>>
extends EMessage.Builder<M,B>

Base class for all EReplyMessage builders. Used by eBus when de-serializing an encoded message back into the target message object.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	mReplyReason Generally text explaining a error status.
protected EReplyMessage.ReplyStatus	mReplyStatus Reply is either OK but continuing, OK and final, and error (which is always final).

Fields inherited from class net.sf.eBus.messages.EMessageObject.Builder

mTargetClass

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(Class<? extends EMessageObject> targetClass)

Method Summary

Modifier and Type	Method and Description
B	replyReason(String reason) Sets the reply status reason.
B	replyStatus(EReplyMessage.ReplyStatus status) Sets the replier status for the matching request.
protected void	validate(List<String> problems) Checks if message subject and message type are configured.

Methods inherited from class net.sf.eBus.messages.EMessage.Builder

subject, timestamp, timestamp

Methods inherited from class net.sf.eBus.messages.EMessageObject.Builder

build, buildImpl

Methods inherited from class java.lang.Object

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

Field Detail

mReplyStatus

@Nonnull
protected EReplyMessage.ReplyStatus mReplyStatus

Reply is either OK but continuing, OK and final, and error (which is always final). Must be set.

mReplyReason

@Nullable
protected String mReplyReason

Generally text explaining a error status. May be null or an empty string.

Constructor Detail

Builder

protected Builder(Class<? extends EMessageObject> targetClass)

Method Detail

validate

protected void validate(List<String> problems)

Description copied from class: EMessage.Builder

Checks if message subject and message type are configured. If not, then text explaining this error is appended to problems.

This method should be overridden by subclass message builders and called before doing its own validation. The first line in the subclass validate implementation should be super.validate(problems);.

When overriding this method, be sure to add all discovered validation problems to the list. The validation method should consist of a series of individual if statements and not an if/else if chain. That way all problems are found and not just the first one.

Overrides:

validate in class EMessage.Builder<M extends EReplyMessage,B extends EReplyMessage.Builder<M,?>>

Parameters:

problems - append validation problems to this list.

replyStatus

public final B replyStatus(EReplyMessage.ReplyStatus status)

Sets the replier status for the matching request.

Parameters:

status - replier status.

Returns:

this builder instance.

Throws:

NullPointerException - if status is null.

replyReason

public final B replyReason(String reason)

Sets the reply status reason. Generally used to explain a error status. reason may be null or an empty string.

Parameters:

reason - reply status reason.

Returns:

this builder instance.