Module is.codion.common.model
Package is.codion.common.model
Class FilteredModel.AbstractRefresher<T>
java.lang.Object
is.codion.common.model.FilteredModel.AbstractRefresher<T>
- Type Parameters:
T
- the model item type
- All Implemented Interfaces:
FilteredModel.Refresher<T>
- Direct Known Subclasses:
AbstractFilteredModelRefresher
- Enclosing interface:
- FilteredModel<T>
public abstract static class FilteredModel.AbstractRefresher<T>
extends Object
implements FilteredModel.Refresher<T>
An abstract base implementation of
FilteredModel.Refresher
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal State
async()
Sometimes we'd like to be able to refresh one or more models and perform some action on the refreshed data, after the refresh has finished, such as selecting a particular item or such.final Value<Supplier<Collection<T>>>
protected final void
notifyFailure
(Throwable throwable) Triggers the refresh failed eventprotected final void
Triggers the successful refresh eventfinal StateObserver
observer()
protected abstract void
processResult
(Collection<T> items) Processes the refresh result, by replacing the current model items by the result items.final void
refresh()
Refreshes the items in the associated filtered model.protected abstract void
refreshAsync
(Consumer<Collection<T>> afterRefresh) Performes an async refreshfinal EventObserver<?>
protected abstract void
refreshSync
(Consumer<Collection<T>> afterRefresh) Performs a sync refreshfinal void
refreshThen
(Consumer<Collection<T>> afterRefresh) Refreshes the data in this model.protected final void
setRefreshing
(boolean refreshing) Sets the refreshing (active) state of this refresherprotected abstract boolean
-
Constructor Details
-
AbstractRefresher
- Parameters:
itemSupplier
- the item supplier
-
-
Method Details
-
async
Description copied from interface:FilteredModel.Refresher
Sometimes we'd like to be able to refresh one or more models and perform some action on the refreshed data, after the refresh has finished, such as selecting a particular item or such. This is quite difficult to achieve with asynchronous refresh enabled, so here's a way to temporarily disable asynchronous refresh, for a more predictable behaviour.- Specified by:
async
in interfaceFilteredModel.Refresher<T>
- Returns:
- the State controlling whether asynchronous refreshing is enabled
- See Also:
-
itemSupplier
- Specified by:
itemSupplier
in interfaceFilteredModel.Refresher<T>
- Returns:
- a Value controlling the item supplier for this refresher instance
-
refresh
public final void refresh()Description copied from interface:FilteredModel.Refresher
Refreshes the items in the associated filtered model. Note that this method only throws exceptions when run synchronously.- Specified by:
refresh
in interfaceFilteredModel.Refresher<T>
- See Also:
-
refreshThen
Description copied from interface:FilteredModel.Refresher
Refreshes the data in this model. Note that this method only throws exceptions when run synchronously. UseFilteredModel.Refresher.refreshFailedEvent()
to listen for exceptions that happen during asynchronous refresh.- Specified by:
refreshThen
in interfaceFilteredModel.Refresher<T>
- Parameters:
afterRefresh
- called after a successful refresh, may be null- See Also:
-
observer
- Specified by:
observer
in interfaceFilteredModel.Refresher<T>
- Returns:
- an observer active while a refresh is in progress
-
refreshEvent
- Specified by:
refreshEvent
in interfaceFilteredModel.Refresher<T>
- Returns:
- an observer notified each time this model has been successfully refreshed
- See Also:
-
refreshFailedEvent
- Specified by:
refreshFailedEvent
in interfaceFilteredModel.Refresher<T>
- Returns:
- an observer notified each time an asynchronous refresh has failed
- See Also:
-
setRefreshing
protected final void setRefreshing(boolean refreshing) Sets the refreshing (active) state of this refresher- Parameters:
refreshing
- true if refresh is starting, false if ended
-
notifySuccess
protected final void notifySuccess()Triggers the successful refresh event- See Also:
-
notifyFailure
Triggers the refresh failed event- Parameters:
throwable
- the refresh exception- See Also:
-
supportsAsyncRefresh
protected abstract boolean supportsAsyncRefresh()- Returns:
- true if we're running on a thread which supports async refresh, such as a UI or application thread
-
refreshAsync
Performes an async refresh- Parameters:
afterRefresh
- if specified will be called after a successful refresh
-
refreshSync
Performs a sync refresh- Parameters:
afterRefresh
- if specified will be called after a successful refresh
-
processResult
Processes the refresh result, by replacing the current model items by the result items.- Parameters:
items
- the items resulting from the refresh operation
-