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>

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

Modifier	Constructor	Description
protected	AbstractRefresher(Supplier<Collection<T>> itemSupplier)

Method Summary

Modifier and Type	Method	Description
final is.codion.common.state.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 is.codion.common.value.Value<Supplier<Collection<T>>>	itemSupplier()
protected final void	notifyFailure(Exception exception)	Triggers the refresh failed event
protected final void	notifySuccess()	Triggers the successful refresh event
final is.codion.common.state.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 refresh
final is.codion.common.event.EventObserver<?>	refreshEvent()
is.codion.common.event.EventObserver<Exception>	refreshFailedEvent()
protected abstract void	refreshSync(Consumer<Collection<T>> afterRefresh)	Performs a sync refresh
final 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 refresher
protected abstract boolean	supportsAsyncRefresh()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AbstractRefresher

protected AbstractRefresher(Supplier<Collection<T>> itemSupplier)

Parameters:

itemSupplier - the item supplier

Method Details

async

public final is.codion.common.state.State 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 interface FilteredModel.Refresher<T>

Returns:

the State controlling whether asynchronous refreshing is enabled

See Also:

• FilteredModel.ASYNC_REFRESH

itemSupplier

public final is.codion.common.value.Value<Supplier<Collection<T>>> itemSupplier()

Specified by:

itemSupplier in interface FilteredModel.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 interface FilteredModel.Refresher<T>

See Also:

• FilteredModel.Refresher.refreshFailedEvent()
• FilteredModel.Refresher.async()

refreshThen

public final void refreshThen(Consumer<Collection<T>> afterRefresh)

Description copied from interface: FilteredModel.Refresher

Refreshes the data in this model. Note that this method only throws exceptions when run synchronously. Use FilteredModel.Refresher.refreshFailedEvent() to listen for exceptions that happen during asynchronous refresh.

Specified by:

refreshThen in interface FilteredModel.Refresher<T>

Parameters:

afterRefresh - called after a successful refresh, may be null

See Also:

• FilteredModel.Refresher.observer()
• FilteredModel.Refresher.refreshEvent()
• FilteredModel.Refresher.refreshFailedEvent()
• FilteredModel.Refresher.async()

observer

public final is.codion.common.state.StateObserver observer()

Specified by:

observer in interface FilteredModel.Refresher<T>

Returns:

an observer active while a refresh is in progress

refreshEvent

public final is.codion.common.event.EventObserver<?> refreshEvent()

Specified by:

refreshEvent in interface FilteredModel.Refresher<T>

Returns:

an observer notified each time this model has been successfully refreshed

See Also:

• FilteredModel.Refresher.refresh()

refreshFailedEvent

public is.codion.common.event.EventObserver<Exception> refreshFailedEvent()

Specified by:

refreshFailedEvent in interface FilteredModel.Refresher<T>

Returns:

an observer notified each time an asynchronous refresh has failed

See Also:

• FilteredModel.Refresher.refresh()

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:

• refreshEvent()

notifyFailure

protected final void notifyFailure(Exception exception)

Triggers the refresh failed event

Parameters:

exception - the refresh exception

See Also:

• refreshFailedEvent()

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

protected abstract void refreshAsync(Consumer<Collection<T>> afterRefresh)

Performes an async refresh

Parameters:

afterRefresh - if specified will be called after a successful refresh

refreshSync

protected abstract void refreshSync(Consumer<Collection<T>> afterRefresh)

Performs a sync refresh

Parameters:

afterRefresh - if specified will be called after a successful refresh

processResult

protected abstract void processResult(Collection<T> items)

Processes the refresh result, by replacing the current model items by the result items.

Parameters:

items - the items resulting from the refresh operation