com.github.dm.jrt.android.builder

Class LoaderConfiguration.Builder<TYPE>

java.lang.Object

com.github.dm.jrt.android.builder.LoaderConfiguration.Builder<TYPE>

Type Parameters:

TYPE - the configurable object type.

Enclosing class:

LoaderConfiguration

public static final class LoaderConfiguration.Builder<TYPE>
extends Object

Builder of loader configurations.

Constructor Summary

Constructors

Constructor and Description
LoaderConfiguration.Builder(LoaderConfiguration.Configurable<? extends TYPE> configurable) Constructor.
LoaderConfiguration.Builder(LoaderConfiguration.Configurable<? extends TYPE> configurable, LoaderConfiguration initialConfiguration) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
TYPE	set() Sets the configuration and returns the configurable object.
LoaderConfiguration.Builder<TYPE>	with(LoaderConfiguration configuration) Applies the specified configuration to this builder.
LoaderConfiguration.Builder<TYPE>	withCacheStrategy(LoaderConfiguration.CacheStrategyType strategyType) Tells the builder how to cache the invocation result after its completion.
LoaderConfiguration.Builder<TYPE>	withClashResolution(LoaderConfiguration.ClashResolutionType resolutionType) Tells the builder how to resolve clashes of invocations with different inputs.
LoaderConfiguration.Builder<TYPE>	withId(int loaderId) Tells the builder to identify the loader with the specified ID.
LoaderConfiguration.Builder<TYPE>	withInputClashResolution(LoaderConfiguration.ClashResolutionType resolutionType) Tells the builder how to resolve clashes of invocations with same inputs.
LoaderConfiguration.Builder<TYPE>	withResultLooper(Looper looper) Sets the looper on which the results from the loader are dispatched.
LoaderConfiguration.Builder<TYPE>	withResultStaleTime(long time, TimeUnit timeUnit) Sets the time after which results are considered to be stale.
LoaderConfiguration.Builder<TYPE>	withResultStaleTime(TimeDuration staleTime) Sets the time after which results are considered to be stale.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoaderConfiguration.Builder

public LoaderConfiguration.Builder(@Nonnull
                           LoaderConfiguration.Configurable<? extends TYPE> configurable)

Constructor.

Parameters:

configurable - the configurable instance.

LoaderConfiguration.Builder

public LoaderConfiguration.Builder(@Nonnull
                           LoaderConfiguration.Configurable<? extends TYPE> configurable,
                           @Nonnull
                           LoaderConfiguration initialConfiguration)

Constructor.

Parameters:

initialConfiguration - the initial loader configuration.

Method Detail

set

@Nonnull
public TYPE set()

Sets the configuration and returns the configurable object.

Returns:

the configurable object.

with

@Nonnull
public LoaderConfiguration.Builder<TYPE> with(@Nullable
                                             LoaderConfiguration configuration)

Applies the specified configuration to this builder. A null value means that all the configuration options need to be set to their default value, otherwise only the set options will be applied.

Parameters:

configuration - the loader configuration.

Returns:

this builder.

withCacheStrategy

@Nonnull
public LoaderConfiguration.Builder<TYPE> withCacheStrategy(@Nullable
                                                          LoaderConfiguration.CacheStrategyType strategyType)

Tells the builder how to cache the invocation result after its completion. A null value means that it is up to the specific implementation to choose a default strategy.

Parameters:

strategyType - the cache strategy type.

Returns:

this builder.

withClashResolution

@Nonnull
public LoaderConfiguration.Builder<TYPE> withClashResolution(@Nullable
                                                            LoaderConfiguration.ClashResolutionType resolutionType)

Tells the builder how to resolve clashes of invocations with different inputs. A clash happens when a loader with the same ID is still running. A null value means that it is up to the specific implementation to choose a default resolution type.

Parameters:

resolutionType - the type of resolution.

Returns:

this builder.

withId

@Nonnull
public LoaderConfiguration.Builder<TYPE> withId(int loaderId)

Tells the builder to identify the loader with the specified ID.

Parameters:

loaderId - the loader ID.

Returns:

this builder.

withInputClashResolution

@Nonnull
public LoaderConfiguration.Builder<TYPE> withInputClashResolution(@Nullable
                                                                 LoaderConfiguration.ClashResolutionType resolutionType)

Tells the builder how to resolve clashes of invocations with same inputs. A clash happens when a loader with the same ID is still running. A null value means that it is up to the specific implementation to choose a default resolution type.

Parameters:

resolutionType - the type of resolution.

Returns:

this builder.

withResultLooper

@Nonnull
public LoaderConfiguration.Builder<TYPE> withResultLooper(@Nullable
                                                         Looper looper)

Sets the looper on which the results from the loader are dispatched. A null value means that results will be dispatched on the main thread (as by default).

Parameters:

looper - the looper instance.

Returns:

this builder.

withResultStaleTime

@Nonnull
public LoaderConfiguration.Builder<TYPE> withResultStaleTime(@Nullable
                                                            TimeDuration staleTime)

Sets the time after which results are considered to be stale. In case a clash is resolved by joining the two invocations, and the results of the running one are stale, the invocation execution is repeated. A null value means that the results are always valid.

Parameters:

staleTime - the stale time.

Returns:

this builder.

withResultStaleTime

@Nonnull
public LoaderConfiguration.Builder<TYPE> withResultStaleTime(long time,
                                                            @Nonnull
                                                            TimeUnit timeUnit)

Sets the time after which results are considered to be stale.

Parameters:

time - the time.

timeUnit - the time unit.

Returns:

this builder.

Throws:

IllegalArgumentException - if the specified timeout is negative.