com.screenscraper.concurrent

Class TimedExecutorService.Builder

java.lang.Object

com.screenscraper.concurrent.TimedExecutorService.Builder

Enclosing class:

TimedExecutorService

public static class TimedExecutorService.Builder
extends java.lang.Object

Builder class for setting up the timed executor service

Constructor Summary

Constructors

Constructor and Description
Builder() Creates the builder and sets default values

Method Summary

Modifier and Type	Method and Description
TimedExecutorService	build()
TimedExecutorService.Builder	corePoolSize(int corePoolSize) Sets the core pool size.
TimedExecutorService.Builder	defaultRunDuration(long defaultRunDuration) Sets the default run duration in milliseconds for a newly submitted task
TimedExecutorService.Builder	keepAliveTime(long keepAliveTime) Sets the number of milliseconds to keep idle threads alive
TimedExecutorService.Builder	keepAliveTime(long keepAliveTime, java.util.concurrent.TimeUnit unit) Sets the time to keep idle threads alive
TimedExecutorService.Builder	maximumPoolSize(int maximumPoolSize) Sets the maximum pool size.
TimedExecutorService.Builder	numCancellerThreads(int numCancellerThreads) Sets the number of canceller threads to use for monitoring tasks.
TimedExecutorService.Builder	rejectedExecutionHandler(java.util.concurrent.RejectedExecutionHandler rejectedExecutionHandler) Sets the way to handle rejected tasks
TimedExecutorService.Builder	removeOnCancel(boolean removeOnCancel) Sets whether or not cancelling a future should immediately remove it from the task cancellation queue.
TimedExecutorService.Builder	threadFactory(java.util.concurrent.ThreadFactory threadFactory) Sets the Thread Factory to use for thread generation
java.lang.String	toString()
TimedExecutorService.Builder	workQueue(java.util.concurrent.BlockingQueue<java.lang.Runnable> workQueue) Sets the work queue.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Creates the builder and sets default values

Method Detail

corePoolSize

@NotNull
public TimedExecutorService.Builder corePoolSize(int corePoolSize)

Sets the core pool size.

Parameters:

corePoolSize - The core pool size, or how many threads to have minimum at any given time

Returns:

The builder for method chaining

maximumPoolSize

@NotNull
public TimedExecutorService.Builder maximumPoolSize(int maximumPoolSize)

Sets the maximum pool size.

Parameters:

maximumPoolSize - The max pool size, or how many threads to have maximum at any given time

Returns:

The builder for method chaining

keepAliveTime

@NotNull
public TimedExecutorService.Builder keepAliveTime(long keepAliveTime,
                                                            @NotNull
                                                            java.util.concurrent.TimeUnit unit)

Sets the time to keep idle threads alive

Parameters:

keepAliveTime - The time to keep idle threads alive

unit - The measurement unit for the time

Returns:

The builder for method chaining

keepAliveTime

@NotNull
public TimedExecutorService.Builder keepAliveTime(long keepAliveTime)

Sets the number of milliseconds to keep idle threads alive

Parameters:

keepAliveTime - The number of milliseconds to keep idle threads alive

Returns:

The builder for method chaining

workQueue

@NotNull
public TimedExecutorService.Builder workQueue(@Nullable
                                                        java.util.concurrent.BlockingQueue<java.lang.Runnable> workQueue)

Sets the work queue.

Parameters:

workQueue - The work queue to use, or null to use a default. Each call to build will also null the work queue for the next build call

Returns:

The builder for method chaining

threadFactory

@NotNull
public TimedExecutorService.Builder threadFactory(@Nullable
                                                            java.util.concurrent.ThreadFactory threadFactory)

Sets the Thread Factory to use for thread generation

Parameters:

threadFactory - The factory to use for thread generation, or null for the default

Returns:

The builder for method chaining

rejectedExecutionHandler

@NotNull
public TimedExecutorService.Builder rejectedExecutionHandler(@Nullable
                                                                       java.util.concurrent.RejectedExecutionHandler rejectedExecutionHandler)

Sets the way to handle rejected tasks

Parameters:

rejectedExecutionHandler - The handler for rejected tasks

Returns:

The builder for method chaining

defaultRunDuration

@NotNull
public TimedExecutorService.Builder defaultRunDuration(long defaultRunDuration)

Sets the default run duration in milliseconds for a newly submitted task

Parameters:

defaultRunDuration - The default run duration in milliseconds

Returns:

The builder for method chaining

removeOnCancel

@NotNull
public TimedExecutorService.Builder removeOnCancel(boolean removeOnCancel)

Sets whether or not cancelling a future should immediately remove it from the task cancellation queue.

Parameters:

removeOnCancel - Whether or not cancelling a future should immediately remove it from the task cancellation queue.

Returns:

The builder for method chaining

numCancellerThreads

@NotNull
public TimedExecutorService.Builder numCancellerThreads(int numCancellerThreads)

Sets the number of canceller threads to use for monitoring tasks. In almost every case, the default is sufficient here

Parameters:

numCancellerThreads - The number of canceller threads to use for monitoring tasks.

Returns:

The builder for method chaining

build

@NotNull
public TimedExecutorService build()

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object