Package net.sf.eBus.feed.historic

Class HistoricReply.Builder

java.lang.Object

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

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

net.sf.eBus.messages.EReplyMessage.Builder<HistoricReply,HistoricReply.Builder>

net.sf.eBus.feed.historic.HistoricReply.Builder

Enclosing class:

HistoricReply

public static final class HistoricReply.Builder
extends EReplyMessage.Builder<HistoricReply,HistoricReply.Builder>

Builder class for HistoricReply message instances. A Builder is acquired using the HistoricReply.builder() method. Each builder instance should be used to build only one HistoricReply instance.

Builder require notification array to be non-null and non empty.

See Also:

HistoricReply

Field Summary

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

mReplyReason, mReplyStatus

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

mTargetClass

Method Summary

Modifier and Type	Method	Description
protected HistoricReply	buildImpl()	Returns a new historic notification reply based on this Builder's settings.
HistoricReply.Builder	notifications(Collection<ENotificationMessage> messages)	Sets historic messages returned in this reply.
HistoricReply.Builder	notifications(ENotificationMessage[] messages)	Sets historic messages returned in this reply.
protected net.sf.eBus.util.Validator	validate(net.sf.eBus.util.Validator problems)	Checks if this builder is correctly configured before building target message instance.

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

replyReason, replyStatus

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

copy, 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

validate

protected net.sf.eBus.util.Validator validate(net.sf.eBus.util.Validator problems)

Checks if this builder is correctly configured before building target message instance. A valid HistoricReply requires that notifications are set to a non-null, non-empty array.

Overrides:

validate in class EReplyMessage.Builder<HistoricReply,HistoricReply.Builder>

Parameters:

problems - place invalid configuration settings into this problems list.

Returns:

problems is returned to all method chaining.

buildImpl

protected HistoricReply buildImpl()

Returns a new historic notification reply based on this Builder's settings.

Specified by:

buildImpl in class EMessageObject.Builder<HistoricReply>

Returns:

new historic notification reply.

notifications

public HistoricReply.Builder notifications(ENotificationMessage[] messages)

Sets historic messages returned in this reply. Messages array may not be null or empty.

Parameters:

messages - reply contains these messages.

Returns:

this Builder instance.

Throws:

NullPointerException - if messages is null.

IllegalArgumentException - if messages array is empty.

IllegalStateException - if messages array was previously set.

notifications

public HistoricReply.Builder notifications(Collection<ENotificationMessage> messages)

Sets historic messages returned in this reply. Messages collection may not be null or empty.

Parameters:

messages - reply contains these messages.

Returns:

this Builder instance.

Throws:

NullPointerException - if messages is null.

IllegalArgumentException - if messages is empty.

IllegalStateException - if messages array was previously set.