HistoricRequest.Builder (eBus Feed 7.4.0 API)

java.lang.Object
- net.sf.eBus.messages.EMessageObject.Builder<M>
- - net.sf.eBus.messages.EMessage.Builder<M,B>
  - - net.sf.eBus.messages.ERequestMessage.Builder<HistoricRequest,HistoricRequest.Builder>
    - - net.sf.eBus.feed.historic.HistoricRequest.Builder

Enclosing class:

HistoricRequest
```
public static final class HistoricRequest.Builder
extends ERequestMessage.Builder<HistoricRequest,HistoricRequest.Builder>
```
Builder class for HistoricRequest message instances. A Builder instance is acquired using the HistoricRequest.builder() method. Each builder instance should be used to build only one HistoricRequest instance.
Builder requires HistoricRequest.interval be set to a non-null value.

See Also:

HistoricRequest

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 HistoricRequest`	`buildImpl()`	Returns a new `HistoricRequest` instance based on this builder's configuration.
`HistoricRequest.Builder`	`interval(EInterval interval)`	Sets the historic notification interval.
`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.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 HistoricRequest requires that the time interval is set. Calls super.validate to check super class fields.
    
    Overrides:
    
    validate in class EMessage.Builder<HistoricRequest,HistoricRequest.Builder>
    
    Parameters:
    
    problems - place invalid fields into this list.
    
    Returns:
    
    problems is returned to all method chaining.
  - buildImpl
```
protected HistoricRequest buildImpl()
```
    Returns a new HistoricRequest instance based on this builder's configuration.
    
    Specified by:
    
    buildImpl in class EMessageObject.Builder<HistoricRequest>
    
    Returns:
    
    new HistoricRequest instance.
  - interval
```
public HistoricRequest.Builder interval(EInterval interval)
```
    Sets the historic notification interval. This interval must be entirely in the past.
    
    Parameters:
    
    interval - retrieve notifications over this historic date/time interval.
    
    Returns:
    
    this Builder instance.
    
    Throws:
    
    NullPointerException - if interval is null.
    
    IllegalArgumentException - if interval.endTime > the current wall clock time.