Package net.sf.eBus.feed.historic

Class PublishStatusEvent.Builder

java.lang.Object

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

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

net.sf.eBus.messages.ENotificationMessage.Builder<PublishStatusEvent,PublishStatusEvent.Builder>

net.sf.eBus.feed.historic.PublishStatusEvent.Builder

Enclosing class:

PublishStatusEvent

public static final class PublishStatusEvent.Builder
extends ENotificationMessage.Builder<PublishStatusEvent,PublishStatusEvent.Builder>

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

Builder requires: publisher identifier be set to an integer values > zero, message key is set to a non-null notification, and feed state is set to a non-null value.

See Also:

PublishStatusEvent

Field Summary

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

mPosition, mPubId

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

mTargetClass

Method Summary

Modifier and Type	Method	Description
protected PublishStatusEvent	buildImpl()	Returns a new PublishStatusEvent instance based on this builder's configuration.
PublishStatusEvent.Builder	feedState(EFeedState feedState)	Sets publisher feed state.
PublishStatusEvent.Builder	key(EMessageKey key)	Sets message key to which feed status applies.
protected net.sf.eBus.util.Validator	validate(net.sf.eBus.util.Validator problems)	Checks if this builder is correctly configured before attempting to build the target message instance.

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

position, publisherId

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

buildImpl

protected PublishStatusEvent buildImpl()

Returns a new PublishStatusEvent instance based on this builder's configuration.

Specified by:

buildImpl in class EMessageObject.Builder<PublishStatusEvent>

Returns:

new PublishStatusEvent instance.

validate

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

Checks if this builder is correctly configured before attempting to build the target message instance. A valid PublishStatusEvent requires that publisher identifier, message key and feed state are set. Calls super.validate to check super class fields.

Overrides:

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

Parameters:

problems - place invalid fields into this list.

Returns:

problems is returned to all method chaining.

key

public PublishStatusEvent.Builder key(EMessageKey key)

Sets message key to which feed status applies.

Parameters:

key - message key.

Returns:

this Builder instance.

Throws:

NullPointerException - if key is null.

IllegalArgumentException - if key is not for a notification message.

feedState

public PublishStatusEvent.Builder feedState(EFeedState feedState)

Sets publisher feed state.

Parameters:

feedState - publisher feed state.

Returns:

this Builder instance.