com.github.dm.jrt.android.builder

Class ServiceConfiguration.Builder<TYPE>

java.lang.Object

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

Type Parameters:

TYPE - the configurable object type.

Enclosing class:

ServiceConfiguration

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

Builder of service configurations.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
TYPE	set() Sets the configuration and returns the configurable object.
ServiceConfiguration.Builder<TYPE>	with(ServiceConfiguration configuration) Applies the specified configuration to this builder.
ServiceConfiguration.Builder<TYPE>	withLogClass(Class<? extends Log> logClass) Sets the log class.
ServiceConfiguration.Builder<TYPE>	withResultLooper(Looper looper) Sets the looper on which the results from the service are dispatched.
ServiceConfiguration.Builder<TYPE>	withRunnerClass(Class<? extends Runner> runnerClass) Sets the runner class.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceConfiguration.Builder

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

Constructor.

Parameters:

configurable - the configurable instance.

ServiceConfiguration.Builder

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

Constructor.

Parameters:

configurable - the configurable instance.

initialConfiguration - the initial configuration.

Method Detail

set

@Nonnull
public TYPE set()

Sets the configuration and returns the configurable object.

Returns:

the configurable object.

with

@Nonnull
public ServiceConfiguration.Builder<TYPE> with(@Nullable
                                              ServiceConfiguration 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 service configuration.

Returns:

this builder.

withLogClass

@Nonnull
public ServiceConfiguration.Builder<TYPE> withLogClass(@Nullable
                                                      Class<? extends Log> logClass)

Sets the log class. A null value means that it is up to the specific implementation to choose a default class.

Parameters:

logClass - the log class.

Returns:

this builder.

Throws:

IllegalArgumentException - if the specified class has no default constructor.

withResultLooper

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

Sets the looper on which the results from the service 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.

withRunnerClass

@Nonnull
public ServiceConfiguration.Builder<TYPE> withRunnerClass(@Nullable
                                                         Class<? extends Runner> runnerClass)

Sets the runner class. A null value means that it is up to the specific implementation to choose a default runner.

Parameters:

runnerClass - the runner class.

Returns:

this builder.

Throws:

IllegalArgumentException - if the specified class has no default constructor.