net.sf.eBus.messages

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

java.lang.Object

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

net.sf.eBus.messages.EMessage.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:

ENotificationMessage.Builder, EReplyMessage.Builder, ERequestMessage.Builder, ESystemMessage.Builder

Enclosing class:

EMessage

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

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

Field Summary

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

mTargetClass

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(Class<? extends EMessageObject> targetClass, EMessage.MessageType type) Creates an eBus message builder instance.
protected	Builder(Class<? extends EMessageObject> targetClass, String subject, EMessage.MessageType type) Creates an eBus message builder instance for the given message subject.
protected	Builder(Class<? extends EMessageObject> targetClass, String subject, long timestamp, EMessage.MessageType type) Creates an eBus message builder instance for the given message subject and timestamp.

Method Summary

Modifier and Type	Method and Description
B	subject(String subject) Sets the message subject to the given value.
B	timestamp(Instant ts) Sets the message timestamp to the given value.
B	timestamp(long ts) Sets the message timestamp to the given value.
protected void	validate(List<String> problems) Checks if message subject and message type are configured.

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

Constructor Detail

Builder

protected Builder(Class<? extends EMessageObject> targetClass,
                  EMessage.MessageType type)

Creates an eBus message builder instance.

Parameters:

targetClass - builds this message class.

type - notification, request, or reply message.

Builder

protected Builder(Class<? extends EMessageObject> targetClass,
                  String subject,
                  EMessage.MessageType type)

Creates an eBus message builder instance for the given message subject.

Parameters:

targetClass - builds this message class.

subject - message subject.

type - notification, request, or reply message.

Builder

protected Builder(Class<? extends EMessageObject> targetClass,
                  String subject,
                  long timestamp,
                  EMessage.MessageType type)

Creates an eBus message builder instance for the given message subject and timestamp.

Parameters:

timestamp - message create timestamp.

subject - message subject.

targetClass - builds this message class.

type - notification, request, or reply message.

Method Detail

validate

protected void validate(List<String> problems)

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 EMessageObject.Builder<M extends EMessage,B extends EMessage.Builder<M,?>>

Parameters:

problems - append validation problems to this list.

subject

public final B subject(String subject)

Sets the message subject to the given value. Returns this builder so that field configuration may be chained.

Parameters:

subject - message subject.

Returns:

this builder instance.

Throws:

IllegalArgumentException - if subject is either null or empty.

timestamp

public final B timestamp(long ts)

Sets the message timestamp to the given value. Returns this builder so that field configuration may be chained.

Parameters:

ts - message timestamp.

Returns:

this builder instance.

timestamp

public final B timestamp(Instant ts)

Sets the message timestamp to the given value. Returns this builder so that field configuration may be chained.

Parameters:

ts - message timestamp.

Returns:

this builder instance.