net.sf.eBus.client.sysmessages

Class AbstractKeyMessage.Builder<M extends AbstractKeyMessage,B extends AbstractKeyMessage.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.ESystemMessage.Builder<M,B>

net.sf.eBus.client.sysmessages.AbstractKeyMessage.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:

AdMessage.Builder, SubscribeMessage.Builder

Enclosing class:

AbstractKeyMessage

public abstract static class AbstractKeyMessage.Builder<M extends AbstractKeyMessage,B extends AbstractKeyMessage.Builder<M,?>>
extends ESystemMessage.Builder<M,B>

Base class for all AbstractKeyMessage builders. Provides message class and subject validation.

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)

Method Summary

Modifier and Type	Method and Description
B	messageClass(String mc) Sets the message class name to the given value.
B	messageKey(EMessageKey key) Sets both the message class name and subject based on the given message key.
B	messageSubject(String subject) Sets the message subject to the given value.
protected void	validate(List<String> problems) Checks if the message class and subject 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

Constructor Detail

Builder

protected Builder(Class<? extends EMessageObject> targetClass)

Method Detail

validate

protected void validate(List<String> problems)

Checks if the message class and subject are configured. If not, then appends those problems to the list.

Overrides:

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

Parameters:

problems - list of message configuration problems.

messageClass

public B messageClass(String mc)

Sets the message class name to the given value.

Parameters:

mc - message class name.

Returns:

this message builder.

Throws:

IllegalArgumentException - if mc is null or empty.

messageSubject

public B messageSubject(String subject)

Sets the message subject to the given value.

Parameters:

subject - message subject.

Returns:

this message builder.

Throws:

IllegalArgumentException - if subject is null or empty.

messageKey

public B messageKey(EMessageKey key)

Sets both the message class name and subject based on the given message key.

Parameters:

key - message key containing message class and subject.

Returns:

this message builder.

Throws:

NullPointerException - if key is null.