com.github.dm.jrt.android.builder

Class ServiceConfiguration

java.lang.Object

com.github.dm.jrt.android.builder.ServiceConfiguration

public final class ServiceConfiguration
extends Object

Class storing the service 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.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceConfiguration.Builder<TYPE> Builder of service configurations.
static interface	ServiceConfiguration.Configurable<TYPE> Interface defining a configurable object.

Field Summary

Fields

Modifier and Type	Field and Description
static ServiceConfiguration	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 ServiceConfiguration.Builder<ServiceConfiguration>	builder() Returns a service configuration builder.
ServiceConfiguration.Builder<ServiceConfiguration>	builderFrom() Returns a service configuration builder initialized with this configuration.
static ServiceConfiguration.Builder<ServiceConfiguration>	builderFrom(ServiceConfiguration initialConfiguration) Returns a service configuration builder initialized with the specified configuration.
boolean	equals(Object o)
Class<? extends Log>	getLogClassOr(Class<? extends Log> valueIfNotSet) Returns the log class (null by default).
Looper	getResultLooperOr(Looper valueIfNotSet) Returns the looper used for dispatching the results from the service (null by default).
Class<? extends Runner>	getRunnerClassOr(Class<? extends Runner> valueIfNotSet) Returns the runner class (null by default).
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_CONFIGURATION

public static final ServiceConfiguration DEFAULT_CONFIGURATION

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

Method Detail

builder

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

Returns a service configuration builder.

Returns:

the builder.

builderFrom

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

Returns a service configuration builder initialized with the specified configuration.

Parameters:

initialConfiguration - the initial configuration.

Returns:

the builder.

builderFrom

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

Returns a service 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

getLogClassOr

public Class<? extends Log> getLogClassOr(@Nullable
                                 Class<? extends Log> valueIfNotSet)

Returns the log class (null by default).

Parameters:

valueIfNotSet - the default value if none was set.

Returns:

the log class instance.

getResultLooperOr

public Looper getResultLooperOr(@Nullable
                       Looper valueIfNotSet)

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

Parameters:

valueIfNotSet - the default value if none was set.

Returns:

the looper instance.

getRunnerClassOr

public Class<? extends Runner> getRunnerClassOr(@Nullable
                                       Class<? extends Runner> valueIfNotSet)

Returns the runner class (null by default).

Parameters:

valueIfNotSet - the default value if none was set.

Returns:

the runner class instance.