Package net.sf.eBus.feed.historic
Interface HistoricFeedDoneCallback
-
- Functional Interface:
- This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface HistoricFeedDoneCallback
An eBus client implementingIEHistoricSubscriber
may choose to implement this functional interface as aprivate
method instead of implementing thepublic
IEHistoricSubscriber.feedDone(EHistoricSubscribeFeed.HistoricFeedState, EHistoricSubscribeFeed)
method. This privateHistoricFeedDoneCallback
method is then passed toEHistoricSubscribeFeed.Builder.doneCallback(HistoricFeedDoneCallback)
.Note: this callback may only be set when building an
EHistoricSubscribeFeed
instance. Once built, the feed done callback target may not be changed.Note: failure to implement
IEHistoricSubscriber.feedDone
or to pass aHistoricFeedDoneCallback
method toBuilder.doneCallback
results in aBuilder.build()
failure.- Author:
- Charles W. Rapp
- See Also:
EHistoricSubscribeFeed
,HistoricNotifyCallback
,HistoricFeedStatusCallback
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
call(EHistoricSubscribeFeed.HistoricFeedState feedState, EHistoricSubscribeFeed feed)
eBus calls this method when an historic subscribe feed has reached completion.
-
-
-
Method Detail
-
call
void call(EHistoricSubscribeFeed.HistoricFeedState feedState, EHistoricSubscribeFeed feed)
eBus calls this method when an historic subscribe feed has reached completion. The feed state will be eitherEHistoricSubscribeFeed.HistoricFeedState.DONE_SUCCESS
orEHistoricSubscribeFeed.HistoricFeedState.DONE_ERROR
. If the historic feed completion is in error, thenEHistoricSubscribeFeed.errorCause()
may be called to retrieve the exception which caused the error.- Parameters:
feedState
- historic subscribe feed final state.feed
- historic subscribe feed.
-
-