SubscribeMessage.Builder (eBus 7.6.0 API)

java.lang.Object
- net.sf.eBus.messages.EMessageObject.Builder<M>
- - net.sf.eBus.messages.EMessage.Builder<M,B>
  - - net.sf.eBus.messages.ESystemMessage.Builder<M,B>
    - - net.sf.eBus.client.sysmessages.AbstractKeyMessage.Builder<SubscribeMessage,SubscribeMessage.Builder>
      - net.sf.eBus.client.sysmessages.SubscribeMessage.Builder

Enclosing class:: SubscribeMessage

public static final class SubscribeMessage.Builder
extends AbstractKeyMessage.Builder<SubscribeMessage,SubscribeMessage.Builder>

Class used to create SubscribeMessage 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected SubscribeMessage`	`buildImpl()`	Returns the newly instantiated `SubscribeMessage` based on this builder configuration.
`SubscribeMessage.Builder`	`feedState(EFeedState fs)`	Sets the subscription feed state to the given value.
`protected Validator`	`validate(Validator problems)`	Checks if the feed state is configured.

Methods inherited from class net.sf.eBus.client.sysmessages.AbstractKeyMessage.Builder
messageClass, messageKey, messageSubject

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 SubscribeMessage buildImpl()
```
    Returns the newly instantiated SubscribeMessage based on this builder configuration.
    
    Specified by:
    
    buildImpl in class EMessageObject.Builder<SubscribeMessage>
    
    Returns:
    
    target message instance.
  - validate
```
protected Validator validate(Validator problems)
```
    Checks if the feed state is configured. If not, then appends this problem to the validator.
    
    Overrides:
    
    validate in class AbstractKeyMessage.Builder<SubscribeMessage,SubscribeMessage.Builder>
    
    Parameters:
    
    problems - used to check field validity and collect discovered invalid fields.
    
    Returns:
    
    problems to allow for method chaining.
    
    See Also:
    
    Validator
  - feedState
```
public SubscribeMessage.Builder feedState(EFeedState fs)
```
    Sets the subscription feed state to the given value.
    
    Parameters:
    
    fs - subscription feed state.
    
    Returns:
    
    this builder.
    
    Throws:
    
    java.lang.NullPointerException - if fs is null.