net.sf.eBus.client.sysmessages

Class KeyMessage.Builder

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<KeyMessage,KeyMessage.Builder>

net.sf.eBus.client.sysmessages.KeyMessage.Builder

Enclosing class:

KeyMessage

public static final class KeyMessage.Builder
extends ESystemMessage.Builder<KeyMessage,KeyMessage.Builder>

Class used to create KeyMessage instances. Used by eBus to de-serialize an encoded message.

Field Summary

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

mTargetClass

Method Summary

Modifier and Type	Method and Description
protected KeyMessage	buildImpl() Returns the newly instantiated KeyMessage based on this builder configuration.
KeyMessage.Builder	key(EMessageKey key) Sets the message class name and subject based on the given message key.
KeyMessage.Builder	keyClass(String mc) Sets the key message class name to the given value.
KeyMessage.Builder	keyId(int id) Sets the message key identifier to the given value.
KeyMessage.Builder	keySubject(String subject) Sets the key message subject to the given value.
protected void	validate(List<String> problems) Checks if the key 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

Methods inherited from class java.lang.Object

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

Method Detail

buildImpl

protected KeyMessage buildImpl()

Returns the newly instantiated KeyMessage based on this builder configuration.

Specified by:

buildImpl in class EMessageObject.Builder<KeyMessage,KeyMessage.Builder>

Returns:

target message instance.

validate

protected void validate(List<String> problems)

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

Overrides:

validate in class EMessage.Builder<KeyMessage,KeyMessage.Builder>

Parameters:

problems - list of message configuration problems.

keyId

public KeyMessage.Builder keyId(int id)

Sets the message key identifier to the given value.

Parameters:

id - message key identifier.

Returns:

this key message builder.

keyClass

public KeyMessage.Builder keyClass(String mc)

Sets the key message class name to the given value.

Parameters:

mc - key message class name.

Returns:

this key message builder.

Throws:

IllegalArgumentException - if mc is null or empty.

keySubject

public KeyMessage.Builder keySubject(String subject)

Sets the key message subject to the given value.

Parameters:

subject - message subject.

Returns:

this key message builder.

Throws:

IllegalArgumentException - if subject is null or empty.

key

public KeyMessage.Builder key(EMessageKey key)

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

Parameters:

key - take class name and subject from this message key.

Returns:

this key message builder.

Throws:

NullPointerException - if key is null.