com.github.dm.jrt.android.builder

Class LoaderConfiguration

java.lang.Object

com.github.dm.jrt.android.builder.LoaderConfiguration

public final class LoaderConfiguration
extends Object

Class storing the invocation loader configuration.

Each instance is immutable, thus, in order to modify a configuration parameter, a new builder must be created starting from the specific configuration instance.

The configuration is used to set a specific ID to each invocation created by a routine.
Moreover, it is possible to set a specific type of resolution when two invocations clashes, that is, they share the same ID, and to set a specific type of caching of the invocation results.
In case is a clash resolved by joining the two invocations, it is possible to specify a maximum time after which the results of the first invocation are considered to be stale, and thus the invocation is repeated.
Finally, a specific looper, other than the main thread one, can be chosen to dispatch the results coming from the invocation.

Created by davide-maestroni on 04/19/2015.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoaderConfiguration.Builder<TYPE> Builder of loader configurations.
static class	LoaderConfiguration.CacheStrategyType Result cache type enumeration. The cache strategy type indicates what will happen to the result of an invocation after its completion.
static class	LoaderConfiguration.ClashResolutionType Invocation clash resolution enumeration. The clash of two invocations happens when the same loader ID is already in use at the time of the routine execution.
static interface	LoaderConfiguration.Configurable<TYPE> Interface defining a configurable object.

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTO Constant identifying an loader ID computed from the executor class and the input parameters.
static LoaderConfiguration	DEFAULT_CONFIGURATION Empty configuration constant. The configuration has all the values set to their default.

Method Summary

Methods

Modifier and Type	Method and Description
static LoaderConfiguration.Builder<LoaderConfiguration>	builder() Returns a loader configuration builder.
LoaderConfiguration.Builder<LoaderConfiguration>	builderFrom() Returns a loader configuration builder initialized with this configuration.
static LoaderConfiguration.Builder<LoaderConfiguration>	builderFrom(LoaderConfiguration initialConfiguration) Returns a loader configuration builder initialized with the specified configuration.
boolean	equals(Object o)
LoaderConfiguration.CacheStrategyType	getCacheStrategyTypeOr(LoaderConfiguration.CacheStrategyType valueIfNotSet) Returns the type of cache strategy (null by default).
LoaderConfiguration.ClashResolutionType	getClashResolutionTypeOr(LoaderConfiguration.ClashResolutionType valueIfNotSet) Returns the type of clash resolution (null by default).
LoaderConfiguration.ClashResolutionType	getInputClashResolutionTypeOr(LoaderConfiguration.ClashResolutionType valueIfNotSet) Returns the type of input clash resolution (null by default).
int	getLoaderIdOr(int valueIfNotSet) Returns the loader ID (AUTO by default).
Looper	getResultLooperOr(Looper valueIfNotSet) Returns the looper used for dispatching the results from the loader (null by default).
TimeDuration	getResultStaleTimeOr(TimeDuration valueIfNotSet) Returns the time after which results are considered to be stale (null by default).
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

AUTO

public static final int AUTO

Constant identifying an loader ID computed from the executor class and the input parameters.

See Also:

Constant Field Values

DEFAULT_CONFIGURATION

public static final LoaderConfiguration DEFAULT_CONFIGURATION

Empty configuration constant.
The configuration has all the values set to their default.

Method Detail

builder

@Nonnull
public static LoaderConfiguration.Builder<LoaderConfiguration> builder()

Returns a loader configuration builder.

Returns:

the builder.

builderFrom

@Nonnull
public static LoaderConfiguration.Builder<LoaderConfiguration> builderFrom(@Nullable
                                                                   LoaderConfiguration initialConfiguration)

Returns a loader configuration builder initialized with the specified configuration.

Parameters:

initialConfiguration - the initial loader configuration.

Returns:

the builder.

builderFrom

@Nonnull
public LoaderConfiguration.Builder<LoaderConfiguration> builderFrom()

Returns a loader configuration builder initialized with this configuration.

Returns:

the builder.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getCacheStrategyTypeOr

public LoaderConfiguration.CacheStrategyType getCacheStrategyTypeOr(@Nullable
                                                           LoaderConfiguration.CacheStrategyType valueIfNotSet)

Returns the type of cache strategy (null by default).

Parameters:

valueIfNotSet - the default value if none was set.

Returns:

the cache strategy type.

getClashResolutionTypeOr

public LoaderConfiguration.ClashResolutionType getClashResolutionTypeOr(@Nullable
                                                               LoaderConfiguration.ClashResolutionType valueIfNotSet)

Returns the type of clash resolution (null by default).

Parameters:

valueIfNotSet - the default value if none was set.

Returns:

the clash resolution type.

getInputClashResolutionTypeOr

public LoaderConfiguration.ClashResolutionType getInputClashResolutionTypeOr(@Nullable
                                                                    LoaderConfiguration.ClashResolutionType valueIfNotSet)

Returns the type of input clash resolution (null by default).

Parameters:

valueIfNotSet - the default value if none was set.

Returns:

the clash resolution type.

getLoaderIdOr

public int getLoaderIdOr(int valueIfNotSet)

Returns the loader ID (AUTO by default).

Parameters:

valueIfNotSet - the default value if none was set.

Returns:

the loader ID.

getResultLooperOr

public Looper getResultLooperOr(@Nullable
                       Looper valueIfNotSet)

Returns the looper used for dispatching the results from the loader (null by default).

Parameters:

valueIfNotSet - the default value if none was set.

Returns:

the looper instance.

getResultStaleTimeOr

public TimeDuration getResultStaleTimeOr(@Nullable
                                TimeDuration valueIfNotSet)

Returns the time after which results are considered to be stale (null by default).

Parameters:

valueIfNotSet - the default value if none was set.

Returns:

the results stale time.