com.birbit.android.jobqueue.config

Class Configuration

java.lang.Object

com.birbit.android.jobqueue.config.Configuration

public class Configuration
extends java.lang.Object

JobManager configuration object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Configuration.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_ID The default id for a Job.
static int	DEFAULT_LOAD_FACTOR_PER_CONSUMER The default number of jobs per thread before JobManager creates a new one
static int	DEFAULT_THREAD_KEEP_ALIVE_SECONDS The default timeout for an idle thread before it is destroyed
static int	DEFAULT_THREAD_PRIORITY The default priority for new job consumers (Thread.NORM_PRIORITY).
static int	MAX_CONSUMER_COUNT The default max number of consumers that will be created by the JobManager
static int	MIN_CONSUMER_COUNT The default min number of consumers that will be kept alive by the JobManager

Method Summary

Modifier and Type	Method and Description
boolean	batchSchedulerRequests()
android.content.Context	getAppContext()
int	getConsumerKeepAlive()
CustomLogger	getCustomLogger()
DependencyInjector	getDependencyInjector()
java.lang.String	getId()
int	getLoadFactor()
int	getMaxConsumerCount()
int	getMinConsumerCount()
NetworkUtil	getNetworkUtil()
QueueFactory	getQueueFactory()
Scheduler	getScheduler()
java.util.concurrent.ThreadFactory	getThreadFactory()
int	getThreadPriority()
Timer	getTimer()
boolean	isInTestMode()
boolean	resetDelaysOnRestart()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ID

public static final java.lang.String DEFAULT_ID

The default id for a Job. If you have multiple JobManagers, you should set this value via Configuration.Builder.id(String)

See Also:

Constant Field Values

DEFAULT_THREAD_KEEP_ALIVE_SECONDS

public static final int DEFAULT_THREAD_KEEP_ALIVE_SECONDS

The default timeout for an idle thread before it is destroyed

See Also:

Constant Field Values

DEFAULT_LOAD_FACTOR_PER_CONSUMER

public static final int DEFAULT_LOAD_FACTOR_PER_CONSUMER

The default number of jobs per thread before JobManager creates a new one

See Also:

Constant Field Values

MAX_CONSUMER_COUNT

public static final int MAX_CONSUMER_COUNT

The default max number of consumers that will be created by the JobManager

See Also:

Constant Field Values

MIN_CONSUMER_COUNT

public static final int MIN_CONSUMER_COUNT

The default min number of consumers that will be kept alive by the JobManager

See Also:

Constant Field Values

DEFAULT_THREAD_PRIORITY

public static final int DEFAULT_THREAD_PRIORITY

The default priority for new job consumers (Thread.NORM_PRIORITY).

See Also:

Constant Field Values

Method Detail

getAppContext

@NonNull
public android.content.Context getAppContext()

getId

@NonNull
public java.lang.String getId()

batchSchedulerRequests

public boolean batchSchedulerRequests()

getQueueFactory

@NonNull
public QueueFactory getQueueFactory()

getDependencyInjector

@Nullable
public DependencyInjector getDependencyInjector()

getConsumerKeepAlive

public int getConsumerKeepAlive()

getNetworkUtil

@NonNull
public NetworkUtil getNetworkUtil()

getMaxConsumerCount

public int getMaxConsumerCount()

getMinConsumerCount

public int getMinConsumerCount()

getCustomLogger

@Nullable
public CustomLogger getCustomLogger()

getLoadFactor

public int getLoadFactor()

isInTestMode

public boolean isInTestMode()

getTimer

@NonNull
public Timer getTimer()

resetDelaysOnRestart

public boolean resetDelaysOnRestart()

getScheduler

@Nullable
public Scheduler getScheduler()

getThreadPriority

public int getThreadPriority()

getThreadFactory

@Nullable
public java.util.concurrent.ThreadFactory getThreadFactory()